/AWS1/CL_FRHDELIVERYSTREAMDESC¶
Contains information about a Firehose stream.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_deliverystreamname TYPE /AWS1/FRHDELIVERYSTREAMNAME /AWS1/FRHDELIVERYSTREAMNAME¶
The name of the Firehose stream.
iv_deliverystreamarn TYPE /AWS1/FRHDELIVERYSTREAMARN /AWS1/FRHDELIVERYSTREAMARN¶
The Amazon Resource Name (ARN) of the Firehose stream. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
iv_deliverystreamstatus TYPE /AWS1/FRHDELIVERYSTREAMSTATUS /AWS1/FRHDELIVERYSTREAMSTATUS¶
The status of the Firehose stream. If the status of a Firehose stream is
CREATING_FAILED, this status doesn't change, and you can't invokeCreateDeliveryStreamagain on it. However, you can invoke the DeleteDeliveryStream operation to delete it.
iv_deliverystreamtype TYPE /AWS1/FRHDELIVERYSTREAMTYPE /AWS1/FRHDELIVERYSTREAMTYPE¶
The Firehose stream type. This can be one of the following values:
DirectPut: Provider applications access the Firehose stream directly.
KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.
iv_versionid TYPE /AWS1/FRHDELIVERYSTREAMVRSID /AWS1/FRHDELIVERYSTREAMVRSID¶
Each time the destination is updated for a Firehose stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.
it_destinations TYPE /AWS1/CL_FRHDSTDESCRIPTION=>TT_DESTINATIONDESCRIPTIONLIST TT_DESTINATIONDESCRIPTIONLIST¶
The destinations.
iv_hasmoredestinations TYPE /AWS1/FRHBOOLEANOBJECT /AWS1/FRHBOOLEANOBJECT¶
Indicates whether there are more destinations available to list.
Optional arguments:¶
io_failuredescription TYPE REF TO /AWS1/CL_FRHFAILUREDESCRIPTION /AWS1/CL_FRHFAILUREDESCRIPTION¶
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
io_deliverystreamencconf TYPE REF TO /AWS1/CL_FRHDELIVERYSTRMENCC01 /AWS1/CL_FRHDELIVERYSTRMENCC01¶
Indicates the server-side encryption (SSE) status for the Firehose stream.
iv_createtimestamp TYPE /AWS1/FRHTIMESTAMP /AWS1/FRHTIMESTAMP¶
The date and time that the Firehose stream was created.
iv_lastupdatetimestamp TYPE /AWS1/FRHTIMESTAMP /AWS1/FRHTIMESTAMP¶
The date and time that the Firehose stream was last updated.
io_source TYPE REF TO /AWS1/CL_FRHSOURCEDESCRIPTION /AWS1/CL_FRHSOURCEDESCRIPTION¶
If the
DeliveryStreamTypeparameter isKinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.
Queryable Attributes¶
DeliveryStreamName¶
The name of the Firehose stream.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DELIVERYSTREAMNAME() |
Getter for DELIVERYSTREAMNAME, with configurable default |
ASK_DELIVERYSTREAMNAME() |
Getter for DELIVERYSTREAMNAME w/ exceptions if field has no |
HAS_DELIVERYSTREAMNAME() |
Determine if DELIVERYSTREAMNAME has a value |
DeliveryStreamARN¶
The Amazon Resource Name (ARN) of the Firehose stream. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DELIVERYSTREAMARN() |
Getter for DELIVERYSTREAMARN, with configurable default |
ASK_DELIVERYSTREAMARN() |
Getter for DELIVERYSTREAMARN w/ exceptions if field has no v |
HAS_DELIVERYSTREAMARN() |
Determine if DELIVERYSTREAMARN has a value |
DeliveryStreamStatus¶
The status of the Firehose stream. If the status of a Firehose stream is
CREATING_FAILED, this status doesn't change, and you can't invokeCreateDeliveryStreamagain on it. However, you can invoke the DeleteDeliveryStream operation to delete it.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DELIVERYSTREAMSTATUS() |
Getter for DELIVERYSTREAMSTATUS, with configurable default |
ASK_DELIVERYSTREAMSTATUS() |
Getter for DELIVERYSTREAMSTATUS w/ exceptions if field has n |
HAS_DELIVERYSTREAMSTATUS() |
Determine if DELIVERYSTREAMSTATUS has a value |
FailureDescription¶
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FAILUREDESCRIPTION() |
Getter for FAILUREDESCRIPTION |
DeliveryStreamEncryptionConfiguration¶
Indicates the server-side encryption (SSE) status for the Firehose stream.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DELIVERYSTREAMENCCONF() |
Getter for DELIVERYSTREAMENCRYPTIONCONF |
DeliveryStreamType¶
The Firehose stream type. This can be one of the following values:
DirectPut: Provider applications access the Firehose stream directly.
KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DELIVERYSTREAMTYPE() |
Getter for DELIVERYSTREAMTYPE, with configurable default |
ASK_DELIVERYSTREAMTYPE() |
Getter for DELIVERYSTREAMTYPE w/ exceptions if field has no |
HAS_DELIVERYSTREAMTYPE() |
Determine if DELIVERYSTREAMTYPE has a value |
VersionId¶
Each time the destination is updated for a Firehose stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VERSIONID() |
Getter for VERSIONID, with configurable default |
ASK_VERSIONID() |
Getter for VERSIONID w/ exceptions if field has no value |
HAS_VERSIONID() |
Determine if VERSIONID has a value |
CreateTimestamp¶
The date and time that the Firehose stream was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATETIMESTAMP() |
Getter for CREATETIMESTAMP, with configurable default |
ASK_CREATETIMESTAMP() |
Getter for CREATETIMESTAMP w/ exceptions if field has no val |
HAS_CREATETIMESTAMP() |
Determine if CREATETIMESTAMP has a value |
LastUpdateTimestamp¶
The date and time that the Firehose stream was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTUPDATETIMESTAMP() |
Getter for LASTUPDATETIMESTAMP, with configurable default |
ASK_LASTUPDATETIMESTAMP() |
Getter for LASTUPDATETIMESTAMP w/ exceptions if field has no |
HAS_LASTUPDATETIMESTAMP() |
Determine if LASTUPDATETIMESTAMP has a value |
Source¶
If the
DeliveryStreamTypeparameter isKinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOURCE() |
Getter for SOURCE |
Destinations¶
The destinations.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESTINATIONS() |
Getter for DESTINATIONS, with configurable default |
ASK_DESTINATIONS() |
Getter for DESTINATIONS w/ exceptions if field has no value |
HAS_DESTINATIONS() |
Determine if DESTINATIONS has a value |
HasMoreDestinations¶
Indicates whether there are more destinations available to list.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HASMOREDESTINATIONS() |
Getter for HASMOREDESTINATIONS, with configurable default |
ASK_HASMOREDESTINATIONS() |
Getter for HASMOREDESTINATIONS w/ exceptions if field has no |
HAS_HASMOREDESTINATIONS() |
Determine if HASMOREDESTINATIONS has a value |