Package software.amazon.awssdk.services.bedrock.model

Interface CreateGuardrailRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockRequest.Builder, Buildable, CopyableBuilder<CreateGuardrailRequest.Builder,CreateGuardrailRequest>, SdkBuilder<CreateGuardrailRequest.Builder,CreateGuardrailRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateGuardrailRequest

@Mutable
@NotThreadSafe
public static interface CreateGuardrailRequest.Builder
extends BedrockRequest.Builder, SdkPojo, CopyableBuilder<CreateGuardrailRequest.Builder,CreateGuardrailRequest>

Method Summary

Modifier and Type	Method	Description
CreateGuardrailRequest.Builder	blockedInputMessaging(String blockedInputMessaging)	The message to return when the guardrail blocks a prompt.
CreateGuardrailRequest.Builder	blockedOutputsMessaging(String blockedOutputsMessaging)	The message to return when the guardrail blocks a model response.
CreateGuardrailRequest.Builder	clientRequestToken(String clientRequestToken)	A unique, case-sensitive identifier to ensure that the API request completes no more than once.
default CreateGuardrailRequest.Builder	contentPolicyConfig(Consumer<GuardrailContentPolicyConfig.Builder> contentPolicyConfig)	The content filter policies to configure for the guardrail.
CreateGuardrailRequest.Builder	contentPolicyConfig(GuardrailContentPolicyConfig contentPolicyConfig)	The content filter policies to configure for the guardrail.
default CreateGuardrailRequest.Builder	contextualGroundingPolicyConfig(Consumer<GuardrailContextualGroundingPolicyConfig.Builder> contextualGroundingPolicyConfig)	The contextual grounding policy configuration used to create a guardrail.
CreateGuardrailRequest.Builder	contextualGroundingPolicyConfig(GuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig)	The contextual grounding policy configuration used to create a guardrail.
default CreateGuardrailRequest.Builder	crossRegionConfig(Consumer<GuardrailCrossRegionConfig.Builder> crossRegionConfig)	The system-defined guardrail profile that you're using with your guardrail.
CreateGuardrailRequest.Builder	crossRegionConfig(GuardrailCrossRegionConfig crossRegionConfig)	The system-defined guardrail profile that you're using with your guardrail.
CreateGuardrailRequest.Builder	description(String description)	A description of the guardrail.
CreateGuardrailRequest.Builder	kmsKeyId(String kmsKeyId)	The ARN of the KMS key that you use to encrypt the guardrail.
CreateGuardrailRequest.Builder	name(String name)	The name to give the guardrail.
CreateGuardrailRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateGuardrailRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
default CreateGuardrailRequest.Builder	sensitiveInformationPolicyConfig(Consumer<GuardrailSensitiveInformationPolicyConfig.Builder> sensitiveInformationPolicyConfig)	The sensitive information policy to configure for the guardrail.
CreateGuardrailRequest.Builder	sensitiveInformationPolicyConfig(GuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig)	The sensitive information policy to configure for the guardrail.
CreateGuardrailRequest.Builder	tags(Collection<Tag> tags)	The tags that you want to attach to the guardrail.
CreateGuardrailRequest.Builder	tags(Consumer<Tag.Builder>... tags)	The tags that you want to attach to the guardrail.
CreateGuardrailRequest.Builder	tags(Tag... tags)	The tags that you want to attach to the guardrail.
default CreateGuardrailRequest.Builder	topicPolicyConfig(Consumer<GuardrailTopicPolicyConfig.Builder> topicPolicyConfig)	The topic policies to configure for the guardrail.
CreateGuardrailRequest.Builder	topicPolicyConfig(GuardrailTopicPolicyConfig topicPolicyConfig)	The topic policies to configure for the guardrail.
default CreateGuardrailRequest.Builder	wordPolicyConfig(Consumer<GuardrailWordPolicyConfig.Builder> wordPolicyConfig)	The word policy you configure for the guardrail.
CreateGuardrailRequest.Builder	wordPolicyConfig(GuardrailWordPolicyConfig wordPolicyConfig)	The word policy you configure for the guardrail.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrock.model.BedrockRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

name

CreateGuardrailRequest.Builder name(String name)

The name to give the guardrail.

Parameters:

name - The name to give the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreateGuardrailRequest.Builder description(String description)

A description of the guardrail.

Parameters:

description - A description of the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

topicPolicyConfig

CreateGuardrailRequest.Builder topicPolicyConfig(GuardrailTopicPolicyConfig topicPolicyConfig)

The topic policies to configure for the guardrail.

Parameters:

topicPolicyConfig - The topic policies to configure for the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

topicPolicyConfig

default CreateGuardrailRequest.Builder topicPolicyConfig(Consumer<GuardrailTopicPolicyConfig.Builder> topicPolicyConfig)

The topic policies to configure for the guardrail.

This is a convenience method that creates an instance of the GuardrailTopicPolicyConfig.Builder avoiding the need to create one manually via GuardrailTopicPolicyConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to topicPolicyConfig(GuardrailTopicPolicyConfig).

Parameters:

topicPolicyConfig - a consumer that will call methods on GuardrailTopicPolicyConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

topicPolicyConfig(GuardrailTopicPolicyConfig)

contentPolicyConfig

CreateGuardrailRequest.Builder contentPolicyConfig(GuardrailContentPolicyConfig contentPolicyConfig)

The content filter policies to configure for the guardrail.

Parameters:

contentPolicyConfig - The content filter policies to configure for the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

contentPolicyConfig

