Package software.amazon.awscdk.cfnpropertymixins.services.wisdom

Class CfnAIGuardrailPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.wisdom.CfnAIGuardrailPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-14T18:32:20.350Z")
@Stability(Stable)
public class CfnAIGuardrailPropsMixin
extends Mixin
implements software.constructs.IMixin

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.cfnpropertymixins.services.wisdom.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnAIGuardrailPropsMixin cfnAIGuardrailPropsMixin = CfnAIGuardrailPropsMixin.Builder.create(CfnAIGuardrailMixinProps.builder()
         .assistantId("assistantId")
         .blockedInputMessaging("blockedInputMessaging")
         .blockedOutputsMessaging("blockedOutputsMessaging")
         .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")
                         .description("description")
                         .name("name")
                         .pattern("pattern")
                         .build()))
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .topicPolicyConfig(AIGuardrailTopicPolicyConfigProperty.builder()
                 .topicsConfig(List.of(GuardrailTopicConfigProperty.builder()
                         .definition("definition")
                         .examples(List.of("examples"))
                         .name("name")
                         .type("type")
                         .build()))
                 .build())
         .wordPolicyConfig(AIGuardrailWordPolicyConfigProperty.builder()
                 .managedWordListsConfig(List.of(GuardrailManagedWordsConfigProperty.builder()
                         .type("type")
                         .build()))
                 .wordsConfig(List.of(GuardrailWordConfigProperty.builder()
                         .text("text")
                         .build()))
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnAIGuardrailPropsMixin.AIGuardrailContentPolicyConfigProperty	Content policy config for a guardrail.
static interface	CfnAIGuardrailPropsMixin.AIGuardrailContextualGroundingPolicyConfigProperty	Contextual grounding policy config for a guardrail.
static interface	CfnAIGuardrailPropsMixin.AIGuardrailSensitiveInformationPolicyConfigProperty	Sensitive information policy configuration for a guardrail.
static interface	CfnAIGuardrailPropsMixin.AIGuardrailTopicPolicyConfigProperty	Topic policy configuration for a guardrail.
static interface	CfnAIGuardrailPropsMixin.AIGuardrailWordPolicyConfigProperty	Word policy config for a guardrail.
static final class	CfnAIGuardrailPropsMixin.Builder	A fluent builder for CfnAIGuardrailPropsMixin.
static interface	CfnAIGuardrailPropsMixin.GuardrailContentFilterConfigProperty	Content filter configuration in content policy.
static interface	CfnAIGuardrailPropsMixin.GuardrailContextualGroundingFilterConfigProperty	A configuration for grounding filter.
static interface	CfnAIGuardrailPropsMixin.GuardrailManagedWordsConfigProperty	A managed words config.
static interface	CfnAIGuardrailPropsMixin.GuardrailPiiEntityConfigProperty	PII entity configuration.
static interface	CfnAIGuardrailPropsMixin.GuardrailRegexConfigProperty	A regex configuration.
static interface	CfnAIGuardrailPropsMixin.GuardrailTopicConfigProperty	Topic configuration in topic policy.
static interface	CfnAIGuardrailPropsMixin.GuardrailWordConfigProperty	A custom word config.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnAIGuardrailPropsMixin(CfnAIGuardrailMixinProps props)	Create a mixin to apply properties to AWS::Wisdom::AIGuardrail.
	CfnAIGuardrailPropsMixin(CfnAIGuardrailMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Wisdom::AIGuardrail.
protected	CfnAIGuardrailPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAIGuardrailPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnAIGuardrailMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnAIGuardrailPropsMixin

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

CfnAIGuardrailPropsMixin

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

CfnAIGuardrailPropsMixin

@Stability(Stable)
public CfnAIGuardrailPropsMixin(@NotNull
 CfnAIGuardrailMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Wisdom::AIGuardrail.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnAIGuardrailPropsMixin

@Stability(Stable)
public CfnAIGuardrailPropsMixin(@NotNull
 CfnAIGuardrailMixinProps props)

Create a mixin to apply properties to AWS::Wisdom::AIGuardrail.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnAIGuardrailMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()