class Amazonite::Kinesis::ChannelSummary

Overview

A summary of a channel, returned by ListChannels.

Included Modules

Defined in:

kinesis/channel_summary.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(channel_name : String, channel_arn : String, channel_id : String, channel_status : ChannelStatus, channel_creation_timestamp : Time, channel_destination_type : ChannelDestinationType, streams : Array(ChannelStreamIdentifier), channel_status_reason : 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 channel_arn : String #

The Amazon Resource Name (ARN) of the channel.


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

The Amazon Resource Name (ARN) of the channel.


[View source]
def channel_creation_timestamp : Time #

The time at which the channel was created.


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

The time at which the channel was created.


[View source]
def channel_destination_type : ChannelDestinationType #

The destination type of the channel. Valid values:

  • S3 - Delivery to a general purpose Amazon S3 bucket.

  • S3_TABLES - Delivery to streaming tables on Apache Iceberg.


[View source]
def channel_destination_type=(channel_destination_type : ChannelDestinationType) #

The destination type of the channel. Valid values:

  • S3 - Delivery to a general purpose Amazon S3 bucket.

  • S3_TABLES - Delivery to streaming tables on Apache Iceberg.


[View source]
def channel_id : String #

The unique identifier of the channel.


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

The unique identifier of the channel.


[View source]
def channel_name : String #

The name of the channel.


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

The name of the channel.


[View source]
def channel_status : ChannelStatus #

The current status of the channel. Valid values:

  • CREATING - The channel is being created.

  • ACTIVE - The channel is ready to deliver records.

  • UPDATING - The channel configuration is being updated.

  • DELETING - The channel is being deleted.

  • FAILED - See ChannelStatusReason for the failure cause.


[View source]
def channel_status=(channel_status : ChannelStatus) #

The current status of the channel. Valid values:

  • CREATING - The channel is being created.

  • ACTIVE - The channel is ready to deliver records.

  • UPDATING - The channel configuration is being updated.

  • DELETING - The channel is being deleted.

  • FAILED - See ChannelStatusReason for the failure cause.


[View source]
def channel_status_reason : String | Nil #

A message describing the reason for a FAILED status.


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

A message describing the reason for a FAILED status.


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

See Object#hash(hasher)


def streams : Array(ChannelStreamIdentifier) #

The source streams associated with the channel.


[View source]
def streams=(streams : Array(ChannelStreamIdentifier)) #

The source streams associated with the channel.


[View source]
def validate! : Nil #

[View source]