default CreateGuardrailRequest.Builder contentPolicyConfig(Consumer<GuardrailContentPolicyConfig.Builder> contentPolicyConfig)

The content filter policies to configure for the guardrail.

This is a convenience method that creates an instance of the GuardrailContentPolicyConfig.Builder avoiding the need to create one manually via GuardrailContentPolicyConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to contentPolicyConfig(GuardrailContentPolicyConfig).

Parameters:

contentPolicyConfig - a consumer that will call methods on GuardrailContentPolicyConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

contentPolicyConfig(GuardrailContentPolicyConfig)

wordPolicyConfig

CreateGuardrailRequest.Builder wordPolicyConfig(GuardrailWordPolicyConfig wordPolicyConfig)

The word policy you configure for the guardrail.

Parameters:

wordPolicyConfig - The word policy you configure for the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

wordPolicyConfig

default CreateGuardrailRequest.Builder wordPolicyConfig(Consumer<GuardrailWordPolicyConfig.Builder> wordPolicyConfig)

The word policy you configure for the guardrail.

This is a convenience method that creates an instance of the GuardrailWordPolicyConfig.Builder avoiding the need to create one manually via GuardrailWordPolicyConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to wordPolicyConfig(GuardrailWordPolicyConfig).

Parameters:

wordPolicyConfig - a consumer that will call methods on GuardrailWordPolicyConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

wordPolicyConfig(GuardrailWordPolicyConfig)

sensitiveInformationPolicyConfig

CreateGuardrailRequest.Builder sensitiveInformationPolicyConfig(GuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig)

The sensitive information policy to configure for the guardrail.

Parameters:

sensitiveInformationPolicyConfig - The sensitive information policy to configure for the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

sensitiveInformationPolicyConfig

default CreateGuardrailRequest.Builder sensitiveInformationPolicyConfig(Consumer<GuardrailSensitiveInformationPolicyConfig.Builder> sensitiveInformationPolicyConfig)

The sensitive information policy to configure for the guardrail.

This is a convenience method that creates an instance of the GuardrailSensitiveInformationPolicyConfig.Builder avoiding the need to create one manually via GuardrailSensitiveInformationPolicyConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sensitiveInformationPolicyConfig(GuardrailSensitiveInformationPolicyConfig).

Parameters:

sensitiveInformationPolicyConfig - a consumer that will call methods on GuardrailSensitiveInformationPolicyConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

sensitiveInformationPolicyConfig(GuardrailSensitiveInformationPolicyConfig)

contextualGroundingPolicyConfig

CreateGuardrailRequest.Builder contextualGroundingPolicyConfig(GuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig)

The contextual grounding policy configuration used to create a guardrail.

Parameters:

contextualGroundingPolicyConfig - The contextual grounding policy configuration used to create a guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

contextualGroundingPolicyConfig

default CreateGuardrailRequest.Builder contextualGroundingPolicyConfig(Consumer<GuardrailContextualGroundingPolicyConfig.Builder> contextualGroundingPolicyConfig)

The contextual grounding policy configuration used to create a guardrail.

This is a convenience method that creates an instance of the GuardrailContextualGroundingPolicyConfig.Builder avoiding the need to create one manually via GuardrailContextualGroundingPolicyConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to contextualGroundingPolicyConfig(GuardrailContextualGroundingPolicyConfig).

Parameters:

contextualGroundingPolicyConfig - a consumer that will call methods on GuardrailContextualGroundingPolicyConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

contextualGroundingPolicyConfig(GuardrailContextualGroundingPolicyConfig)

crossRegionConfig

CreateGuardrailRequest.Builder crossRegionConfig(GuardrailCrossRegionConfig crossRegionConfig)

The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.

For more information, see the Amazon Bedrock User Guide.

Parameters:

crossRegionConfig - The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.

For more information, see the Amazon Bedrock User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

crossRegionConfig

default CreateGuardrailRequest.Builder crossRegionConfig(Consumer<GuardrailCrossRegionConfig.Builder> crossRegionConfig)

The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.

For more information, see the Amazon Bedrock User Guide.

This is a convenience method that creates an instance of the GuardrailCrossRegionConfig.Builder avoiding the need to create one manually via GuardrailCrossRegionConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to crossRegionConfig(GuardrailCrossRegionConfig).

Parameters:

crossRegionConfig - a consumer that will call methods on GuardrailCrossRegionConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

crossRegionConfig(GuardrailCrossRegionConfig)

blockedInputMessaging

CreateGuardrailRequest.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.

Returns:

Returns a reference to this object so that method calls can be chained together.

blockedOutputsMessaging

CreateGuardrailRequest.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.

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

CreateGuardrailRequest.Builder kmsKeyId(String kmsKeyId)

The ARN of the KMS key that you use to encrypt the guardrail.

Parameters:

kmsKeyId - The ARN of the KMS key that you use to encrypt the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateGuardrailRequest.Builder tags(Collection<Tag> tags)

The tags that you want to attach to the guardrail.

Parameters:

tags - The tags that you want to attach to the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateGuardrailRequest.Builder tags(Tag... tags)

The tags that you want to attach to the guardrail.

Parameters:

tags - The tags that you want to attach to the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateGuardrailRequest.Builder tags(Consumer<Tag.Builder>... tags)

The tags that you want to attach to the guardrail.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(java.util.Collection)

clientRequestToken

CreateGuardrailRequest.Builder clientRequestToken(String clientRequestToken)

A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.

Parameters:

clientRequestToken - A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateGuardrailRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateGuardrailRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder