DeliveryStreamDescription - Amazon Kinesis Data Firehose
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DeliveryStreamDescription

Contains information about a delivery stream.

Contents

DeliveryStreamARN

The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: arn:.*

Required: Yes

DeliveryStreamName

The name of the delivery stream.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

DeliveryStreamStatus

The status of the delivery stream. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.

Type: String

Valid Values: CREATING | CREATING_FAILED | DELETING | DELETING_FAILED | ACTIVE

Required: Yes

DeliveryStreamType

The delivery stream type. This can be one of the following values:

  • DirectPut: Provider applications access the delivery stream directly.

  • KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

Type: String

Valid Values: DirectPut | KinesisStreamAsSource

Required: Yes

Destinations

The destinations.

Type: Array of DestinationDescription objects

Required: Yes

HasMoreDestinations

Indicates whether there are more destinations available to list.

Type: Boolean

Required: Yes

VersionId

Each time the destination is updated for a delivery 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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: [0-9]+

Required: Yes

CreateTimestamp

The date and time that the delivery stream was created.

Type: Timestamp

Required: No

DeliveryStreamEncryptionConfiguration

Indicates the server-side encryption (SSE) status for the delivery stream.

Type: DeliveryStreamEncryptionConfiguration object

Required: No

FailureDescription

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

Type: FailureDescription object

Required: No

LastUpdateTimestamp

The date and time that the delivery stream was last updated.

Type: Timestamp

Required: No

Source

If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.

Type: SourceDescription object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: