Package software.amazon.awscdk.services.wisdom

Class CfnAIGuardrail

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.wisdom.CfnAIGuardrail
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IAIGuardrailRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:16.021Z") @Stability(Stable) public class CfnAIGuardrail extends CfnResource implements IInspectable, IAIGuardrailRef, ITaggableV2
Creates an Amazon Q in Connect AI Guardrail.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.wisdom.*;
 CfnAIGuardrail cfnAIGuardrail = CfnAIGuardrail.Builder.create(this, "MyCfnAIGuardrail")
         .assistantId("assistantId")
         .blockedInputMessaging("blockedInputMessaging")
         .blockedOutputsMessaging("blockedOutputsMessaging")
         // the properties below are optional
         .contentPolicyConfig(AIGuardrailContentPolicyConfigProperty.builder()
                 .filtersConfig(List.of(GuardrailContentFilterConfigProperty.builder()
                         .inputStrength("inputStrength")
                         .outputStrength("outputStrength")
                         .type("type")
                         .build()))
                 .build())
         .contextualGroundingPolicyConfig(AIGuardrailContextualGroundingPolicyConfigProperty.builder()
                 .filtersConfig(List.of(GuardrailContextualGroundingFilterConfigProperty.builder()
                         .threshold(123)
                         .type("type")
                         .build()))
                 .build())
         .description("description")
         .name("name")
         .sensitiveInformationPolicyConfig(AIGuardrailSensitiveInformationPolicyConfigProperty.builder()
                 .piiEntitiesConfig(List.of(GuardrailPiiEntityConfigProperty.builder()
                         .action("action")
                         .type("type")
                         .build()))
                 .regexesConfig(List.of(GuardrailRegexConfigProperty.builder()
                         .action("action")
                         .name("name")
                         .pattern("pattern")
                         // the properties below are optional
                         .description("description")
                         .build()))
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .topicPolicyConfig(AIGuardrailTopicPolicyConfigProperty.builder()
                 .topicsConfig(List.of(GuardrailTopicConfigProperty.builder()
                         .definition("definition")
                         .name("name")
                         .type("type")
                         // the properties below are optional
                         .examples(List.of("examples"))
                         .build()))
                 .build())
         .wordPolicyConfig(AIGuardrailWordPolicyConfigProperty.builder()
                 .managedWordListsConfig(List.of(GuardrailManagedWordsConfigProperty.builder()
                         .type("type")
                         .build()))
                 .wordsConfig(List.of(GuardrailWordConfigProperty.builder()
                         .text("text")
                         .build()))
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAIGuardrail

      protected CfnAIGuardrail(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAIGuardrail

      protected CfnAIGuardrail(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAIGuardrail

      @Stability(Stable) public CfnAIGuardrail(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAIGuardrailProps props)
      Create a new AWS::Wisdom::AIGuardrail.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAiGuardrailRef

      @Stability(Stable) @NotNull public AIGuardrailReference getAiGuardrailRef()
      A reference to a AIGuardrail resource.
      Specified by:
      getAiGuardrailRef in interface IAIGuardrailRef

    • getAttrAiGuardrailArn

      @Stability(Stable) @NotNull public String getAttrAiGuardrailArn()
      The Amazon Resource Name (ARN) of the AI Guardrail.

    • getAttrAiGuardrailId

      @Stability(Stable) @NotNull public String getAttrAiGuardrailId()
      The identifier of the Amazon Q in Connect AI Guardrail.

    • getAttrAssistantArn

      @Stability(Stable) @NotNull public String getAttrAssistantArn()
      The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAssistantId

      @Stability(Stable) @NotNull public String getAssistantId()
      The identifier of the Amazon Q in Connect assistant.

    • setAssistantId

      @Stability(Stable) public void setAssistantId(@NotNull String value)
      The identifier of the Amazon Q in Connect assistant.

    • getBlockedInputMessaging

      @Stability(Stable) @NotNull public String getBlockedInputMessaging()
      The message to return when the AI Guardrail blocks a prompt.

    • setBlockedInputMessaging

      @Stability(Stable) public void setBlockedInputMessaging(@NotNull String value)
      The message to return when the AI Guardrail blocks a prompt.

    • getBlockedOutputsMessaging

      @Stability(Stable) @NotNull public String getBlockedOutputsMessaging()
      The message to return when the AI Guardrail blocks a model response.

    • setBlockedOutputsMessaging

      @Stability(Stable) public void setBlockedOutputsMessaging(@NotNull String value)
      The message to return when the AI Guardrail blocks a model response.

    • getContentPolicyConfig

      @Stability(Stable) @Nullable public Object getContentPolicyConfig()
      Contains details about how to handle harmful content.

      Returns union: either IResolvable or CfnAIGuardrail.AIGuardrailContentPolicyConfigProperty

    • setContentPolicyConfig

      @Stability(Stable) public void setContentPolicyConfig(@Nullable IResolvable value)
      Contains details about how to handle harmful content.

    • setContentPolicyConfig

      @Stability(Stable) public void setContentPolicyConfig(@Nullable CfnAIGuardrail.AIGuardrailContentPolicyConfigProperty value)
      Contains details about how to handle harmful content.

    • getContextualGroundingPolicyConfig

      @Stability(Stable) @Nullable public Object getContextualGroundingPolicyConfig()
      The policy configuration details for the AI Guardrail's contextual grounding policy.

      Returns union: either IResolvable or CfnAIGuardrail.AIGuardrailContextualGroundingPolicyConfigProperty

    • setContextualGroundingPolicyConfig

      @Stability(Stable) public void setContextualGroundingPolicyConfig(@Nullable IResolvable value)
      The policy configuration details for the AI Guardrail's contextual grounding policy.

    • setContextualGroundingPolicyConfig

      @Stability(Stable) public void setContextualGroundingPolicyConfig(@Nullable CfnAIGuardrail.AIGuardrailContextualGroundingPolicyConfigProperty value)
      The policy configuration details for the AI Guardrail's contextual grounding policy.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the AI Guardrail.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the AI Guardrail.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the AI Guardrail.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the AI Guardrail.

    • getSensitiveInformationPolicyConfig

      @Stability(Stable) @Nullable public Object getSensitiveInformationPolicyConfig()
      Contains details about PII entities and regular expressions to configure for the AI Guardrail.

      Returns union: either IResolvable or CfnAIGuardrail.AIGuardrailSensitiveInformationPolicyConfigProperty

    • setSensitiveInformationPolicyConfig

      @Stability(Stable) public void setSensitiveInformationPolicyConfig(@Nullable IResolvable value)
      Contains details about PII entities and regular expressions to configure for the AI Guardrail.

    • setSensitiveInformationPolicyConfig

      @Stability(Stable) public void setSensitiveInformationPolicyConfig(@Nullable CfnAIGuardrail.AIGuardrailSensitiveInformationPolicyConfigProperty value)
      Contains details about PII entities and regular expressions to configure for the AI Guardrail.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      The tags used to organize, track, or control access for this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      The tags used to organize, track, or control access for this resource.

    • getTopicPolicyConfig

      @Stability(Stable) @Nullable public Object getTopicPolicyConfig()
      Contains details about topics that the AI Guardrail should identify and deny.

      Returns union: either IResolvable or CfnAIGuardrail.AIGuardrailTopicPolicyConfigProperty

    • setTopicPolicyConfig

      @Stability(Stable) public void setTopicPolicyConfig(@Nullable IResolvable value)
      Contains details about topics that the AI Guardrail should identify and deny.

    • setTopicPolicyConfig

      @Stability(Stable) public void setTopicPolicyConfig(@Nullable CfnAIGuardrail.AIGuardrailTopicPolicyConfigProperty value)
      Contains details about topics that the AI Guardrail should identify and deny.

    • getWordPolicyConfig

      @Stability(Stable) @Nullable public Object getWordPolicyConfig()
      Contains details about the word policy to configured for the AI Guardrail.

      Returns union: either IResolvable or CfnAIGuardrail.AIGuardrailWordPolicyConfigProperty

    • setWordPolicyConfig

      @Stability(Stable) public void setWordPolicyConfig(@Nullable IResolvable value)
      Contains details about the word policy to configured for the AI Guardrail.

    • setWordPolicyConfig

      @Stability(Stable) public void setWordPolicyConfig(@Nullable CfnAIGuardrail.AIGuardrailWordPolicyConfigProperty value)
      Contains details about the word policy to configured for the AI Guardrail.