interface CfnGuardrailMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins.CfnGuardrailMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbedrock/mixins#CfnGuardrailMixinProps
Java	software.amazon.awscdk.mixins.preview.services.bedrock.mixins.CfnGuardrailMixinProps
Python	aws_cdk.mixins_preview.aws_bedrock.mixins.CfnGuardrailMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_bedrock » mixins » CfnGuardrailMixinProps

Properties for CfnGuardrailPropsMixin.

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 { mixins as bedrock_mixins } from '@aws-cdk/mixins-preview/aws-bedrock';
const cfnGuardrailMixinProps: bedrock_mixins.CfnGuardrailMixinProps = {
  automatedReasoningPolicyConfig: {
    confidenceThreshold: 123,
    policies: ['policies'],
  },
  blockedInputMessaging: 'blockedInputMessaging',
  blockedOutputsMessaging: 'blockedOutputsMessaging',
  contentPolicyConfig: {
    contentFiltersTierConfig: {
      tierName: 'tierName',
    },
    filtersConfig: [{
      inputAction: 'inputAction',
      inputEnabled: false,
      inputModalities: ['inputModalities'],
      inputStrength: 'inputStrength',
      outputAction: 'outputAction',
      outputEnabled: false,
      outputModalities: ['outputModalities'],
      outputStrength: 'outputStrength',
      type: 'type',
    }],
  },
  contextualGroundingPolicyConfig: {
    filtersConfig: [{
      action: 'action',
      enabled: false,
      threshold: 123,
      type: 'type',
    }],
  },
  crossRegionConfig: {
    guardrailProfileArn: 'guardrailProfileArn',
  },
  description: 'description',
  kmsKeyArn: 'kmsKeyArn',
  name: 'name',
  sensitiveInformationPolicyConfig: {
    piiEntitiesConfig: [{
      action: 'action',
      inputAction: 'inputAction',
      inputEnabled: false,
      outputAction: 'outputAction',
      outputEnabled: false,
      type: 'type',
    }],
    regexesConfig: [{
      action: 'action',
      description: 'description',
      inputAction: 'inputAction',
      inputEnabled: false,
      name: 'name',
      outputAction: 'outputAction',
      outputEnabled: false,
      pattern: 'pattern',
    }],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  topicPolicyConfig: {
    topicsConfig: [{
      definition: 'definition',
      examples: ['examples'],
      inputAction: 'inputAction',
      inputEnabled: false,
      name: 'name',
      outputAction: 'outputAction',
      outputEnabled: false,
      type: 'type',
    }],
    topicsTierConfig: {
      tierName: 'tierName',
    },
  },
  wordPolicyConfig: {
    managedWordListsConfig: [{
      inputAction: 'inputAction',
      inputEnabled: false,
      outputAction: 'outputAction',
      outputEnabled: false,
      type: 'type',
    }],
    wordsConfig: [{
      inputAction: 'inputAction',
      inputEnabled: false,
      outputAction: 'outputAction',
      outputEnabled: false,
      text: 'text',
    }],
  },
};

Properties

Name	Type	Description
automatedReasoningPolicyConfig?	IResolvable | AutomatedReasoningPolicyConfigProperty	Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.
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.
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 key that you use to encrypt the guardrail.
name?	string	The name of 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.

---

automatedReasoningPolicyConfig?

Type: IResolvable | AutomatedReasoningPolicyConfigProperty (optional)

Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.

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

---

blockedInputMessaging?

Type: string (optional)

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 (optional)

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

---

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

---

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 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

---

name?

Type: string (optional)

The name of the guardrail.

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

---

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