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

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

Overview

Contains information about a delivery stream.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#create_timestampTime

The date and time that the delivery stream was created.

Returns:

  • (Time)

1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
# File 'lib/aws-sdk-firehose/types.rb', line 1316

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_arnString

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

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

Returns:

  • (String)

1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
# File 'lib/aws-sdk-firehose/types.rb', line 1316

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_configurationTypes::DeliveryStreamEncryptionConfiguration

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


1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
# File 'lib/aws-sdk-firehose/types.rb', line 1316

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_nameString

The name of the delivery stream.

Returns:

  • (String)

1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
# File 'lib/aws-sdk-firehose/types.rb', line 1316

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_statusString

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.

Returns:

  • (String)

1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
# File 'lib/aws-sdk-firehose/types.rb', line 1316

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

Returns:

  • (String)

1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
# File 'lib/aws-sdk-firehose/types.rb', line 1316

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

#destinationsArray<Types::DestinationDescription>

The destinations.

Returns:


1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
# File 'lib/aws-sdk-firehose/types.rb', line 1316

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_descriptionTypes::FailureDescription

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


1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
# File 'lib/aws-sdk-firehose/types.rb', line 1316

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_destinationsBoolean

Indicates whether there are more destinations available to list.

Returns:

  • (Boolean)

1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
# File 'lib/aws-sdk-firehose/types.rb', line 1316

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_timestampTime

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

Returns:

  • (Time)

1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
# File 'lib/aws-sdk-firehose/types.rb', line 1316

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

#sourceTypes::SourceDescription

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


1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
# File 'lib/aws-sdk-firehose/types.rb', line 1316

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_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)

1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
# File 'lib/aws-sdk-firehose/types.rb', line 1316

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