Interface CreateStreamRequest.Builder

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

  • Method Details

    • streamName

      CreateStreamRequest.Builder streamName(String streamName)

      A name to identify the stream. The stream name is scoped to the Amazon Web Services account used by the application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two streams in two different Amazon Web Services accounts can have the same name. Two streams in the same Amazon Web Services account but in two different Regions can also have the same name.

      Parameters:
      streamName - A name to identify the stream. The stream name is scoped to the Amazon Web Services account used by the application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two streams in two different Amazon Web Services accounts can have the same name. Two streams in the same Amazon Web Services account but in two different Regions can also have the same name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shardCount

      CreateStreamRequest.Builder shardCount(Integer shardCount)

      The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.

      Parameters:
      shardCount - The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamModeDetails

      CreateStreamRequest.Builder streamModeDetails(StreamModeDetails streamModeDetails)

      Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

      Parameters:
      streamModeDetails - Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamModeDetails

      default CreateStreamRequest.Builder streamModeDetails(Consumer<StreamModeDetails.Builder> streamModeDetails)

      Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

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

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

      Parameters:
      streamModeDetails - a consumer that will call methods on StreamModeDetails.Builder
      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 set of up to 50 key-value pairs to use to create the tags. A tag consists of a required key and an optional value.

      Parameters:
      tags - A set of up to 50 key-value pairs to use to create the tags. A tag consists of a required key and an optional value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • warmThroughputMiBps

      CreateStreamRequest.Builder warmThroughputMiBps(Integer warmThroughputMiBps)

      The target warm throughput in MB/s that the stream should be scaled to handle. This represents the throughput capacity that will be immediately available for write operations.

      Parameters:
      warmThroughputMiBps - The target warm throughput in MB/s that the stream should be scaled to handle. This represents the throughput capacity that will be immediately available for write operations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxRecordSizeInKiB

      CreateStreamRequest.Builder maxRecordSizeInKiB(Integer maxRecordSizeInKiB)

      The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.

      Parameters:
      maxRecordSizeInKiB - The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recordDistributionStrategy

      CreateStreamRequest.Builder recordDistributionStrategy(String recordDistributionStrategy)

      The record distribution strategy for the stream, which determines how Amazon Kinesis Data Streams distributes records across shards. Specify one of the following values:

      • AUTO – Amazon Kinesis Data Streams distributes records evenly across shards and ignores any partition key and ExplicitHashKey that producers supply. Use this value for stateless workloads that do not require partition-key ordering.

      • USER_PARTITION_KEY – Producers must supply a partition key, which Amazon Kinesis Data Streams uses to determine shard placement. This is the default.

      The record distribution strategy is only supported for streams that use the on-demand capacity mode. If you do not specify this parameter, the stream uses USER_PARTITION_KEY.

      Parameters:
      recordDistributionStrategy - The record distribution strategy for the stream, which determines how Amazon Kinesis Data Streams distributes records across shards. Specify one of the following values:

      • AUTO – Amazon Kinesis Data Streams distributes records evenly across shards and ignores any partition key and ExplicitHashKey that producers supply. Use this value for stateless workloads that do not require partition-key ordering.

      • USER_PARTITION_KEY – Producers must supply a partition key, which Amazon Kinesis Data Streams uses to determine shard placement. This is the default.

      The record distribution strategy is only supported for streams that use the on-demand capacity mode. If you do not specify this parameter, the stream uses USER_PARTITION_KEY.

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

    • recordDistributionStrategy

      CreateStreamRequest.Builder recordDistributionStrategy(RecordDistributionStrategy recordDistributionStrategy)

      The record distribution strategy for the stream, which determines how Amazon Kinesis Data Streams distributes records across shards. Specify one of the following values:

      • AUTO – Amazon Kinesis Data Streams distributes records evenly across shards and ignores any partition key and ExplicitHashKey that producers supply. Use this value for stateless workloads that do not require partition-key ordering.

      • USER_PARTITION_KEY – Producers must supply a partition key, which Amazon Kinesis Data Streams uses to determine shard placement. This is the default.

      The record distribution strategy is only supported for streams that use the on-demand capacity mode. If you do not specify this parameter, the stream uses USER_PARTITION_KEY.

      Parameters:
      recordDistributionStrategy - The record distribution strategy for the stream, which determines how Amazon Kinesis Data Streams distributes records across shards. Specify one of the following values:

      • AUTO – Amazon Kinesis Data Streams distributes records evenly across shards and ignores any partition key and ExplicitHashKey that producers supply. Use this value for stateless workloads that do not require partition-key ordering.

      • USER_PARTITION_KEY – Producers must supply a partition key, which Amazon Kinesis Data Streams uses to determine shard placement. This is the default.

      The record distribution strategy is only supported for streams that use the on-demand capacity mode. If you do not specify this parameter, the stream uses USER_PARTITION_KEY.

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

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