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

Inherits:

Struct

• Object
• Struct
• Aws::Firehose::Types::DeliveryStreamDescription

Includes:

Structure

Defined in:

lib/aws-sdk-firehose/types.rb

Overview

Contains information about a Firehose stream.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #create_timestamp ⇒ Time

  The date and time that the Firehose stream was created.

• #delivery_stream_arn ⇒ String

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

• #delivery_stream_encryption_configuration ⇒ Types::DeliveryStreamEncryptionConfiguration

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

• #delivery_stream_name ⇒ String

  The name of the Firehose stream.

• #delivery_stream_status ⇒ String

  The status of the Firehose stream.

• #delivery_stream_type ⇒ String

  The Firehose stream type.

• #destinations ⇒ Array<Types::DestinationDescription>

  The destinations.

• #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.

• #has_more_destinations ⇒ Boolean

  Indicates whether there are more destinations available to list.

• #last_update_timestamp ⇒ Time

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

• #source ⇒ Types::SourceDescription

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

• #version_id ⇒ String

  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.

Instance Attribute Details

#create_timestamp ⇒ Time

The date and time that the Firehose stream was created.

Returns:

• (Time)

# File 'lib/aws-sdk-firehose/types.rb', line 1320

class DeliveryStreamDescription < Struct.new(
  :delivery_stream_name,
  :delivery_stream_arn,
  :delivery_stream_status,
  :failure_description,
  :delivery_stream_encryption_configuration,
  :delivery_stream_type,
  :version_id,
  :create_timestamp,
  :last_update_timestamp,
  :source,
  :destinations,
  :has_more_destinations)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_stream_arn ⇒ String

The Amazon Resource Name (ARN) of the Firehose stream. For more information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces].

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 1320

class DeliveryStreamDescription < Struct.new(
  :delivery_stream_name,
  :delivery_stream_arn,
  :delivery_stream_status,
  :failure_description,
  :delivery_stream_encryption_configuration,
  :delivery_stream_type,
  :version_id,
  :create_timestamp,
  :last_update_timestamp,
  :source,
  :destinations,
  :has_more_destinations)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_stream_encryption_configuration ⇒ Types::DeliveryStreamEncryptionConfiguration

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

Returns:

• (Types::DeliveryStreamEncryptionConfiguration)

# File 'lib/aws-sdk-firehose/types.rb', line 1320

class DeliveryStreamDescription < Struct.new(
  :delivery_stream_name,
  :delivery_stream_arn,
  :delivery_stream_status,
  :failure_description,
  :delivery_stream_encryption_configuration,
  :delivery_stream_type,
  :version_id,
  :create_timestamp,
  :last_update_timestamp,
  :source,
  :destinations,
  :has_more_destinations)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_stream_name ⇒ String

The name of the Firehose stream.

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 1320

class DeliveryStreamDescription < Struct.new(
  :delivery_stream_name,
  :delivery_stream_arn,
  :delivery_stream_status,
  :failure_description,
  :delivery_stream_encryption_configuration,
  :delivery_stream_type,
  :version_id,
  :create_timestamp,
  :last_update_timestamp,
  :source,
  :destinations,
  :has_more_destinations)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_stream_status ⇒ String

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 invoke ‘CreateDeliveryStream` again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 1320

class DeliveryStreamDescription < Struct.new(
  :delivery_stream_name,
  :delivery_stream_arn,
  :delivery_stream_status,
  :failure_description,
  :delivery_stream_encryption_configuration,
  :delivery_stream_type,
  :version_id,
  :create_timestamp,
  :last_update_timestamp,
  :source,
  :destinations,
  :has_more_destinations)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_stream_type ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 1320

class DeliveryStreamDescription < Struct.new(
  :delivery_stream_name,
  :delivery_stream_arn,
  :delivery_stream_status,
  :failure_description,
  :delivery_stream_encryption_configuration,
  :delivery_stream_type,
  :version_id,
  :create_timestamp,
  :last_update_timestamp,
  :source,
  :destinations,
  :has_more_destinations)
  SENSITIVE = []
  include Aws::Structure
end

#destinations ⇒ Array<Types::DestinationDescription>

The destinations.

Returns:

• (Array<Types::DestinationDescription>)

# File 'lib/aws-sdk-firehose/types.rb', line 1320

class DeliveryStreamDescription < Struct.new(
  :delivery_stream_name,
  :delivery_stream_arn,
  :delivery_stream_status,
  :failure_description,
  :delivery_stream_encryption_configuration,
  :delivery_stream_type,
  :version_id,
  :create_timestamp,
  :last_update_timestamp,
  :source,
  :destinations,
  :has_more_destinations)
  SENSITIVE = []
  include Aws::Structure
end

#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:

• (Types::FailureDescription)

# File 'lib/aws-sdk-firehose/types.rb', line 1320

class DeliveryStreamDescription < Struct.new(
  :delivery_stream_name,
  :delivery_stream_arn,
  :delivery_stream_status,
  :failure_description,
  :delivery_stream_encryption_configuration,
  :delivery_stream_type,
  :version_id,
  :create_timestamp,
  :last_update_timestamp,
  :source,
  :destinations,
  :has_more_destinations)
  SENSITIVE = []
  include Aws::Structure
end

#has_more_destinations ⇒ Boolean

Indicates whether there are more destinations available to list.

Returns:

• (Boolean)

# File 'lib/aws-sdk-firehose/types.rb', line 1320

class DeliveryStreamDescription < Struct.new(
  :delivery_stream_name,
  :delivery_stream_arn,
  :delivery_stream_status,
  :failure_description,
  :delivery_stream_encryption_configuration,
  :delivery_stream_type,
  :version_id,
  :create_timestamp,
  :last_update_timestamp,
  :source,
  :destinations,
  :has_more_destinations)
  SENSITIVE = []
  include Aws::Structure
end

#last_update_timestamp ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-firehose/types.rb', line 1320

class DeliveryStreamDescription < Struct.new(
  :delivery_stream_name,
  :delivery_stream_arn,
  :delivery_stream_status,
  :failure_description,
  :delivery_stream_encryption_configuration,
  :delivery_stream_type,
  :version_id,
  :create_timestamp,
  :last_update_timestamp,
  :source,
  :destinations,
  :has_more_destinations)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ Types::SourceDescription

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

Returns:

• (Types::SourceDescription)

# File 'lib/aws-sdk-firehose/types.rb', line 1320

class DeliveryStreamDescription < Struct.new(
  :delivery_stream_name,
  :delivery_stream_arn,
  :delivery_stream_status,
  :failure_description,
  :delivery_stream_encryption_configuration,
  :delivery_stream_type,
  :version_id,
  :create_timestamp,
  :last_update_timestamp,
  :source,
  :destinations,
  :has_more_destinations)
  SENSITIVE = []
  include Aws::Structure
end

#version_id ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 1320

class DeliveryStreamDescription < Struct.new(
  :delivery_stream_name,
  :delivery_stream_arn,
  :delivery_stream_status,
  :failure_description,
  :delivery_stream_encryption_configuration,
  :delivery_stream_type,
  :version_id,
  :create_timestamp,
  :last_update_timestamp,
  :source,
  :destinations,
  :has_more_destinations)
  SENSITIVE = []
  include Aws::Structure
end