Class CfnGuardrail.Builder
java.lang.Object
software.amazon.awscdk.services.bedrock.CfnGuardrail.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnGuardrail>
- Enclosing class:
CfnGuardrail
@Stability(Stable)
public static final class CfnGuardrail.Builder
extends Object
implements software.amazon.jsii.Builder<CfnGuardrail>
A fluent builder for
CfnGuardrail
.-
Method Summary
Modifier and TypeMethodDescriptionblockedInputMessaging
(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
(IResolvable contentPolicyConfig) Content policy config for a guardrail.contentPolicyConfig
(CfnGuardrail.ContentPolicyConfigProperty contentPolicyConfig) Content policy config for a guardrail.static CfnGuardrail.Builder
description
(String description) A description of the guardrail.The ARN of the AWS KMS key used to encrypt the guardrail.The name of the guardrail.sensitiveInformationPolicyConfig
(IResolvable sensitiveInformationPolicyConfig) Sensitive information policy config for a guardrail.sensitiveInformationPolicyConfig
(CfnGuardrail.SensitiveInformationPolicyConfigProperty sensitiveInformationPolicyConfig) Sensitive information policy config for a guardrail.Metadata that you can assign to a guardrail as key-value pairs.topicPolicyConfig
(IResolvable topicPolicyConfig) Topic policy config for a guardrail.topicPolicyConfig
(CfnGuardrail.TopicPolicyConfigProperty topicPolicyConfig) Topic policy config for a guardrail.wordPolicyConfig
(IResolvable wordPolicyConfig) Word policy config for a guardrail.wordPolicyConfig
(CfnGuardrail.WordPolicyConfigProperty wordPolicyConfig) Word policy config for a guardrail.
-
Method Details
-
create
@Stability(Stable) public static CfnGuardrail.Builder create(software.constructs.Construct scope, String id) - 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.- Returns:
- a new instance of
CfnGuardrail.Builder
.
-
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 CfnGuardrail.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:
-
name
The name of the guardrail.- Parameters:
name
- The name of the guardrail. This parameter is required.- Returns:
this
- See Also:
-
contentPolicyConfig
Content policy config for a guardrail.- Parameters:
contentPolicyConfig
- Content policy config for a guardrail. This parameter is required.- Returns:
this
- See Also:
-
contentPolicyConfig
@Stability(Stable) public CfnGuardrail.Builder contentPolicyConfig(CfnGuardrail.ContentPolicyConfigProperty contentPolicyConfig) Content policy config for a guardrail.- Parameters:
contentPolicyConfig
- Content policy config for a 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 KMS key used to encrypt the guardrail.- Parameters:
kmsKeyArn
- The ARN of the AWS KMS key used to encrypt the guardrail. This parameter is required.- Returns:
this
- See Also:
-
sensitiveInformationPolicyConfig
@Stability(Stable) public CfnGuardrail.Builder sensitiveInformationPolicyConfig(IResolvable sensitiveInformationPolicyConfig) Sensitive information policy config for a guardrail.- Parameters:
sensitiveInformationPolicyConfig
- Sensitive information policy config for a guardrail. This parameter is required.- Returns:
this
- See Also:
-
sensitiveInformationPolicyConfig
@Stability(Stable) public CfnGuardrail.Builder sensitiveInformationPolicyConfig(CfnGuardrail.SensitiveInformationPolicyConfigProperty sensitiveInformationPolicyConfig) Sensitive information policy config for a guardrail.- Parameters:
sensitiveInformationPolicyConfig
- Sensitive information policy config for a guardrail. This parameter is required.- Returns:
this
- See Also:
-
tags
Metadata that you can assign to a guardrail as key-value pairs. For more information, see the following resources:.- Parameters:
tags
- Metadata that you can assign to a guardrail as key-value pairs. For more information, see the following resources:. This parameter is required.- Returns:
this
- See Also:
-
topicPolicyConfig
Topic policy config for a guardrail.- Parameters:
topicPolicyConfig
- Topic policy config for a guardrail. This parameter is required.- Returns:
this
- See Also:
-
topicPolicyConfig
@Stability(Stable) public CfnGuardrail.Builder topicPolicyConfig(CfnGuardrail.TopicPolicyConfigProperty topicPolicyConfig) Topic policy config for a guardrail.- Parameters:
topicPolicyConfig
- Topic policy config for a guardrail. This parameter is required.- Returns:
this
- See Also:
-
wordPolicyConfig
Word policy config for a guardrail.- Parameters:
wordPolicyConfig
- Word policy config for a guardrail. This parameter is required.- Returns:
this
- See Also:
-
wordPolicyConfig
@Stability(Stable) public CfnGuardrail.Builder wordPolicyConfig(CfnGuardrail.WordPolicyConfigProperty wordPolicyConfig) Word policy config for a guardrail.- Parameters:
wordPolicyConfig
- Word policy config for a guardrail. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnGuardrail>
- Returns:
- a newly built instance of
CfnGuardrail
.
-