interface GuardrailProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Bedrock.Alpha.GuardrailProps
Go	github.com/aws/aws-cdk-go/awsbedrockalpha/v2#GuardrailProps
Java	software.amazon.awscdk.services.bedrock.alpha.GuardrailProps
Python	aws_cdk.aws_bedrock_alpha.GuardrailProps
TypeScript (source)	@aws-cdk/aws-bedrock-alpha » GuardrailProps

Properties for creating a Guardrail.

Example

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,
});

Properties

Name	Type	Description
guardrailName🔹	string	The name of the guardrail.
blockedInputMessaging?🔹	string	The message to return when the guardrail blocks a prompt.
blockedOutputsMessaging?🔹	string	The message to return when the guardrail blocks a model response.
contentFilters?🔹	ContentFilter[]	The content filters to apply to the guardrail.
contentFiltersTierConfig?🔹	TierConfig	The tier configuration to apply to the guardrail.
contextualGroundingFilters?🔹	ContextualGroundingFilter[]	The contextual grounding filters to apply to the guardrail.
crossRegionConfig?🔹	GuardrailCrossRegionConfigProperty	The cross-region configuration for the guardrail.
deniedTopics?🔹	Topic[]	A list of policies related to topics that the guardrail should deny.
description?🔹	string	The description of the guardrail.
kmsKey?🔹	IKey	A custom KMS key to use for encrypting data.
managedWordListFilters?🔹	ManagedWordFilter[]	The managed word filters to apply to the guardrail.
piiFilters?🔹	PIIFilter[]	The PII filters to apply to the guardrail.
regexFilters?🔹	RegexFilter[]	The regular expression (regex) filters to apply to the guardrail.
topicsTierConfig?🔹	TierConfig	The tier configuration to apply to the guardrail.
wordFilters?🔹	WordFilter[]	The word filters to apply to the guardrail.

---

guardrailName🔹

Type: string

The name of the guardrail.

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

---

blockedInputMessaging?🔹

Type: string (optional, default: "Sorry, your query violates our usage policy.")

The message to return when the guardrail blocks a prompt.

Must be between 1 and 500 characters.

---

blockedOutputsMessaging?🔹

Type: string (optional, default: "Sorry, I am unable to answer your question because of our usage policy.")

The message to return when the guardrail blocks a model response.

Must be between 1 and 500 characters.

---

contentFilters?🔹

Type: ContentFilter[] (optional, default: [])

The content filters to apply to the guardrail.

---

contentFiltersTierConfig?🔹

Type: TierConfig (optional, default: filters.TierConfig.CLASSIC)

The tier configuration to apply to the guardrail.

---

contextualGroundingFilters?🔹

Type: ContextualGroundingFilter[] (optional, default: [])

The contextual grounding filters to apply to the guardrail.

---

crossRegionConfig?🔹

Type: GuardrailCrossRegionConfigProperty (optional, default: No cross-region configuration)

The cross-region configuration for the guardrail.

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

---

deniedTopics?🔹

Type: Topic[] (optional, default: [])

A list of policies related to topics that the guardrail should deny.

---

description?🔹

Type: string (optional, default: No description)

The description of the guardrail.

---

kmsKey?🔹

Type: IKey (optional, default: Data is encrypted by default with a key that AWS owns and manages for you)

A custom KMS key to use for encrypting data.

---

managedWordListFilters?🔹

Type: ManagedWordFilter[] (optional, default: [])

The managed word filters to apply to the guardrail.

---

piiFilters?🔹

Type: PIIFilter[] (optional, default: [])

The PII filters to apply to the guardrail.

---

regexFilters?🔹

Type: RegexFilter[] (optional, default: [])

The regular expression (regex) filters to apply to the guardrail.

---

topicsTierConfig?🔹

Type: TierConfig (optional, default: filters.TierConfig.CLASSIC)

The tier configuration to apply to the guardrail.

---

wordFilters?🔹

Type: WordFilter[] (optional, default: [])

The word filters to apply to the guardrail.