Update Stream Mode

kinesis_update_stream_mode

R Documentation

Updates the capacity mode of the data stream¶

Description¶

Updates 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 stream.

If you'd still like to proactively scale your on-demand data stream’s capacity, you can unlock the warm throughput feature for on-demand data streams by enabling MinimumThroughputBillingCommitment for your account. Once your account has MinimumThroughputBillingCommitment enabled, you can specify the warm throughput in MiB per second that your stream can support in writes.

Usage¶

kinesis_update_stream_mode(StreamARN, StreamId, StreamModeDetails,
  WarmThroughputMiBps)

Arguments¶

StreamARN

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

StreamId

Not Implemented. Reserved for future use.

StreamModeDetails

[required] 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.

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.

Value¶

An empty list.

Request syntax¶

svc$update_stream_mode(
  StreamARN = "string",
  StreamId = "string",
  StreamModeDetails = list(
    StreamMode = "PROVISIONED"|"ON_DEMAND"
  ),
  WarmThroughputMiBps = 123
)