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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb

Overview

Contains information about a Firehose stream.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#create_timestamp ⇒ Time

The date and time that the Firehose stream was created.

Returns:

  • (Time) 


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1478

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.

Returns:

  • (String) 


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1478

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:



1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1478

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) 


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1478

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) 


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1478

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) 


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1478

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:



1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1478

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:



1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1478

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) 


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1478

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) 


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1478

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:



1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1478

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) 


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1478

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