/AWS1/CL_KFKDESCRCHANNELRSP¶
Contains the current configuration and state of a channel.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_channelarn TYPE /AWS1/KFK__STRING /AWS1/KFK__STRING¶
The Amazon Resource Name (ARN) that uniquely identifies the channel.
iv_channelname TYPE /AWS1/KFK__STRING /AWS1/KFK__STRING¶
The name of the channel.
iv_status TYPE /AWS1/KFKCHANNELSTATUS /AWS1/KFKCHANNELSTATUS¶
The current lifecycle state of the channel.
iv_destinationtype TYPE /AWS1/KFKCHANNELDSTTYPE /AWS1/KFKCHANNELDSTTYPE¶
The type of destination configured for the channel.
iv_creationtime TYPE /AWS1/KFK__TIMESTAMPISO8601 /AWS1/KFK__TIMESTAMPISO8601¶
The time when the channel was created.
it_topicconfigurationlist TYPE /AWS1/CL_KFKTOPICCONFIGURATION=>TT___LISTOFTOPICCONFIGURATION TT___LISTOFTOPICCONFIGURATION¶
The list of topic configurations for the channel.
Optional arguments:¶
io_encryptionconfiguration TYPE REF TO /AWS1/CL_KFKENCRYPTIONCONF /AWS1/CL_KFKENCRYPTIONCONF¶
The encryption configuration applied to the channel.
io_icebergdestinationconf TYPE REF TO /AWS1/CL_KFKICEBERGDSTCONF /AWS1/CL_KFKICEBERGDSTCONF¶
The Apache Iceberg destination for the channel, if configured.
io_s3destinationconf TYPE REF TO /AWS1/CL_KFKS3DESTINATIONCONF /AWS1/CL_KFKS3DESTINATIONCONF¶
The Amazon S3 destination for the channel, if configured.
io_logginginfo TYPE REF TO /AWS1/CL_KFKCHANNELLOGGINGINFO /AWS1/CL_KFKCHANNELLOGGINGINFO¶
The destinations to which the channel publishes operational logs.
io_stateinfo TYPE REF TO /AWS1/CL_KFKCHANNELSTATEINFO /AWS1/CL_KFKCHANNELSTATEINFO¶
Additional context for the current channel state, populated when the channel is in FAILED.
iv_clusteroperationarn TYPE /AWS1/KFK__STRING /AWS1/KFK__STRING¶
The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.
it_tags TYPE /AWS1/CL_KFK__MAPOF__STRING_W=>TT___MAPOF__STRING TT___MAPOF__STRING¶
The tags attached to the channel.
Queryable Attributes¶
ChannelArn¶
The Amazon Resource Name (ARN) that uniquely identifies the channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CHANNELARN() |
Getter for CHANNELARN, with configurable default |
ASK_CHANNELARN() |
Getter for CHANNELARN w/ exceptions if field has no value |
HAS_CHANNELARN() |
Determine if CHANNELARN has a value |
ChannelName¶
The name of the channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CHANNELNAME() |
Getter for CHANNELNAME, with configurable default |
ASK_CHANNELNAME() |
Getter for CHANNELNAME w/ exceptions if field has no value |
HAS_CHANNELNAME() |
Determine if CHANNELNAME has a value |
EncryptionConfiguration¶
The encryption configuration applied to the channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENCRYPTIONCONFIGURATION() |
Getter for ENCRYPTIONCONFIGURATION |
IcebergDestinationConfiguration¶
The Apache Iceberg destination for the channel, if configured.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ICEBERGDESTINATIONCONF() |
Getter for ICEBERGDESTINATIONCONF |
S3DestinationConfiguration¶
The Amazon S3 destination for the channel, if configured.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_S3DESTINATIONCONF() |
Getter for S3DESTINATIONCONFIGURATION |
Status¶
The current lifecycle state of the channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
DestinationType¶
The type of destination configured for the channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESTINATIONTYPE() |
Getter for DESTINATIONTYPE, with configurable default |
ASK_DESTINATIONTYPE() |
Getter for DESTINATIONTYPE w/ exceptions if field has no val |
HAS_DESTINATIONTYPE() |
Determine if DESTINATIONTYPE has a value |
CreationTime¶
The time when the channel was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONTIME() |
Getter for CREATIONTIME, with configurable default |
ASK_CREATIONTIME() |
Getter for CREATIONTIME w/ exceptions if field has no value |
HAS_CREATIONTIME() |
Determine if CREATIONTIME has a value |
TopicConfigurationList¶
The list of topic configurations for the channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TOPICCONFIGURATIONLIST() |
Getter for TOPICCONFIGURATIONLIST, with configurable default |
ASK_TOPICCONFIGURATIONLIST() |
Getter for TOPICCONFIGURATIONLIST w/ exceptions if field has |
HAS_TOPICCONFIGURATIONLIST() |
Determine if TOPICCONFIGURATIONLIST has a value |
LoggingInfo¶
The destinations to which the channel publishes operational logs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOGGINGINFO() |
Getter for LOGGINGINFO |
StateInfo¶
Additional context for the current channel state, populated when the channel is in FAILED.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATEINFO() |
Getter for STATEINFO |
ClusterOperationArn¶
The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLUSTEROPERATIONARN() |
Getter for CLUSTEROPERATIONARN, with configurable default |
ASK_CLUSTEROPERATIONARN() |
Getter for CLUSTEROPERATIONARN w/ exceptions if field has no |
HAS_CLUSTEROPERATIONARN() |
Determine if CLUSTEROPERATIONARN has a value |
Tags¶
The tags attached to the channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |