Interface CreateFlowRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateFlowRequest.Builder,CreateFlowRequest>, QuickSightRequest.Builder, SdkBuilder<CreateFlowRequest.Builder,CreateFlowRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateFlowRequest
@Mutable @NotThreadSafe public static interface CreateFlowRequest.Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<CreateFlowRequest.Builder,CreateFlowRequest>

  • Method Details

    • awsAccountId

      CreateFlowRequest.Builder awsAccountId(String awsAccountId)

      The ID of the Amazon Web Services account where you want to create the flow.

      Parameters:
      awsAccountId - The ID of the Amazon Web Services account where you want to create the flow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateFlowRequest.Builder name(String name)

      The display name for the flow.

      Parameters:
      name - The display name for the flow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateFlowRequest.Builder description(String description)

      The description for the flow.

      Parameters:
      description - The description for the flow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • flowDefinition

      CreateFlowRequest.Builder flowDefinition(Document flowDefinition)

      The definition of the flow, specifying the steps and configurations. This is the flow definition in Quick Flow's internal format. The format is subject to change.

      Always derive or depend on the flow definition from the DescribeFlow operation to ensure you are working with the latest format.

      Parameters:
      flowDefinition - The definition of the flow, specifying the steps and configurations. This is the flow definition in Quick Flow's internal format. The format is subject to change.

      Always derive or depend on the flow definition from the DescribeFlow operation to ensure you are working with the latest format.

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

    • permissions

      CreateFlowRequest.Builder permissions(Collection<Permission> permissions)

      Initial permissions for the flow. If omitted, the flow is created without any permissions.

      Parameters:
      permissions - Initial permissions for the flow. If omitted, the flow is created without any permissions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissions

      CreateFlowRequest.Builder permissions(Permission... permissions)

      Initial permissions for the flow. If omitted, the flow is created without any permissions.

      Parameters:
      permissions - Initial permissions for the flow. If omitted, the flow is created without any permissions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissions

      CreateFlowRequest.Builder permissions(Consumer<Permission.Builder>... permissions)

      Initial permissions for the flow. If omitted, the flow is created without any permissions.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to permissions(List<Permission>).

      Parameters:
      permissions - a consumer that will call methods on Permission.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      CreateFlowRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      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.