Class: Aws::Kinesis::Types::StreamDescription

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

Overview

Represents the output for DescribeStream.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_type ⇒ String

The server-side encryption type used on the stream. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.

Returns:

  • (String) 


2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2191

class StreamDescription < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_status,
  :stream_mode_details,
  :shards,
  :has_more_shards,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id)
  SENSITIVE = []
  include Aws::Structure
end

#enhanced_monitoring ⇒ Array<Types::EnhancedMetrics>

Represents the current enhanced monitoring settings of the stream.

Returns:



2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2191

class StreamDescription < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_status,
  :stream_mode_details,
  :shards,
  :has_more_shards,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id)
  SENSITIVE = []
  include Aws::Structure
end

#has_more_shards ⇒ Boolean

If set to true, more shards in the stream are available to describe.

Returns:

  • (Boolean) 


2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2191

class StreamDescription < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_status,
  :stream_mode_details,
  :shards,
  :has_more_shards,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id)
  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) 


2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2191

class StreamDescription < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_status,
  :stream_mode_details,
  :shards,
  :has_more_shards,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id)
  SENSITIVE = []
  include Aws::Structure
end

#retention_period_hours ⇒ Integer

The current retention period, in hours. Minimum value of 24. Maximum value of 168.

Returns:

  • (Integer) 


2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2191

class StreamDescription < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_status,
  :stream_mode_details,
  :shards,
  :has_more_shards,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id)
  SENSITIVE = []
  include Aws::Structure
end

#shards ⇒ Array<Types::Shard>

The shards that comprise the stream.

Returns:



2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2191

class StreamDescription < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_status,
  :stream_mode_details,
  :shards,
  :has_more_shards,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id)
  SENSITIVE = []
  include Aws::Structure
end

#stream_arn ⇒ String

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

Returns:

  • (String) 


2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2191

class StreamDescription < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_status,
  :stream_mode_details,
  :shards,
  :has_more_shards,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id)
  SENSITIVE = []
  include Aws::Structure
end

#stream_creation_timestamp ⇒ Time

The approximate time that the stream was created.

Returns:

  • (Time) 


2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2191

class StreamDescription < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_status,
  :stream_mode_details,
  :shards,
  :has_more_shards,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id)
  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 capacity mode and a provisioned capacity mode for your data streams.

Returns:



2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2191

class StreamDescription < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_status,
  :stream_mode_details,
  :shards,
  :has_more_shards,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id)
  SENSITIVE = []
  include Aws::Structure
end

#stream_name ⇒ String

The name of the stream being described.

Returns:

  • (String) 


2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2191

class StreamDescription < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_status,
  :stream_mode_details,
  :shards,
  :has_more_shards,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id)
  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) 


2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2191

class StreamDescription < Struct.new(
  :stream_name,
  :stream_arn,
  :stream_status,
  :stream_mode_details,
  :shards,
  :has_more_shards,
  :retention_period_hours,
  :stream_creation_timestamp,
  :enhanced_monitoring,
  :encryption_type,
  :key_id)
  SENSITIVE = []
  include Aws::Structure
end