Interface CfnAIGuardrailMixinProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAIGuardrailMixinProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
date="2026-04-14T18:32:20.349Z")
@Stability(Stable)
public interface CfnAIGuardrailMixinProps
extends software.amazon.jsii.JsiiSerializable
Properties for CfnAIGuardrailPropsMixin.
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.*;
CfnAIGuardrailMixinProps cfnAIGuardrailMixinProps = 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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnAIGuardrailMixinPropsstatic final classAn implementation forCfnAIGuardrailMixinProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringThe identifier of the Amazon Q in Connect assistant.default StringThe message to return when the AI Guardrail blocks a prompt.default StringThe message to return when the AI Guardrail blocks a model response.default ObjectContains details about how to handle harmful content.default ObjectThe policy configuration details for the AI Guardrail's contextual grounding policy.default StringA description of the AI Guardrail.default StringgetName()The name of the AI Guardrail.default ObjectContains details about PII entities and regular expressions to configure for the AI Guardrail.getTags()The tags used to organize, track, or control access for this resource.default ObjectContains details about topics that the AI Guardrail should identify and deny.default ObjectContains details about the word policy to configured for the AI Guardrail.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAssistantId
The identifier of the Amazon Q in Connect assistant.Can be either the ID or the ARN. URLs cannot contain the ARN.
- See Also:
-
getBlockedInputMessaging
The message to return when the AI Guardrail blocks a prompt.- See Also:
-
getBlockedOutputsMessaging
The message to return when the AI Guardrail blocks a model response.- See Also:
-
getContentPolicyConfig
Contains details about how to handle harmful content.Returns union: either
IResolvableorCfnAIGuardrailPropsMixin.AIGuardrailContentPolicyConfigProperty- See Also:
-
getContextualGroundingPolicyConfig
The policy configuration details for the AI Guardrail's contextual grounding policy.Returns union: either
IResolvableorCfnAIGuardrailPropsMixin.AIGuardrailContextualGroundingPolicyConfigProperty- See Also:
-
getDescription
A description of the AI Guardrail.- See Also:
-
getName
The name of the AI Guardrail.- See Also:
-
getSensitiveInformationPolicyConfig
Contains details about PII entities and regular expressions to configure for the AI Guardrail.Returns union: either
IResolvableorCfnAIGuardrailPropsMixin.AIGuardrailSensitiveInformationPolicyConfigProperty- See Also:
-
getTags
The tags used to organize, track, or control access for this resource.- See Also:
-
getTopicPolicyConfig
Contains details about topics that the AI Guardrail should identify and deny.Returns union: either
IResolvableorCfnAIGuardrailPropsMixin.AIGuardrailTopicPolicyConfigProperty- See Also:
-
getWordPolicyConfig
Contains details about the word policy to configured for the AI Guardrail.Returns union: either
IResolvableorCfnAIGuardrailPropsMixin.AIGuardrailWordPolicyConfigProperty- See Also:
-
builder
- Returns:
- a
CfnAIGuardrailMixinProps.BuilderofCfnAIGuardrailMixinProps
-