Interface CreateStreamRequest.Builder

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

  • Method Details

    • clusterIdentifier

      CreateStreamRequest.Builder clusterIdentifier(String clusterIdentifier)

      The ID of the cluster for which to create the stream.

      Parameters:
      clusterIdentifier - The ID of the cluster for which to create the stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetDefinition

      CreateStreamRequest.Builder targetDefinition(TargetDefinition targetDefinition)

      The target destination configuration for the stream. Contains Kinesis stream configuration including stream ARN and IAM role ARN.

      Parameters:
      targetDefinition - The target destination configuration for the stream. Contains Kinesis stream configuration including stream ARN and IAM role ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetDefinition

      default CreateStreamRequest.Builder targetDefinition(Consumer<TargetDefinition.Builder> targetDefinition)

      The target destination configuration for the stream. Contains Kinesis stream configuration including stream ARN and IAM role ARN.

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

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

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

    • ordering

      CreateStreamRequest.Builder ordering(String ordering)

      The ordering mode for the stream. Determines how change events are ordered when delivered to the target.

      Parameters:
      ordering - The ordering mode for the stream. Determines how change events are ordered when delivered to the target.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ordering

      CreateStreamRequest.Builder ordering(StreamOrdering ordering)

      The ordering mode for the stream. Determines how change events are ordered when delivered to the target.

      Parameters:
      ordering - The ordering mode for the stream. Determines how change events are ordered when delivered to the target.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • format

      CreateStreamRequest.Builder format(String format)

      The format of the stream records.

      Parameters:
      format - The format of the stream records.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • format

      CreateStreamRequest.Builder format(StreamFormat format)

      The format of the stream records.

      Parameters:
      format - The format of the stream records.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

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

      A map of key and value pairs to use to tag your stream.

      Parameters:
      tags - A map of key and value pairs to use to tag your stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateStreamRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

      If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

      If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

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

    • overrideConfiguration

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

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