/AWS1/CL_KNSCHANNELDESCRIPTION¶
Describes the configuration and current status of a channel.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_channelname TYPE /AWS1/KNSCHANNELNAME /AWS1/KNSCHANNELNAME¶
The name of the channel.
iv_channelarn TYPE /AWS1/KNSCHANNELARN /AWS1/KNSCHANNELARN¶
The Amazon Resource Name (ARN) of the channel.
iv_channelid TYPE /AWS1/KNSCHANNELID /AWS1/KNSCHANNELID¶
The unique identifier of the channel.
iv_channelstatus TYPE /AWS1/KNSCHANNELSTATUS /AWS1/KNSCHANNELSTATUS¶
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- SeeChannelStatusReasonfor the failure cause.
iv_channelcreationtimestamp TYPE /AWS1/KNSTIMESTAMP /AWS1/KNSTIMESTAMP¶
The time at which the channel was created.
iv_serviceexecutionrolearn TYPE /AWS1/KNSROLEARN /AWS1/KNSROLEARN¶
The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.
it_streamconfigurationlist TYPE /AWS1/CL_KNSCHANNELSTREAMDESC=>TT_CHANNELSTREAMDESCLIST TT_CHANNELSTREAMDESCLIST¶
The source stream configuration for the channel.
io_loggingconfiguration TYPE REF TO /AWS1/CL_KNSCHANNELLOGGINGCONF /AWS1/CL_KNSCHANNELLOGGINGCONF¶
The Amazon CloudWatch Logs configuration for the channel.
Optional arguments:¶
iv_channelstatusreason TYPE /AWS1/KNSCHANNELSTATUSREASON /AWS1/KNSCHANNELSTATUSREASON¶
A message describing the reason for a
FAILEDstatus.
io_s3destinationconf TYPE REF TO /AWS1/CL_KNSS3DESTINATIONDESC /AWS1/CL_KNSS3DESTINATIONDESC¶
The configuration for delivery to a general purpose Amazon S3 bucket. Present only when the channel destination is a general purpose Amazon S3 bucket.
io_s3tablesdestinationconf TYPE REF TO /AWS1/CL_KNSS3TABLESDSTDESC /AWS1/CL_KNSS3TABLESDSTDESC¶
The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. Present only when the channel destination is a streaming table.
io_encryptionconfiguration TYPE REF TO /AWS1/CL_KNSCHANNELENCCONF /AWS1/CL_KNSCHANNELENCCONF¶
The server-side encryption configuration for the channel.
Queryable Attributes¶
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 |
ChannelARN¶
The Amazon Resource Name (ARN) of 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 |
ChannelId¶
The unique identifier of the channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CHANNELID() |
Getter for CHANNELID, with configurable default |
ASK_CHANNELID() |
Getter for CHANNELID w/ exceptions if field has no value |
HAS_CHANNELID() |
Determine if CHANNELID has a value |
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- SeeChannelStatusReasonfor the failure cause.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CHANNELSTATUS() |
Getter for CHANNELSTATUS, with configurable default |
ASK_CHANNELSTATUS() |
Getter for CHANNELSTATUS w/ exceptions if field has no value |
HAS_CHANNELSTATUS() |
Determine if CHANNELSTATUS has a value |
ChannelStatusReason¶
A message describing the reason for a
FAILEDstatus.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CHANNELSTATUSREASON() |
Getter for CHANNELSTATUSREASON, with configurable default |
ASK_CHANNELSTATUSREASON() |
Getter for CHANNELSTATUSREASON w/ exceptions if field has no |
HAS_CHANNELSTATUSREASON() |
Determine if CHANNELSTATUSREASON has a value |
ChannelCreationTimestamp¶
The time at which the channel was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CHANNELCREATIONTIMESTAMP() |
Getter for CHANNELCREATIONTIMESTAMP, with configurable defau |
ASK_CHANNELCREATIONTIMESTAMP() |
Getter for CHANNELCREATIONTIMESTAMP w/ exceptions if field h |
HAS_CHANNELCREATIONTIMESTAMP() |
Determine if CHANNELCREATIONTIMESTAMP has a value |
ServiceExecutionRoleARN¶
The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVICEEXECUTIONROLEARN() |
Getter for SERVICEEXECUTIONROLEARN, with configurable defaul |
ASK_SERVICEEXECUTIONROLEARN() |
Getter for SERVICEEXECUTIONROLEARN w/ exceptions if field ha |
HAS_SERVICEEXECUTIONROLEARN() |
Determine if SERVICEEXECUTIONROLEARN has a value |
StreamConfigurationList¶
The source stream configuration for the channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STREAMCONFIGURATIONLIST() |
Getter for STREAMCONFIGURATIONLIST, with configurable defaul |
ASK_STREAMCONFIGURATIONLIST() |
Getter for STREAMCONFIGURATIONLIST w/ exceptions if field ha |
HAS_STREAMCONFIGURATIONLIST() |
Determine if STREAMCONFIGURATIONLIST has a value |
S3DestinationConfiguration¶
The configuration for delivery to a general purpose Amazon S3 bucket. Present only when the channel destination is a general purpose Amazon S3 bucket.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_S3DESTINATIONCONF() |
Getter for S3DESTINATIONCONFIGURATION |
S3TablesDestinationConfiguration¶
The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. Present only when the channel destination is a streaming table.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_S3TABLESDESTINATIONCONF() |
Getter for S3TABLESDESTINATIONCONF |
EncryptionConfiguration¶
The server-side encryption configuration for the channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENCRYPTIONCONFIGURATION() |
Getter for ENCRYPTIONCONFIGURATION |
LoggingConfiguration¶
The Amazon CloudWatch Logs configuration for the channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOGGINGCONFIGURATION() |
Getter for LOGGINGCONFIGURATION |