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

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 delivery stream.

Instance Attribute Summary collapse

Instance Attribute Details

#create_timestampTime

The date and time that the delivery stream was created.

Returns:

  • (Time)


559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 559

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

#delivery_stream_arnString

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

Returns:

  • (String)


559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 559

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

#delivery_stream_nameString

The name of the delivery stream.

Returns:

  • (String)


559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 559

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

#delivery_stream_statusString

The status of the delivery stream.

Returns:

  • (String)


559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 559

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

#delivery_stream_typeString

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 stream as a source.

Returns:

  • (String)


559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 559

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

#destinationsArray<Types::DestinationDescription>

The destinations.

Returns:



559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 559

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

#has_more_destinationsBoolean

Indicates whether there are more destinations available to list.

Returns:

  • (Boolean)


559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 559

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

#last_update_timestampTime

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

Returns:

  • (Time)


559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 559

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

#sourceTypes::SourceDescription

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



559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 559

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

#version_idString

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)


559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 559

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