Interface UpdateStreamModeRequest.Builder

  • Method Details

    • streamARN

      Specifies the ARN of the data stream whose capacity mode you want to update.

      Parameters:
      streamARN - Specifies the ARN of the data stream whose capacity mode you want to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • streamModeDetails

      UpdateStreamModeRequest.Builder streamModeDetails(StreamModeDetails streamModeDetails)

      Specifies the capacity mode to which you want to set your 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 - Specifies the capacity mode to which you want to set your 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 UpdateStreamModeRequest.Builder streamModeDetails(Consumer<StreamModeDetails.Builder> streamModeDetails)

      Specifies the capacity mode to which you want to set your 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:
    • warmThroughputMiBps

      UpdateStreamModeRequest.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. This field is only valid when the stream mode is being updated to on-demand.

      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. This field is only valid when the stream mode is being updated to on-demand.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

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

      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.