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

Inherits:

Struct

• Object
• Struct
• Aws::Kinesis::Types::CreateStreamInput

Includes:

Structure

Defined in:

lib/aws-sdk-kinesis/types.rb

Overview

Represents the input for ‘CreateStream`.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #max_record_size_in_ki_b ⇒ Integer

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

• #shard_count ⇒ Integer

  The number of shards that the stream will use.

• #stream_mode_details ⇒ Types::StreamModeDetails

  Indicates the capacity mode of the data stream.

• #stream_name ⇒ String

  A name to identify the stream.

• #tags ⇒ Hash<String,String>

  A set of up to 50 key-value pairs to use to create the tags.

• #warm_throughput_mi_bps ⇒ Integer

  The target warm throughput in MB/s that the stream should be scaled to handle.

Instance Attribute Details

#max_record_size_in_ki_b ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-kinesis/types.rb', line 200

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

#shard_count ⇒ Integer

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)

# File 'lib/aws-sdk-kinesis/types.rb', line 200

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

#stream_mode_details ⇒ Types::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:

• (Types::StreamModeDetails)

# File 'lib/aws-sdk-kinesis/types.rb', line 200

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

#stream_name ⇒ String

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)

# File 'lib/aws-sdk-kinesis/types.rb', line 200

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

#tags ⇒ Hash<String,String>

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:

• (Hash<String,String>)

# File 'lib/aws-sdk-kinesis/types.rb', line 200

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

#warm_throughput_mi_bps ⇒ Integer

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:

• (Integer)

# File 'lib/aws-sdk-kinesis/types.rb', line 200

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