Package software.amazon.awssdk.services.bedrockagent.model

Interface CreateFlowRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentRequest.Builder, Buildable, CopyableBuilder<CreateFlowRequest.Builder,CreateFlowRequest>, SdkBuilder<CreateFlowRequest.Builder,CreateFlowRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateFlowRequest

public static interface CreateFlowRequest.Builder
extends BedrockAgentRequest.Builder, SdkPojo, CopyableBuilder<CreateFlowRequest.Builder,CreateFlowRequest>

Method Summary

Modifier and Type	Method	Description
CreateFlowRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
CreateFlowRequest.Builder	customerEncryptionKeyArn(String customerEncryptionKeyArn)	The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
default CreateFlowRequest.Builder	definition(Consumer<FlowDefinition.Builder> definition)	A definition of the nodes and connections between nodes in the flow.
CreateFlowRequest.Builder	definition(FlowDefinition definition)	A definition of the nodes and connections between nodes in the flow.
CreateFlowRequest.Builder	description(String description)	A description for the flow.
CreateFlowRequest.Builder	executionRoleArn(String executionRoleArn)	The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow.
CreateFlowRequest.Builder	name(String name)	A name for the flow.
CreateFlowRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateFlowRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateFlowRequest.Builder	tags(Map<String,String> tags)	Any tags that you want to attach to the flow.

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest.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, sdkFields

Method Details

clientToken

CreateFlowRequest.Builder clientToken(String clientToken)

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

Parameters:

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

Returns:

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

customerEncryptionKeyArn

CreateFlowRequest.Builder customerEncryptionKeyArn(String customerEncryptionKeyArn)

The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.

Parameters:

customerEncryptionKeyArn - The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.

Returns:

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

definition

CreateFlowRequest.Builder definition(FlowDefinition definition)

A definition of the nodes and connections between nodes in the flow.

Parameters:

definition - A definition of the nodes and connections between nodes in the flow.

Returns:

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

definition

default CreateFlowRequest.Builder definition(Consumer<FlowDefinition.Builder> definition)

A definition of the nodes and connections between nodes in the flow.

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

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

Parameters:

definition - a consumer that will call methods on FlowDefinition.Builder

Returns:

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

See Also:

• definition(FlowDefinition)

description

CreateFlowRequest.Builder description(String description)

A description for the flow.

Parameters:

description - A description for the flow.

Returns:

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

executionRoleArn

CreateFlowRequest.Builder executionRoleArn(String executionRoleArn)

The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameters:

executionRoleArn - The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

Returns:

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

name

CreateFlowRequest.Builder name(String name)

A name for the flow.

Parameters:

name - A name for the flow.

Returns:

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

tags

CreateFlowRequest.Builder tags(Map<String,String> tags)

Any tags that you want to attach to the flow. For more information, see Tagging resources in Amazon Bedrock.

Parameters:

tags - Any tags that you want to attach to the flow. For more information, see Tagging resources in Amazon Bedrock.

Returns:

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

overrideConfiguration

CreateFlowRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.