software.amazon.awssdk.services.appflow.model

Interface CreateFlowRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateFlowRequest

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

Method Summary

Modifier and Type	Method and Description
CreateFlowRequest.Builder	description(String description) A description of the flow you want to create.
CreateFlowRequest.Builder	destinationFlowConfigList(Collection<DestinationFlowConfig> destinationFlowConfigList) The configuration that controls how Amazon AppFlow places data in the destination connector.
CreateFlowRequest.Builder	destinationFlowConfigList(Consumer<DestinationFlowConfig.Builder>... destinationFlowConfigList) The configuration that controls how Amazon AppFlow places data in the destination connector.
CreateFlowRequest.Builder	destinationFlowConfigList(DestinationFlowConfig... destinationFlowConfigList) The configuration that controls how Amazon AppFlow places data in the destination connector.
CreateFlowRequest.Builder	flowName(String flowName) The specified name of the flow.
CreateFlowRequest.Builder	kmsArn(String kmsArn) The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
default CreateFlowRequest.Builder	metadataCatalogConfig(Consumer<MetadataCatalogConfig.Builder> metadataCatalogConfig) Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow.
CreateFlowRequest.Builder	metadataCatalogConfig(MetadataCatalogConfig metadataCatalogConfig) Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow.
CreateFlowRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateFlowRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
default CreateFlowRequest.Builder	sourceFlowConfig(Consumer<SourceFlowConfig.Builder> sourceFlowConfig) The configuration that controls how Amazon AppFlow retrieves data from the source connector.
CreateFlowRequest.Builder	sourceFlowConfig(SourceFlowConfig sourceFlowConfig) The configuration that controls how Amazon AppFlow retrieves data from the source connector.
CreateFlowRequest.Builder	tags(Map<String,String> tags) The tags used to organize, track, or control access for your flow.
CreateFlowRequest.Builder	tasks(Collection<Task> tasks) A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
CreateFlowRequest.Builder	tasks(Consumer<Task.Builder>... tasks) A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
CreateFlowRequest.Builder	tasks(Task... tasks) A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
default CreateFlowRequest.Builder	triggerConfig(Consumer<TriggerConfig.Builder> triggerConfig) The trigger settings that determine how and when the flow runs.
CreateFlowRequest.Builder	triggerConfig(TriggerConfig triggerConfig) The trigger settings that determine how and when the flow runs.

Methods inherited from interface software.amazon.awssdk.services.appflow.model.AppflowRequest.Builder

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

flowName

CreateFlowRequest.Builder flowName(String flowName)

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Parameters:

flowName - The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Returns:

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

description

CreateFlowRequest.Builder description(String description)

A description of the flow you want to create.

Parameters:

description - A description of the flow you want to create.

Returns:

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

kmsArn

CreateFlowRequest.Builder kmsArn(String kmsArn)

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

Parameters:

kmsArn - The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

Returns:

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

triggerConfig

CreateFlowRequest.Builder triggerConfig(TriggerConfig triggerConfig)

The trigger settings that determine how and when the flow runs.

Parameters:

triggerConfig - The trigger settings that determine how and when the flow runs.

Returns:

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

triggerConfig

default CreateFlowRequest.Builder triggerConfig(Consumer<TriggerConfig.Builder> triggerConfig)

The trigger settings that determine how and when the flow runs.

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

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

Parameters:

triggerConfig - a consumer that will call methods on TriggerConfig.Builder

Returns:

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

See Also:

triggerConfig(TriggerConfig)

sourceFlowConfig

CreateFlowRequest.Builder sourceFlowConfig(SourceFlowConfig sourceFlowConfig)

The configuration that controls how Amazon AppFlow retrieves data from the source connector.

Parameters:

sourceFlowConfig - The configuration that controls how Amazon AppFlow retrieves data from the source connector.

Returns:

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

sourceFlowConfig

default CreateFlowRequest.Builder sourceFlowConfig(Consumer<SourceFlowConfig.Builder> sourceFlowConfig)

The configuration that controls how Amazon AppFlow retrieves data from the source connector.

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

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

Parameters:

sourceFlowConfig - a consumer that will call methods on SourceFlowConfig.Builder

Returns:

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

See Also:

sourceFlowConfig(SourceFlowConfig)

destinationFlowConfigList

CreateFlowRequest.Builder destinationFlowConfigList(Collection<DestinationFlowConfig> destinationFlowConfigList)

The configuration that controls how Amazon AppFlow places data in the destination connector.

Parameters:

destinationFlowConfigList - The configuration that controls how Amazon AppFlow places data in the destination connector.

Returns:

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

destinationFlowConfigList

CreateFlowRequest.Builder destinationFlowConfigList(DestinationFlowConfig... destinationFlowConfigList)

The configuration that controls how Amazon AppFlow places data in the destination connector.

Parameters:

destinationFlowConfigList - The configuration that controls how Amazon AppFlow places data in the destination connector.

Returns:

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

destinationFlowConfigList

CreateFlowRequest.Builder destinationFlowConfigList(Consumer<DestinationFlowConfig.Builder>... destinationFlowConfigList)

The configuration that controls how Amazon AppFlow places data in the destination connector.

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

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

Parameters:

destinationFlowConfigList - a consumer that will call methods on DestinationFlowConfig.Builder

Returns:

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

See Also:

#destinationFlowConfigList(java.util.Collection)

tasks

CreateFlowRequest.Builder tasks(Collection<Task> tasks)

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

Parameters:

tasks - A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

Returns:

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

tasks

CreateFlowRequest.Builder tasks(Task... tasks)

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

Parameters:

tasks - A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

Returns:

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

tasks

CreateFlowRequest.Builder tasks(Consumer<Task.Builder>... tasks)

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

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

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

Parameters:

tasks - a consumer that will call methods on Task.Builder

Returns:

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

See Also:

#tasks(java.util.Collection)

tags

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

The tags used to organize, track, or control access for your flow.

Parameters:

tags - The tags used to organize, track, or control access for your flow.

Returns:

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

metadataCatalogConfig

CreateFlowRequest.Builder metadataCatalogConfig(MetadataCatalogConfig metadataCatalogConfig)

Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.

Parameters:

metadataCatalogConfig - Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.

Returns:

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

metadataCatalogConfig

default CreateFlowRequest.Builder metadataCatalogConfig(Consumer<MetadataCatalogConfig.Builder> metadataCatalogConfig)

Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.

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

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

Parameters:

metadataCatalogConfig - a consumer that will call methods on MetadataCatalogConfig.Builder

Returns:

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

See Also:

metadataCatalogConfig(MetadataCatalogConfig)

overrideConfiguration

CreateFlowRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder