Class: Aws::Kinesis::Types::StreamDescriptionSummary

Inherits:

Struct

Object
Struct
Aws::Kinesis::Types::StreamDescriptionSummary

show all

Defined in:: gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb

Overview

Represents the output for DescribeStreamSummary

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#channel_count ⇒ Integer
The number of channels associated with the stream.
#consumer_count ⇒ Integer
The number of enhanced fan-out consumers registered with the stream.
#encryption_type ⇒ String
The encryption type used.
#enhanced_monitoring ⇒ Array<Types::EnhancedMetrics>
Represents the current enhanced monitoring settings of the stream.
#key_id ⇒ String
The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
#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.
#open_shard_count ⇒ Integer
The number of open shards in the stream.
#record_distribution_strategy ⇒ String
The record distribution strategy that the stream currently uses.
#retention_period_hours ⇒ Integer
The current retention period, in hours.
#stream_arn ⇒ String
The Amazon Resource Name (ARN) for the stream being described.
#stream_creation_timestamp ⇒ Time
The approximate time that the stream was created.
#stream_id ⇒ String
Not Implemented.
#stream_mode_details ⇒ Types::StreamModeDetails
Specifies the capacity mode to which you want to set your data stream.
#stream_name ⇒ String
The name of the stream being described.
#stream_status ⇒ String
The current status of the stream being described.
#warm_throughput ⇒ Types::WarmThroughputObject
The warm throughput in MB/s for the stream.

Instance Attribute Details

#channel_count ⇒ `Integer`

The number of channels associated with the stream.

Returns:

(Integer)

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

class StreamDescriptionSummary < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_id,
  :stream_status,
  :stream_mode_details,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id,
  :open_shard_count,
  :consumer_count,
  :warm_throughput,
  :max_record_size_in_ki_b,
  :channel_count,
  :record_distribution_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#consumer_count ⇒ `Integer`

The number of enhanced fan-out consumers registered with the stream.

Returns:

(Integer)

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

class StreamDescriptionSummary < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_id,
  :stream_status,
  :stream_mode_details,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id,
  :open_shard_count,
  :consumer_count,
  :warm_throughput,
  :max_record_size_in_ki_b,
  :channel_count,
  :record_distribution_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_type ⇒ `String`

The encryption type used. This value is one of the following:

KMS
NONE

Returns:

(String)

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

class StreamDescriptionSummary < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_id,
  :stream_status,
  :stream_mode_details,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id,
  :open_shard_count,
  :consumer_count,
  :warm_throughput,
  :max_record_size_in_ki_b,
  :channel_count,
  :record_distribution_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#enhanced_monitoring ⇒ `Array<Types::EnhancedMetrics>`

Represents the current enhanced monitoring settings of the stream.

Returns:

(Array<Types::EnhancedMetrics>)

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

class StreamDescriptionSummary < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_id,
  :stream_status,
  :stream_mode_details,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id,
  :open_shard_count,
  :consumer_count,
  :warm_throughput,
  :max_record_size_in_ki_b,
  :channel_count,
  :record_distribution_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#key_id ⇒ `String`

The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally unique key ID example: 12345678-1234-1234-1234-123456789012
Alias name example: alias/MyAliasName
Master key owned by Kinesis Data Streams: alias/aws/kinesis

Returns:

(String)

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

class StreamDescriptionSummary < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_id,
  :stream_status,
  :stream_mode_details,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id,
  :open_shard_count,
  :consumer_count,
  :warm_throughput,
  :max_record_size_in_ki_b,
  :channel_count,
  :record_distribution_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#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 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 3477

class StreamDescriptionSummary < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_id,
  :stream_status,
  :stream_mode_details,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id,
  :open_shard_count,
  :consumer_count,
  :warm_throughput,
  :max_record_size_in_ki_b,
  :channel_count,
  :record_distribution_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#open_shard_count ⇒ `Integer`

The number of open shards in the stream.

Returns:

(Integer)

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

class StreamDescriptionSummary < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_id,
  :stream_status,
  :stream_mode_details,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id,
  :open_shard_count,
  :consumer_count,
  :warm_throughput,
  :max_record_size_in_ki_b,
  :channel_count,
  :record_distribution_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#record_distribution_strategy ⇒ `String`

The record distribution strategy that the stream currently uses. A value of AUTO indicates that Amazon Kinesis Data Streams distributes records across shards using service-managed algorithms. A value of USER_PARTITION_KEY indicates that shard placement is determined by the partition key that producers supply. This field is only present for streams that use the on-demand capacity mode.

Returns:

(String)

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

class StreamDescriptionSummary < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_id,
  :stream_status,
  :stream_mode_details,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id,
  :open_shard_count,
  :consumer_count,
  :warm_throughput,
  :max_record_size_in_ki_b,
  :channel_count,
  :record_distribution_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#retention_period_hours ⇒ `Integer`

The current retention period, in hours.

Returns:

(Integer)

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

class StreamDescriptionSummary < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_id,
  :stream_status,
  :stream_mode_details,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id,
  :open_shard_count,
  :consumer_count,
  :warm_throughput,
  :max_record_size_in_ki_b,
  :channel_count,
  :record_distribution_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#stream_arn ⇒ `String`

The Amazon Resource Name (ARN) for the stream being described.

Returns:

(String)

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

class StreamDescriptionSummary < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_id,
  :stream_status,
  :stream_mode_details,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id,
  :open_shard_count,
  :consumer_count,
  :warm_throughput,
  :max_record_size_in_ki_b,
  :channel_count,
  :record_distribution_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#stream_creation_timestamp ⇒ `Time`

The approximate time that the stream was created.

Returns:

(Time)

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

class StreamDescriptionSummary < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_id,
  :stream_status,
  :stream_mode_details,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id,
  :open_shard_count,
  :consumer_count,
  :warm_throughput,
  :max_record_size_in_ki_b,
  :channel_count,
  :record_distribution_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#stream_id ⇒ `String`

Not Implemented. Reserved for future use.

Returns:

(String)

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

class StreamDescriptionSummary < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_id,
  :stream_status,
  :stream_mode_details,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id,
  :open_shard_count,
  :consumer_count,
  :warm_throughput,
  :max_record_size_in_ki_b,
  :channel_count,
  :record_distribution_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#stream_mode_details ⇒ `Types::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 ycapacity mode and a provisioned capacity mode for your data streams.

Returns:

(Types::StreamModeDetails)

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

class StreamDescriptionSummary < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_id,
  :stream_status,
  :stream_mode_details,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id,
  :open_shard_count,
  :consumer_count,
  :warm_throughput,
  :max_record_size_in_ki_b,
  :channel_count,
  :record_distribution_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#stream_name ⇒ `String`

The name of the stream being described.

Returns:

(String)

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

class StreamDescriptionSummary < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_id,
  :stream_status,
  :stream_mode_details,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id,
  :open_shard_count,
  :consumer_count,
  :warm_throughput,
  :max_record_size_in_ki_b,
  :channel_count,
  :record_distribution_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#stream_status ⇒ `String`

The current status of the stream being described. The stream status is one of the following states:

CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.
DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.
ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.
UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

Returns:

(String)

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

class StreamDescriptionSummary < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_id,
  :stream_status,
  :stream_mode_details,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id,
  :open_shard_count,
  :consumer_count,
  :warm_throughput,
  :max_record_size_in_ki_b,
  :channel_count,
  :record_distribution_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#warm_throughput ⇒ `Types::WarmThroughputObject`

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

Returns:

(Types::WarmThroughputObject)

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

class StreamDescriptionSummary < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_id,
  :stream_status,
  :stream_mode_details,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id,
  :open_shard_count,
  :consumer_count,
  :warm_throughput,
  :max_record_size_in_ki_b,
  :channel_count,
  :record_distribution_strategy)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Kinesis::Types::StreamDescriptionSummary

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#channel_count ⇒ Integer

#consumer_count ⇒ Integer

#encryption_type ⇒ String

#enhanced_monitoring ⇒ Array<Types::EnhancedMetrics>

#key_id ⇒ String

#max_record_size_in_ki_b ⇒ Integer

#open_shard_count ⇒ Integer

#record_distribution_strategy ⇒ String

#retention_period_hours ⇒ Integer

#stream_arn ⇒ String

#stream_creation_timestamp ⇒ Time

#stream_id ⇒ String

#stream_mode_details ⇒ Types::StreamModeDetails

#stream_name ⇒ String

#stream_status ⇒ String

#warm_throughput ⇒ Types::WarmThroughputObject

#channel_count ⇒ `Integer`

#consumer_count ⇒ `Integer`

#encryption_type ⇒ `String`

#enhanced_monitoring ⇒ `Array<Types::EnhancedMetrics>`

#key_id ⇒ `String`

#max_record_size_in_ki_b ⇒ `Integer`

#open_shard_count ⇒ `Integer`

#record_distribution_strategy ⇒ `String`

#retention_period_hours ⇒ `Integer`

#stream_arn ⇒ `String`

#stream_creation_timestamp ⇒ `Time`

#stream_id ⇒ `String`

#stream_mode_details ⇒ `Types::StreamModeDetails`

#stream_name ⇒ `String`

#stream_status ⇒ `String`

#warm_throughput ⇒ `Types::WarmThroughputObject`