Skip to content
v2.278.0

Experimental

@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

GuardrailProps Struct ​

Properties for creating a Guardrail.

Example ​

ts
const guardrail = new bedrock.Guardrail(this, 'bedrockGuardrails', {
  guardrailName: 'my-BedrockGuardrails',
});
// Add regex filter with input/output actions
guardrail.addRegexFilter({
  name: 'TestRegexFilter',
  pattern: 'test-pattern',
  action: bedrock.GuardrailAction.ANONYMIZE,
  // below props are optional
  description: 'This is a test regex filter',
  inputAction: bedrock.GuardrailAction.BLOCK,
  inputEnabled: true,
  outputAction: bedrock.GuardrailAction.ANONYMIZE,
  outputEnabled: true,
});
python
guardrail = bedrock.Guardrail(self, "bedrockGuardrails",
    guardrail_name="my-BedrockGuardrails"
)
# Add regex filter with input/output actions
guardrail.add_regex_filter(
    name="TestRegexFilter",
    pattern="test-pattern",
    action=bedrock.GuardrailAction.ANONYMIZE,
    # below props are optional
    description="This is a test regex filter",
    input_action=bedrock.GuardrailAction.BLOCK,
    input_enabled=True,
    output_action=bedrock.GuardrailAction.ANONYMIZE,
    output_enabled=True
)
java
Guardrail guardrail = Guardrail.Builder.create(this, "bedrockGuardrails")
        .guardrailName("my-BedrockGuardrails")
        .build();
// Add regex filter with input/output actions
guardrail.addRegexFilter(RegexFilter.builder()
        .name("TestRegexFilter")
        .pattern("test-pattern")
        .action(GuardrailAction.ANONYMIZE)
        // below props are optional
        .description("This is a test regex filter")
        .inputAction(GuardrailAction.BLOCK)
        .inputEnabled(true)
        .outputAction(GuardrailAction.ANONYMIZE)
        .outputEnabled(true)
        .build());
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Alpha
var guardrail = new Guardrail(this, "bedrockGuardrails", new GuardrailProps {
    GuardrailName = "my-BedrockGuardrails"
});
// Add regex filter with input/output actions
guardrail.AddRegexFilter(new RegexFilter {
    Name = "TestRegexFilter",
    Pattern = "test-pattern",
    Action = GuardrailAction.ANONYMIZE,
    // below props are optional
    Description = "This is a test regex filter",
    InputAction = GuardrailAction.BLOCK,
    InputEnabled = true,
    OutputAction = GuardrailAction.ANONYMIZE,
    OutputEnabled = true
});
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockalpha/v2
guardrail := bedrock.NewGuardrail(this, jsii.String("bedrockGuardrails"), &GuardrailProps{
	GuardrailName: jsii.String("my-BedrockGuardrails"),
})
// Add regex filter with input/output actions
guardrail.AddRegexFilter(&RegexFilter{
	Name: jsii.String("TestRegexFilter"),
	Pattern: jsii.String("test-pattern"),
	Action: bedrock.GuardrailAction_ANONYMIZE,
	// below props are optional
	Description: jsii.String("This is a test regex filter"),
	InputAction: bedrock.GuardrailAction_BLOCK,
	InputEnabled: jsii.Boolean(true),
	OutputAction: bedrock.GuardrailAction_ANONYMIZE,
	OutputEnabled: jsii.Boolean(true),
})

Properties ​

blockedInputMessagingoptionalstringblocked_input_messagingoptionalstrblockedInputMessagingoptionalStringBlockedInputMessagingoptionalstringBlockedInputMessagingoptional*string #
The message to return when the guardrail blocks a prompt.

Default: "Sorry, your query violates our usage policy."

Must be between 1 and 500 characters.

blockedOutputsMessagingoptionalstringblocked_outputs_messagingoptionalstrblockedOutputsMessagingoptionalStringBlockedOutputsMessagingoptionalstringBlockedOutputsMessagingoptional*string #
The message to return when the guardrail blocks a model response.

