class Amazonite::Kinesis::ChannelDescription

• Amazonite::Kinesis::ChannelDescription
• Reference
• Object

Overview

Describes the configuration and current status of a channel.

Included Modules

• JSON::Serializable

Defined in:

kinesis/channel_description.cr

Constructors

• .new(channel_name : String, channel_arn : String, channel_id : String, channel_status : ChannelStatus, channel_creation_timestamp : Time, service_execution_role_arn : String, stream_configuration_list : Array(ChannelStreamDescription), logging_configuration : ChannelLoggingConfiguration, channel_status_reason : String | Nil = nil, s3_destination_configuration : S3DestinationDescription | Nil = nil, s3_tables_destination_configuration : S3TablesDestinationDescription | Nil = nil, encryption_configuration : ChannelEncryptionConfiguration | Nil = nil)
• .new(pull : JSON::PullParser)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #channel_arn : String

  The Amazon Resource Name (ARN) of the channel.

• #channel_arn=(channel_arn : String)

  The Amazon Resource Name (ARN) of the channel.

• #channel_creation_timestamp : Time

  The time at which the channel was created.

• #channel_creation_timestamp=(channel_creation_timestamp : Time)

  The time at which the channel was created.

• #channel_id : String

  The unique identifier of the channel.

• #channel_id=(channel_id : String)

  The unique identifier of the channel.

• #channel_name : String

  The name of the channel.

• #channel_name=(channel_name : String)

  The name of the channel.

• #channel_status : ChannelStatus

  The current status of the channel.

• #channel_status=(channel_status : ChannelStatus)

  The current status of the channel.

• #channel_status_reason : String | Nil

  A message describing the reason for a FAILED status.

• #channel_status_reason=(channel_status_reason : String | Nil)

  A message describing the reason for a FAILED status.

• #encryption_configuration : ChannelEncryptionConfiguration | Nil

  The server-side encryption configuration for the channel.

• #encryption_configuration=(encryption_configuration : ChannelEncryptionConfiguration | Nil)

  The server-side encryption configuration for the channel.

• #hash(hasher)

  See Object#hash(hasher)

• #logging_configuration : ChannelLoggingConfiguration

  The Amazon CloudWatch Logs configuration for the channel.

• #logging_configuration=(logging_configuration : ChannelLoggingConfiguration)

  The Amazon CloudWatch Logs configuration for the channel.

• #s3_destination_configuration : S3DestinationDescription | Nil

  The configuration for delivery to a general purpose Amazon S3 bucket.

• #s3_destination_configuration=(s3_destination_configuration : S3DestinationDescription | Nil)

  The configuration for delivery to a general purpose Amazon S3 bucket.

• #s3_tables_destination_configuration : S3TablesDestinationDescription | Nil

  The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables.

• #s3_tables_destination_configuration=(s3_tables_destination_configuration : S3TablesDestinationDescription | Nil)

  The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables.

• #service_execution_role_arn : String

  The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.

• #service_execution_role_arn=(service_execution_role_arn : String)

  The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.

• #stream_configuration_list : Array(ChannelStreamDescription)

  The source stream configuration for the channel.

• #stream_configuration_list=(stream_configuration_list : Array(ChannelStreamDescription))

  The source stream configuration for the channel.

• #validate! : Nil

Constructor Detail

Instance Method Detail