Class CfnGuardrailMixinProps

Properties for CfnGuardrailPropsMixin.

Inheritance

object

CfnGuardrailMixinProps

Implements

ICfnGuardrailMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Bedrock

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnGuardrailMixinProps : ICfnGuardrailMixinProps

Syntax (vb)

Public Class CfnGuardrailMixinProps Implements ICfnGuardrailMixinProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Bedrock;

             var cfnGuardrailMixinProps = new CfnGuardrailMixinProps {
                 AutomatedReasoningPolicyConfig = new AutomatedReasoningPolicyConfigProperty {
                     ConfidenceThreshold = 123,
                     Policies = new [] { "policies" }
                 },
                 BlockedInputMessaging = "blockedInputMessaging",
                 BlockedOutputsMessaging = "blockedOutputsMessaging",
                 ContentPolicyConfig = new ContentPolicyConfigProperty {
                     ContentFiltersTierConfig = new ContentFiltersTierConfigProperty {
                         TierName = "tierName"
                     },
                     FiltersConfig = new [] { new ContentFilterConfigProperty {
                         InputAction = "inputAction",
                         InputEnabled = false,
                         InputModalities = new [] { "inputModalities" },
                         InputStrength = "inputStrength",
                         OutputAction = "outputAction",
                         OutputEnabled = false,
                         OutputModalities = new [] { "outputModalities" },
                         OutputStrength = "outputStrength",
                         Type = "type"
                     } }
                 },
                 ContextualGroundingPolicyConfig = new ContextualGroundingPolicyConfigProperty {
                     FiltersConfig = new [] { new ContextualGroundingFilterConfigProperty {
                         Action = "action",
                         Enabled = false,
                         Threshold = 123,
                         Type = "type"
                     } }
                 },
                 CrossRegionConfig = new GuardrailCrossRegionConfigProperty {
                     GuardrailProfileArn = "guardrailProfileArn"
                 },
                 Description = "description",
                 KmsKeyArn = "kmsKeyArn",
                 Name = "name",
                 SensitiveInformationPolicyConfig = new SensitiveInformationPolicyConfigProperty {
                     PiiEntitiesConfig = new [] { new PiiEntityConfigProperty {
                         Action = "action",
                         InputAction = "inputAction",
                         InputEnabled = false,
                         OutputAction = "outputAction",
                         OutputEnabled = false,
                         Type = "type"
                     } },
                     RegexesConfig = new [] { new RegexConfigProperty {
                         Action = "action",
                         Description = "description",
                         InputAction = "inputAction",
                         InputEnabled = false,
                         Name = "name",
                         OutputAction = "outputAction",
                         OutputEnabled = false,
                         Pattern = "pattern"
                     } }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TopicPolicyConfig = new TopicPolicyConfigProperty {
                     TopicsConfig = new [] { new TopicConfigProperty {
                         Definition = "definition",
                         Examples = new [] { "examples" },
                         InputAction = "inputAction",
                         InputEnabled = false,
                         Name = "name",
                         OutputAction = "outputAction",
                         OutputEnabled = false,
                         Type = "type"
                     } },
                     TopicsTierConfig = new TopicsTierConfigProperty {
                         TierName = "tierName"
                     }
                 },
                 WordPolicyConfig = new WordPolicyConfigProperty {
                     ManagedWordListsConfig = new [] { new ManagedWordsConfigProperty {
                         InputAction = "inputAction",
                         InputEnabled = false,
                         OutputAction = "outputAction",
                         OutputEnabled = false,
                         Type = "type"
                     } },
                     WordsConfig = new [] { new WordConfigProperty {
                         InputAction = "inputAction",
                         InputEnabled = false,
                         OutputAction = "outputAction",
                         OutputEnabled = false,
                         Text = "text"
                     } }
                 }
             };

Synopsis

Constructors

CfnGuardrailMixinProps()

Properties for CfnGuardrailPropsMixin.

Properties

AutomatedReasoningPolicyConfig	Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.
BlockedInputMessaging	The message to return when the guardrail blocks a prompt.
BlockedOutputsMessaging	The message to return when the guardrail blocks a model response.
ContentPolicyConfig	The content filter policies to configure for the guardrail.
ContextualGroundingPolicyConfig	Contextual grounding policy config for a guardrail.
CrossRegionConfig	The system-defined guardrail profile that you're using with your guardrail.
Description	A description of the guardrail.
KmsKeyArn	The ARN of the AWS key that you use to encrypt the guardrail.
Name	The name of the guardrail.
SensitiveInformationPolicyConfig	The sensitive information policy to configure for the guardrail.
Tags	The tags that you want to attach to the guardrail.
TopicPolicyConfig	The topic policies to configure for the guardrail.
WordPolicyConfig	The word policy you configure for the guardrail.

Constructors

CfnGuardrailMixinProps()

Properties for CfnGuardrailPropsMixin.

public CfnGuardrailMixinProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Bedrock;

             var cfnGuardrailMixinProps = new CfnGuardrailMixinProps {
                 AutomatedReasoningPolicyConfig = new AutomatedReasoningPolicyConfigProperty {
                     ConfidenceThreshold = 123,
                     Policies = new [] { "policies" }
                 },
                 BlockedInputMessaging = "blockedInputMessaging",
                 BlockedOutputsMessaging = "blockedOutputsMessaging",
                 ContentPolicyConfig = new ContentPolicyConfigProperty {
                     ContentFiltersTierConfig = new ContentFiltersTierConfigProperty {
                         TierName = "tierName"
                     },
                     FiltersConfig = new [] { new ContentFilterConfigProperty {
                         InputAction = "inputAction",
                         InputEnabled = false,
                         InputModalities = new [] { "inputModalities" },
                         InputStrength = "inputStrength",
                         OutputAction = "outputAction",
                         OutputEnabled = false,
                         OutputModalities = new [] { "outputModalities" },
                         OutputStrength = "outputStrength",
                         Type = "type"
                     } }
                 },
                 ContextualGroundingPolicyConfig = new ContextualGroundingPolicyConfigProperty {
                     FiltersConfig = new [] { new ContextualGroundingFilterConfigProperty {
                         Action = "action",
                         Enabled = false,
                         Threshold = 123,
                         Type = "type"
                     } }
                 },
                 CrossRegionConfig = new GuardrailCrossRegionConfigProperty {
                     GuardrailProfileArn = "guardrailProfileArn"
                 },
                 Description = "description",
                 KmsKeyArn = "kmsKeyArn",
                 Name = "name",
                 SensitiveInformationPolicyConfig = new SensitiveInformationPolicyConfigProperty {
                     PiiEntitiesConfig = new [] { new PiiEntityConfigProperty {
                         Action = "action",
                         InputAction = "inputAction",
                         InputEnabled = false,
                         OutputAction = "outputAction",
                         OutputEnabled = false,
                         Type = "type"
                     } },
                     RegexesConfig = new [] { new RegexConfigProperty {
                         Action = "action",
                         Description = "description",
                         InputAction = "inputAction",
                         InputEnabled = false,
                         Name = "name",
                         OutputAction = "outputAction",
                         OutputEnabled = false,
                         Pattern = "pattern"
                     } }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TopicPolicyConfig = new TopicPolicyConfigProperty {
                     TopicsConfig = new [] { new TopicConfigProperty {
                         Definition = "definition",
                         Examples = new [] { "examples" },
                         InputAction = "inputAction",
                         InputEnabled = false,
                         Name = "name",
                         OutputAction = "outputAction",
                         OutputEnabled = false,
                         Type = "type"
                     } },
                     TopicsTierConfig = new TopicsTierConfigProperty {
                         TierName = "tierName"
                     }
                 },
                 WordPolicyConfig = new WordPolicyConfigProperty {
                     ManagedWordListsConfig = new [] { new ManagedWordsConfigProperty {
                         InputAction = "inputAction",
                         InputEnabled = false,
                         OutputAction = "outputAction",
                         OutputEnabled = false,
                         Type = "type"
                     } },
                     WordsConfig = new [] { new WordConfigProperty {
                         InputAction = "inputAction",
                         InputEnabled = false,
                         OutputAction = "outputAction",
                         OutputEnabled = false,
                         Text = "text"
                     } }
                 }
             };

Properties

AutomatedReasoningPolicyConfig

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

public object? AutomatedReasoningPolicyConfig { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnGuardrailPropsMixin.IAutomatedReasoningPolicyConfigProperty

BlockedInputMessaging

The message to return when the guardrail blocks a prompt.

public string? BlockedInputMessaging { get; set; }

Property Value

string

Remarks

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

BlockedOutputsMessaging

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

public string? BlockedOutputsMessaging { get; set; }

Property Value

string

Remarks

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

ContentPolicyConfig

The content filter policies to configure for the guardrail.

public object? ContentPolicyConfig { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnGuardrailPropsMixin.IContentPolicyConfigProperty

ContextualGroundingPolicyConfig

Contextual grounding policy config for a guardrail.

public object? ContextualGroundingPolicyConfig { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnGuardrailPropsMixin.IContextualGroundingPolicyConfigProperty

CrossRegionConfig

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

public object? CrossRegionConfig { get; set; }

Property Value

object

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-crossregionconfig

Type union: either IResolvable or CfnGuardrailPropsMixin.IGuardrailCrossRegionConfigProperty

Description

A description of the guardrail.

public string? Description { get; set; }

Property Value

string

Remarks

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

KmsKeyArn

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

public string? KmsKeyArn { get; set; }

Property Value

string

Remarks

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

Name

The name of the guardrail.

public string? Name { get; set; }

Property Value

string

Remarks

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

SensitiveInformationPolicyConfig

The sensitive information policy to configure for the guardrail.

public object? SensitiveInformationPolicyConfig { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnGuardrailPropsMixin.ISensitiveInformationPolicyConfigProperty

Tags

The tags that you want to attach to the guardrail.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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

TopicPolicyConfig

The topic policies to configure for the guardrail.

public object? TopicPolicyConfig { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnGuardrailPropsMixin.ITopicPolicyConfigProperty

WordPolicyConfig

The word policy you configure for the guardrail.

public object? WordPolicyConfig { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnGuardrailPropsMixin.IWordPolicyConfigProperty

Implements

ICfnGuardrailMixinProps