interface CfnGuardrailProps

Language	Type name
.NET	Amazon.CDK.aws_bedrock.CfnGuardrailProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnGuardrailProps
Java	software.amazon.awscdk.services.bedrock.CfnGuardrailProps
Python	aws_cdk.aws_bedrock.CfnGuardrailProps
TypeScript	aws-cdk-lib » aws_bedrock » CfnGuardrailProps

Properties for defining a CfnGuardrail.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
const cfnGuardrailProps: bedrock.CfnGuardrailProps = {
  blockedInputMessaging: 'blockedInputMessaging',
  blockedOutputsMessaging: 'blockedOutputsMessaging',
  name: 'name',

  // the properties below are optional
  contentPolicyConfig: {
    filtersConfig: [{
      inputStrength: 'inputStrength',
      outputStrength: 'outputStrength',
      type: 'type',
    }],
  },
  contextualGroundingPolicyConfig: {
    filtersConfig: [{
      threshold: 123,
      type: 'type',
    }],
  },
  description: 'description',
  kmsKeyArn: 'kmsKeyArn',
  sensitiveInformationPolicyConfig: {
    piiEntitiesConfig: [{
      action: 'action',
      type: 'type',
    }],
    regexesConfig: [{
      action: 'action',
      name: 'name',
      pattern: 'pattern',

      // the properties below are optional
      description: 'description',
    }],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  topicPolicyConfig: {
    topicsConfig: [{
      definition: 'definition',
      name: 'name',
      type: 'type',

      // the properties below are optional
      examples: ['examples'],
    }],
  },
  wordPolicyConfig: {
    managedWordListsConfig: [{
      type: 'type',
    }],
    wordsConfig: [{
      text: 'text',
    }],
  },
};

Properties

Name	Type	Description
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.
name	string	The name of the guardrail.
contentPolicyConfig?	IResolvable | ContentPolicyConfigProperty	The content filter policies to configure for the guardrail.
contextualGroundingPolicyConfig?	IResolvable | ContextualGroundingPolicyConfigProperty	Contextual grounding policy config for a guardrail.
description?	string	A description of the guardrail.
kmsKeyArn?	string	The ARN of the AWS KMS key that you use to encrypt the guardrail.
sensitiveInformationPolicyConfig?	IResolvable | SensitiveInformationPolicyConfigProperty	The sensitive information policy to configure for the guardrail.
tags?	CfnTag[]	The tags that you want to attach to the guardrail.
topicPolicyConfig?	IResolvable | TopicPolicyConfigProperty	The topic policies to configure for the guardrail.
wordPolicyConfig?	IResolvable | WordPolicyConfigProperty	The word policy you configure for the guardrail.

---

blockedInputMessaging

Type: string

The message to return when the guardrail blocks a prompt.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-blockedinputmessaging

---

blockedOutputsMessaging

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-blockedoutputsmessaging

---

name

Type: string

The name of the guardrail.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-name

---

contentPolicyConfig?

Type: IResolvable | ContentPolicyConfigProperty (optional)

The content filter policies to configure for the guardrail.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-contentpolicyconfig

---

contextualGroundingPolicyConfig?

Type: IResolvable | ContextualGroundingPolicyConfigProperty (optional)

Contextual grounding policy config for a guardrail.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-contextualgroundingpolicyconfig

---

description?

Type: string (optional)

A description of the guardrail.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-description

---

kmsKeyArn?

Type: string (optional)

The ARN of the AWS KMS key that you use to encrypt the guardrail.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-kmskeyarn

---

sensitiveInformationPolicyConfig?

Type: IResolvable | SensitiveInformationPolicyConfigProperty (optional)

The sensitive information policy to configure for the guardrail.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig

---

tags?

Type: CfnTag[] (optional)

The tags that you want to attach to the guardrail.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-tags

---

topicPolicyConfig?

Type: IResolvable | TopicPolicyConfigProperty (optional)

The topic policies to configure for the guardrail.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-topicpolicyconfig

---

wordPolicyConfig?

Type: IResolvable | WordPolicyConfigProperty (optional)

The word policy you configure for the guardrail.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-wordpolicyconfig