kinesis/aws.sdk.kotlin.services.kinesis.model/ChannelDescription

ChannelDescription

class ChannelDescription

Describes the configuration and current status of a channel.

Types

object Companion

Properties

val channelArn: String

The Amazon Resource Name (ARN) of the channel.

channelCreationTimestamp

val channelCreationTimestamp: ERROR CLASS: Symbol not found for aws.smithy.kotlin.runtime.time.Instant

The time at which the channel was created.

val channelId: String

The unique identifier of the channel.

val channelName: String

The name of the channel.

val channelStatus: ChannelStatus

The current status of the channel. Valid values:

channelStatusReason

val channelStatusReason: String?

A message describing the reason for a FAILED status.

encryptionConfiguration

val encryptionConfiguration: ChannelEncryptionConfiguration?

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

loggingConfiguration

val loggingConfiguration: ChannelLoggingConfiguration?

The Amazon CloudWatch Logs configuration for the channel.

s3DestinationConfiguration

val s3DestinationConfiguration: 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.

s3TablesDestinationConfiguration

val s3TablesDestinationConfiguration: 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.

serviceExecutionRoleArn

val serviceExecutionRoleArn: String

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

streamConfigurationList

val streamConfigurationList: List<ChannelStreamDescription>

The source stream configuration for the channel.

Functions

inline fun copy(block: ChannelDescription.Builder.() -> Unit = {}): ChannelDescription

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String