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 Details

    • 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:

    • 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:

    • 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<DestinationFlowConfig>).

      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:

    • 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<Task>).

      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:

    • 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:

    • clientToken

      CreateFlowRequest.Builder clientToken(String clientToken)

      The clientToken parameter is an idempotency token. It ensures that your CreateFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

      If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

      If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to CreateFlow. The token is active for 8 hours.

      Parameters:
      clientToken - The clientToken parameter is an idempotency token. It ensures that your CreateFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

      If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

      If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to CreateFlow. The token is active for 8 hours.

      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.