Class CfnGuardrailPropsMixin

Creates a guardrail to detect and filter harmful content in your generative AI application.

Inheritance
object
Mixin
CfnGuardrailPropsMixin
Implements
IMixin
Inherited Members
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Bedrock
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnGuardrailPropsMixin : Mixin, IMixin
Syntax (vb)
Public Class CfnGuardrailPropsMixin Inherits Mixin Implements IMixin
Remarks

Amazon Bedrock Guardrails provides the following safeguards (also known as policies) to detect and filter harmful content:

    For more information, see How Amazon Bedrock Guardrails works .

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

    CloudformationResource: AWS::Bedrock::Guardrail

    Mixin: true

    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;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnGuardrailPropsMixin = new CfnGuardrailPropsMixin(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"
                     } }
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

    Synopsis

    Constructors

    CfnGuardrailPropsMixin(ICfnGuardrailMixinProps, ICfnPropertyMixinOptions?)

    Create a mixin to apply properties to AWS::Bedrock::Guardrail.

    Properties

    CFN_PROPERTY_KEYS

    Creates a guardrail to detect and filter harmful content in your generative AI application.
    Props

    Creates a guardrail to detect and filter harmful content in your generative AI application.
    Strategy

    Creates a guardrail to detect and filter harmful content in your generative AI application.

    Methods

    ApplyTo(IConstruct)

    Apply the mixin properties to the construct.
    Supports(IConstruct)

    Check if this mixin supports the given construct.

    Constructors

    CfnGuardrailPropsMixin(ICfnGuardrailMixinProps, ICfnPropertyMixinOptions?)

    Create a mixin to apply properties to AWS::Bedrock::Guardrail.

    public CfnGuardrailPropsMixin(ICfnGuardrailMixinProps props, ICfnPropertyMixinOptions? options = null)
    Parameters
    props ICfnGuardrailMixinProps

    L1 properties to apply.

    options ICfnPropertyMixinOptions

    Mixin options.

    Remarks

    Amazon Bedrock Guardrails provides the following safeguards (also known as policies) to detect and filter harmful content:

      For more information, see How Amazon Bedrock Guardrails works .

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

      CloudformationResource: AWS::Bedrock::Guardrail

      Mixin: true

      ExampleMetadata: fixture=_generated

      Properties

      CFN_PROPERTY_KEYS

      Creates a guardrail to detect and filter harmful content in your generative AI application.

      protected static string[] CFN_PROPERTY_KEYS { get; }
      Property Value

      string[]

      Remarks

      Amazon Bedrock Guardrails provides the following safeguards (also known as policies) to detect and filter harmful content:

        For more information, see How Amazon Bedrock Guardrails works .

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

        CloudformationResource: AWS::Bedrock::Guardrail

        Mixin: true

        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;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnGuardrailPropsMixin = new CfnGuardrailPropsMixin(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"
                     } }
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

        Props

        Creates a guardrail to detect and filter harmful content in your generative AI application.

        protected virtual ICfnGuardrailMixinProps Props { get; }
        Property Value

        ICfnGuardrailMixinProps

        Remarks

        Amazon Bedrock Guardrails provides the following safeguards (also known as policies) to detect and filter harmful content:

          For more information, see How Amazon Bedrock Guardrails works .

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

          CloudformationResource: AWS::Bedrock::Guardrail

          Mixin: true

          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;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnGuardrailPropsMixin = new CfnGuardrailPropsMixin(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"
                     } }
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

          Strategy

          Creates a guardrail to detect and filter harmful content in your generative AI application.

          protected virtual IMergeStrategy Strategy { get; }
          Property Value

          IMergeStrategy

          Remarks

          Amazon Bedrock Guardrails provides the following safeguards (also known as policies) to detect and filter harmful content:

            For more information, see How Amazon Bedrock Guardrails works .

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

            CloudformationResource: AWS::Bedrock::Guardrail

            Mixin: true

            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;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnGuardrailPropsMixin = new CfnGuardrailPropsMixin(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"
                     } }
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

            Methods

            ApplyTo(IConstruct)

            Apply the mixin properties to the construct.

            public override void ApplyTo(IConstruct construct)
            Parameters
            construct IConstruct
            Overrides
            Remarks

            Amazon Bedrock Guardrails provides the following safeguards (also known as policies) to detect and filter harmful content:

              For more information, see How Amazon Bedrock Guardrails works .

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

              CloudformationResource: AWS::Bedrock::Guardrail

              Mixin: true

              ExampleMetadata: fixture=_generated

              Supports(IConstruct)

              Check if this mixin supports the given construct.

              public override bool Supports(IConstruct construct)
              Parameters
              construct IConstruct
              Returns

              bool

              Overrides
              Remarks

              Amazon Bedrock Guardrails provides the following safeguards (also known as policies) to detect and filter harmful content:

                For more information, see How Amazon Bedrock Guardrails works .

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

                CloudformationResource: AWS::Bedrock::Guardrail

                Mixin: true

                ExampleMetadata: fixture=_generated

                Implements

                Constructs.IMixin