Default: "Sorry, I am unable to answer your question because of our usage policy."

Must be between 1 and 500 characters.

contentFiltersoptionalContentFilter[]content_filtersoptionaltyping.List[ContentFilter]contentFiltersoptionalList<ContentFilter>ContentFiltersoptionalContentFilter[]ContentFiltersoptional*[]ContentFilter = [] #
The content filters to apply to the guardrail.
contentFiltersTierConfigoptionalTierConfigcontent_filters_tier_configoptionalTierConfigcontentFiltersTierConfigoptionalTierConfigContentFiltersTierConfigoptionalTierConfigContentFiltersTierConfigoptionalTierConfig = filters.TierConfig.CLASSIC #
The tier configuration to apply to the guardrail.
contextualGroundingFiltersoptionalContextualGroundingFilter[]contextual_grounding_filtersoptionaltyping.List[ContextualGroundingFilter]contextualGroundingFiltersoptionalList<ContextualGroundingFilter>ContextualGroundingFiltersoptionalContextualGroundingFilter[]ContextualGroundingFiltersoptional*[]ContextualGroundingFilter = [] #
The contextual grounding filters to apply to the guardrail.
crossRegionConfigoptionalGuardrailCrossRegionConfigPropertycross_region_configoptionalGuardrailCrossRegionConfigPropertycrossRegionConfigoptionalGuardrailCrossRegionConfigPropertyCrossRegionConfigoptionalGuardrailCrossRegionConfigPropertyCrossRegionConfigoptionalGuardrailCrossRegionConfigProperty #
The cross-region configuration for the guardrail.

Default: No cross-region configuration

This is optional and when provided, it should be of type GuardrailCrossRegionConfigProperty.

deniedTopicsoptionalTopic[]denied_topicsoptionaltyping.List[Topic]deniedTopicsoptionalList<Topic>DeniedTopicsoptionalTopic[]DeniedTopicsoptional*[]Topic = [] #
A list of policies related to topics that the guardrail should deny.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #
The description of the guardrail.

Default: No description

guardrailNamestringguardrail_namestrguardrailNameStringGuardrailNamestringGuardrailName*string required #
The name of the guardrail.

This will be used as the physical name of the guardrail.

kmsKeyoptionalIKeykms_keyoptionalIKeykmsKeyoptionalIKeyKmsKeyoptionalIKeyKmsKeyoptionalIKey #
A custom KMS key to use for encrypting data.

Default: Data is encrypted by default with a key that AWS owns and manages for you

managedWordListFiltersoptionalManagedWordFilter[]managed_word_list_filtersoptionaltyping.List[ManagedWordFilter]managedWordListFiltersoptionalList<ManagedWordFilter>ManagedWordListFiltersoptionalManagedWordFilter[]ManagedWordListFiltersoptional*[]ManagedWordFilter = [] #
The managed word filters to apply to the guardrail.
piiFiltersoptionalPIIFilter[]pii_filtersoptionaltyping.List[PIIFilter]piiFiltersoptionalList<PIIFilter>PiiFiltersoptionalPIIFilter[]PiiFiltersoptional*[]PIIFilter = [] #
The PII filters to apply to the guardrail.
regexFiltersoptionalRegexFilter[]regex_filtersoptionaltyping.List[RegexFilter]regexFiltersoptionalList<RegexFilter>RegexFiltersoptionalRegexFilter[]RegexFiltersoptional*[]RegexFilter = [] #
The regular expression (regex) filters to apply to the guardrail.
topicsTierConfigoptionalTierConfigtopics_tier_configoptionalTierConfigtopicsTierConfigoptionalTierConfigTopicsTierConfigoptionalTierConfigTopicsTierConfigoptionalTierConfig = filters.TierConfig.CLASSIC #
The tier configuration to apply to the guardrail.
wordFiltersoptionalWordFilter[]word_filtersoptionaltyping.List[WordFilter]wordFiltersoptionalList<WordFilter>WordFiltersoptionalWordFilter[]WordFiltersoptional*[]WordFilter = [] #
The word filters to apply to the guardrail.