class Amazonite::Kinesis::StreamDescription

Overview

Represents the output for DescribeStream.

Included Modules

Defined in:

kinesis/stream_description.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(stream_name : String, stream_arn : String, stream_status : StreamStatus, shards : Array(Shard), has_more_shards : Bool, retention_period_hours : Int32, stream_creation_timestamp : Time, enhanced_monitoring : Array(EnhancedMetrics), stream_mode_details : StreamModeDetails | Nil = nil, encryption_type : EncryptionType | Nil = nil, key_id : String | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def encryption_type : EncryptionType | Nil #

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.


[View source]
def encryption_type=(encryption_type : EncryptionType | Nil) #

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.


[View source]
def enhanced_monitoring : Array(EnhancedMetrics) #

Represents the current enhanced monitoring settings of the stream.


[View source]
def enhanced_monitoring=(enhanced_monitoring : Array(EnhancedMetrics)) #

Represents the current enhanced monitoring settings of the stream.


[View source]
def has_more_shards : Bool #

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


[View source]
def has_more_shards=(has_more_shards : Bool) #

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


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def key_id : String | Nil #

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


[View source]
def key_id=(key_id : String | Nil) #

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


[View source]
def retention_period_hours : Int32 #

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


[View source]
def retention_period_hours=(retention_period_hours : Int32) #

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


[View source]
def shards : Array(Shard) #

The shards that comprise the stream.


[View source]
def shards=(shards : Array(Shard)) #

The shards that comprise the stream.


[View source]
def stream_arn : String #

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


[View source]
def stream_arn=(stream_arn : String) #

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


[View source]
def stream_creation_timestamp : Time #

The approximate time that the stream was created.


[View source]
def stream_creation_timestamp=(stream_creation_timestamp : Time) #

The approximate time that the stream was created.


[View source]
def stream_mode_details : StreamModeDetails | Nil #

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.


[View source]
def stream_mode_details=(stream_mode_details : StreamModeDetails | Nil) #

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.


[View source]
def stream_name : String #

The name of the stream being described.


[View source]
def stream_name=(stream_name : String) #

The name of the stream being described.


[View source]
def stream_status : StreamStatus #

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.


[View source]
def stream_status=(stream_status : StreamStatus) #

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.


[View source]
def validate! : Nil #

[View source]