You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Firehose::Types::DeliveryStreamDescription

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains information about a delivery stream.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#create_timestamp ⇒ Time

The date and time that the delivery stream was created.

Returns:

  • (Time) —

    The date and time that the delivery stream was created.

#delivery_stream_arn ⇒ String

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

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the delivery stream.

#delivery_stream_encryption_configuration ⇒ Types::DeliveryStreamEncryptionConfiguration

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

Returns:

#delivery_stream_name ⇒ String

The name of the delivery stream.

Returns:

  • (String) —

    The name of the delivery stream.

#delivery_stream_status ⇒ String

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.

Possible values:

  • CREATING
  • CREATING_FAILED
  • DELETING
  • DELETING_FAILED
  • ACTIVE

Returns:

  • (String) —

    The status of the delivery stream.

#delivery_stream_type ⇒ String

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.

    Possible values:

    • DirectPut
    • KinesisStreamAsSource

Returns:

  • (String) —

    The delivery stream type.

#destinations ⇒ Array<Types::DestinationDescription>

The destinations.

Returns:

#failure_description ⇒ Types::FailureDescription

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

Returns:

#has_more_destinations ⇒ Boolean

Indicates whether there are more destinations available to list.

Returns:

  • (Boolean) —

    Indicates whether there are more destinations available to list.

#last_update_timestamp ⇒ Time

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

Returns:

  • (Time) —

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

#source ⇒ Types::SourceDescription

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

Returns:

#version_id ⇒ String

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.

Returns:

  • (String) —

    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.