Class CfnGuardrailPropsMixin.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.bedrock.CfnGuardrailPropsMixin.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnGuardrailPropsMixin>
- Enclosing class:
CfnGuardrailPropsMixin
@Stability(Stable)
public static final class CfnGuardrailPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnGuardrailPropsMixin>
A fluent builder for
CfnGuardrailPropsMixin.-
Method Summary
Modifier and TypeMethodDescriptionautomatedReasoningPolicyConfig(CfnGuardrailPropsMixin.AutomatedReasoningPolicyConfigProperty automatedReasoningPolicyConfig) Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.automatedReasoningPolicyConfig(IResolvable automatedReasoningPolicyConfig) Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.blockedInputMessaging(String blockedInputMessaging) The message to return when the guardrail blocks a prompt.blockedOutputsMessaging(String blockedOutputsMessaging) The message to return when the guardrail blocks a model response.build()contentPolicyConfig(CfnGuardrailPropsMixin.ContentPolicyConfigProperty contentPolicyConfig) The content filter policies to configure for the guardrail.contentPolicyConfig(IResolvable contentPolicyConfig) The content filter policies to configure for the guardrail.contextualGroundingPolicyConfig(CfnGuardrailPropsMixin.ContextualGroundingPolicyConfigProperty contextualGroundingPolicyConfig) Contextual grounding policy config for a guardrail.contextualGroundingPolicyConfig(IResolvable contextualGroundingPolicyConfig) Contextual grounding policy config for a guardrail.create()create(CfnPropertyMixinOptions options) crossRegionConfig(CfnGuardrailPropsMixin.GuardrailCrossRegionConfigProperty crossRegionConfig) The system-defined guardrail profile that you're using with your guardrail.crossRegionConfig(IResolvable crossRegionConfig) The system-defined guardrail profile that you're using with your guardrail.description(String description) A description of the guardrail.The ARN of the AWS key that you use to encrypt the guardrail.The name of the guardrail.sensitiveInformationPolicyConfig(CfnGuardrailPropsMixin.SensitiveInformationPolicyConfigProperty sensitiveInformationPolicyConfig) The sensitive information policy to configure for the guardrail.sensitiveInformationPolicyConfig(IResolvable sensitiveInformationPolicyConfig) The sensitive information policy to configure for the guardrail.The tags that you want to attach to the guardrail.topicPolicyConfig(CfnGuardrailPropsMixin.TopicPolicyConfigProperty topicPolicyConfig) The topic policies to configure for the guardrail.topicPolicyConfig(IResolvable topicPolicyConfig) The topic policies to configure for the guardrail.wordPolicyConfig(CfnGuardrailPropsMixin.WordPolicyConfigProperty wordPolicyConfig) The word policy you configure for the guardrail.wordPolicyConfig(IResolvable wordPolicyConfig) The word policy you configure for the guardrail.
-
Method Details
-
create
@Stability(Stable) public static CfnGuardrailPropsMixin.Builder create(CfnPropertyMixinOptions options) - Parameters:
options- Mixin options.- Returns:
- a new instance of
CfnGuardrailPropsMixin.Builder.
-
create
- Returns:
- a new instance of
CfnGuardrailPropsMixin.Builder.
-
automatedReasoningPolicyConfig
@Stability(Stable) public CfnGuardrailPropsMixin.Builder automatedReasoningPolicyConfig(IResolvable automatedReasoningPolicyConfig) Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.- Parameters:
automatedReasoningPolicyConfig- Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails. This parameter is required.- Returns:
this- See Also:
-
automatedReasoningPolicyConfig
@Stability(Stable) public CfnGuardrailPropsMixin.Builder automatedReasoningPolicyConfig(CfnGuardrailPropsMixin.AutomatedReasoningPolicyConfigProperty automatedReasoningPolicyConfig) Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.- Parameters:
automatedReasoningPolicyConfig- Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails. This parameter is required.- Returns:
this- See Also:
-
blockedInputMessaging
@Stability(Stable) public CfnGuardrailPropsMixin.Builder blockedInputMessaging(String blockedInputMessaging) The message to return when the guardrail blocks a prompt.- Parameters:
blockedInputMessaging- The message to return when the guardrail blocks a prompt. This parameter is required.- Returns:
this- See Also:
-
blockedOutputsMessaging
@Stability(Stable) public CfnGuardrailPropsMixin.Builder blockedOutputsMessaging(String blockedOutputsMessaging) The message to return when the guardrail blocks a model response.- Parameters:
blockedOutputsMessaging- The message to return when the guardrail blocks a model response. This parameter is required.- Returns:
this- See Also:
-
contentPolicyConfig
@Stability(Stable) public CfnGuardrailPropsMixin.Builder contentPolicyConfig(IResolvable contentPolicyConfig) The content filter policies to configure for the guardrail.- Parameters:
contentPolicyConfig- The content filter policies to configure for the guardrail. This parameter is required.- Returns:
this- See Also:
-
contentPolicyConfig
@Stability(Stable) public CfnGuardrailPropsMixin.Builder contentPolicyConfig(CfnGuardrailPropsMixin.ContentPolicyConfigProperty contentPolicyConfig) The content filter policies to configure for the guardrail.- Parameters:
contentPolicyConfig- The content filter policies to configure for the guardrail. This parameter is required.- Returns:
this- See Also:
-
contextualGroundingPolicyConfig
@Stability(Stable) public CfnGuardrailPropsMixin.Builder contextualGroundingPolicyConfig(IResolvable contextualGroundingPolicyConfig) Contextual grounding policy config for a guardrail.- Parameters:
contextualGroundingPolicyConfig- Contextual grounding policy config for a guardrail. This parameter is required.- Returns:
this- See Also:
-
contextualGroundingPolicyConfig
@Stability(Stable) public CfnGuardrailPropsMixin.Builder contextualGroundingPolicyConfig(CfnGuardrailPropsMixin.ContextualGroundingPolicyConfigProperty contextualGroundingPolicyConfig) Contextual grounding policy config for a guardrail.- Parameters:
contextualGroundingPolicyConfig- Contextual grounding policy config for a guardrail. This parameter is required.- Returns:
this- See Also:
-
crossRegionConfig
@Stability(Stable) public CfnGuardrailPropsMixin.Builder crossRegionConfig(IResolvable crossRegionConfig) The system-defined guardrail profile that you're using with your guardrail.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 .
- Parameters:
crossRegionConfig- The system-defined guardrail profile that you're using with your guardrail. This parameter is required.- Returns:
this- See Also:
-
crossRegionConfig
@Stability(Stable) public CfnGuardrailPropsMixin.Builder crossRegionConfig(CfnGuardrailPropsMixin.GuardrailCrossRegionConfigProperty crossRegionConfig) The system-defined guardrail profile that you're using with your guardrail.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 .
- Parameters:
crossRegionConfig- The system-defined guardrail profile that you're using with your guardrail. This parameter is required.- Returns:
this- See Also:
-
description
A description of the guardrail.- Parameters:
description- A description of the guardrail. This parameter is required.- Returns:
this- See Also:
-
kmsKeyArn
The ARN of the AWS key that you use to encrypt the guardrail.- Parameters:
kmsKeyArn- The ARN of the AWS key that you use to encrypt the guardrail. This parameter is required.- Returns:
this- See Also:
-
name
The name of the guardrail.- Parameters:
name- The name of the guardrail. This parameter is required.- Returns:
this- See Also:
-
sensitiveInformationPolicyConfig
@Stability(Stable) public CfnGuardrailPropsMixin.Builder sensitiveInformationPolicyConfig(IResolvable sensitiveInformationPolicyConfig) The sensitive information policy to configure for the guardrail.- Parameters:
sensitiveInformationPolicyConfig- The sensitive information policy to configure for the guardrail. This parameter is required.- Returns:
this- See Also:
-
sensitiveInformationPolicyConfig
@Stability(Stable) public CfnGuardrailPropsMixin.Builder sensitiveInformationPolicyConfig(CfnGuardrailPropsMixin.SensitiveInformationPolicyConfigProperty sensitiveInformationPolicyConfig) The sensitive information policy to configure for the guardrail.- Parameters:
sensitiveInformationPolicyConfig- The sensitive information policy to configure for the guardrail. This parameter is required.- Returns:
this- See Also:
-
tags
The tags that you want to attach to the guardrail.- Parameters:
tags- The tags that you want to attach to the guardrail. This parameter is required.- Returns:
this- See Also:
-
topicPolicyConfig
@Stability(Stable) public CfnGuardrailPropsMixin.Builder topicPolicyConfig(IResolvable topicPolicyConfig) The topic policies to configure for the guardrail.- Parameters:
topicPolicyConfig- The topic policies to configure for the guardrail. This parameter is required.- Returns:
this- See Also:
-
topicPolicyConfig
@Stability(Stable) public CfnGuardrailPropsMixin.Builder topicPolicyConfig(CfnGuardrailPropsMixin.TopicPolicyConfigProperty topicPolicyConfig) The topic policies to configure for the guardrail.- Parameters:
topicPolicyConfig- The topic policies to configure for the guardrail. This parameter is required.- Returns:
this- See Also:
-
wordPolicyConfig
@Stability(Stable) public CfnGuardrailPropsMixin.Builder wordPolicyConfig(IResolvable wordPolicyConfig) The word policy you configure for the guardrail.- Parameters:
wordPolicyConfig- The word policy you configure for the guardrail. This parameter is required.- Returns:
this- See Also:
-
wordPolicyConfig
@Stability(Stable) public CfnGuardrailPropsMixin.Builder wordPolicyConfig(CfnGuardrailPropsMixin.WordPolicyConfigProperty wordPolicyConfig) The word policy you configure for the guardrail.- Parameters:
wordPolicyConfig- The word policy you configure for the guardrail. This parameter is required.- Returns:
this- See Also:
-
build
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnGuardrailPropsMixin>- Returns:
- a newly built instance of
CfnGuardrailPropsMixin.
-