Class: Aws::Kinesis::Types::CreateStreamInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kinesis/types.rb

Overview

Note:

When making an API call, you may pass CreateStreamInput data as a hash:

{
  stream_name: "StreamName", # required
  shard_count: 1,
  stream_mode_details: {
    stream_mode: "PROVISIONED", # required, accepts PROVISIONED, ON_DEMAND
  },
}

Represents the input for `CreateStream`.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#shard_countInteger

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:

  • (Integer)

184
185
186
187
188
189
190
# File 'lib/aws-sdk-kinesis/types.rb', line 184

class CreateStreamInput < Struct.new(
  :stream_name,
  :shard_count,
  :stream_mode_details)
  SENSITIVE = []
  include Aws::Structure
end

#stream_mode_detailsTypes::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.


184
185
186
187
188
189
190
# File 'lib/aws-sdk-kinesis/types.rb', line 184

class CreateStreamInput < Struct.new(
  :stream_name,
  :shard_count,
  :stream_mode_details)
  SENSITIVE = []
  include Aws::Structure
end

#stream_nameString

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:

  • (String)

184
185
186
187
188
189
190
# File 'lib/aws-sdk-kinesis/types.rb', line 184

class CreateStreamInput < Struct.new(
  :stream_name,
  :shard_count,
  :stream_mode_details)
  SENSITIVE = []
  include Aws::Structure
end