Class: Aws::Kinesis::Types::ChannelDescription

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

Overview

Describes the configuration and current status of a channel.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_arn ⇒ String

The Amazon Resource Name (ARN) of the channel.

Returns:

  • (String) 


127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 127

class ChannelDescription < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :service_execution_role_arn,
  :stream_configuration_list,
  :s3_destination_configuration,
  :s3_tables_destination_configuration,
  :encryption_configuration,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#channel_creation_timestamp ⇒ Time

The time at which the channel was created.

Returns:

  • (Time) 


127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 127

class ChannelDescription < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :service_execution_role_arn,
  :stream_configuration_list,
  :s3_destination_configuration,
  :s3_tables_destination_configuration,
  :encryption_configuration,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#channel_id ⇒ String

The unique identifier of the channel.

Returns:

  • (String) 


127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 127

class ChannelDescription < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :service_execution_role_arn,
  :stream_configuration_list,
  :s3_destination_configuration,
  :s3_tables_destination_configuration,
  :encryption_configuration,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#channel_name ⇒ String

The name of the channel.

Returns:

  • (String) 


127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 127

class ChannelDescription < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :service_execution_role_arn,
  :stream_configuration_list,
  :s3_destination_configuration,
  :s3_tables_destination_configuration,
  :encryption_configuration,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#channel_status ⇒ String

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.

Returns:

  • (String) 


127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 127

class ChannelDescription < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :service_execution_role_arn,
  :stream_configuration_list,
  :s3_destination_configuration,
  :s3_tables_destination_configuration,
  :encryption_configuration,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#channel_status_reason ⇒ String

A message describing the reason for a FAILED status.

Returns:

  • (String) 


127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 127

class ChannelDescription < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :service_execution_role_arn,
  :stream_configuration_list,
  :s3_destination_configuration,
  :s3_tables_destination_configuration,
  :encryption_configuration,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configuration ⇒ Types::ChannelEncryptionConfiguration

The Amazon Web Services KMS key configuration that Amazon Kinesis Data Streams uses to encrypt data delivered to the channel's destination.

Returns:



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 127

class ChannelDescription < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :service_execution_role_arn,
  :stream_configuration_list,
  :s3_destination_configuration,
  :s3_tables_destination_configuration,
  :encryption_configuration,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#logging_configuration ⇒ Types::ChannelLoggingConfiguration

The Amazon CloudWatch Logs configuration for the channel.

Returns:



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 127

class ChannelDescription < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :service_execution_role_arn,
  :stream_configuration_list,
  :s3_destination_configuration,
  :s3_tables_destination_configuration,
  :encryption_configuration,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#s3_destination_configuration ⇒ Types::S3DestinationDescription

The configuration for delivery to a general purpose Amazon S3 bucket. Present only when the channel destination is a general purpose Amazon S3 bucket.

Returns:



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 127

class ChannelDescription < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :service_execution_role_arn,
  :stream_configuration_list,
  :s3_destination_configuration,
  :s3_tables_destination_configuration,
  :encryption_configuration,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#s3_tables_destination_configuration ⇒ Types::S3TablesDestinationDescription

The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. Present only when the channel destination is a streaming table.

Returns:



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 127

class ChannelDescription < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :service_execution_role_arn,
  :stream_configuration_list,
  :s3_destination_configuration,
  :s3_tables_destination_configuration,
  :encryption_configuration,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String) 


127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 127

class ChannelDescription < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :service_execution_role_arn,
  :stream_configuration_list,
  :s3_destination_configuration,
  :s3_tables_destination_configuration,
  :encryption_configuration,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#stream_configuration_list ⇒ Array<Types::ChannelStreamDescription>

The source stream configuration for the channel.

Returns:



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 127

class ChannelDescription < Struct.new(
  :channel_name,
  :channel_arn,
  :channel_id,
  :channel_status,
  :channel_status_reason,
  :channel_creation_timestamp,
  :service_execution_role_arn,
  :stream_configuration_list,
  :s3_destination_configuration,
  :s3_tables_destination_configuration,
  :encryption_configuration,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end