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

import * as bedrockl1 from 'aws-cdk-lib/aws-bedrock';
// Import a guardrail created through the L1 CDK CfnGuardrail construct
const l1guardrail = new bedrockl1.CfnGuardrail(this, 'MyCfnGuardrail', {
  blockedInputMessaging: 'blockedInputMessaging',
  blockedOutputsMessaging: 'blockedOutputsMessaging',
  name: 'namemycfnguardrails',
  wordPolicyConfig: {
    wordsConfig: [
      {
        text: 'drugs',
      },
    ],
  },
});

const importedGuardrail = bedrock.Guardrail.fromCfnGuardrail(l1guardrail);

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.
crossRegionConfig?	`IResolvable` `\|` `GuardrailCrossRegionConfigProperty`	The system-defined guardrail profile that you're using with your 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

crossRegionConfig?

Type: IResolvable | GuardrailCrossRegionConfigProperty (optional)

The system-defined guardrail profile that you're using with your guardrail.

Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases.

For more information, see the Amazon Bedrock User Guide .

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