Class: Aws::CloudWatchLogs::Types::DeliveryDestination

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

Overview

This structure contains information about one *delivery destination* in your account. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, are supported as Firehose delivery destinations.

To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:

  • Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see [PutDeliverySource].

  • Create a *delivery destination*, which is a logical object that represents the actual delivery destination.

  • If you are delivering logs cross-account, you must use

    PutDeliveryDestinationPolicy][2

    in the destination account to

    assign an IAM policy to the destination. This policy allows delivery to that destination.

  • Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see [CreateDelivery].

You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.

[1]: docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html [2]: docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html [3]: docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.

Returns:

  • (String) 


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1190

class DeliveryDestination < Struct.new(
  :name,
  :arn,
  :delivery_destination_type,
  :output_format,
  :delivery_destination_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_destination_configuration ⇒ Types::DeliveryDestinationConfiguration

A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.

Returns:



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1190

class DeliveryDestination < Struct.new(
  :name,
  :arn,
  :delivery_destination_type,
  :output_format,
  :delivery_destination_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_destination_type ⇒ String

Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Firehose.

Returns:

  • (String) 


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1190

class DeliveryDestination < Struct.new(
  :name,
  :arn,
  :delivery_destination_type,
  :output_format,
  :delivery_destination_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of this delivery destination.

Returns:

  • (String) 


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1190

class DeliveryDestination < Struct.new(
  :name,
  :arn,
  :delivery_destination_type,
  :output_format,
  :delivery_destination_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#output_format ⇒ String

The format of the logs that are sent to this delivery destination.

Returns:

  • (String) 


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1190

class DeliveryDestination < Struct.new(
  :name,
  :arn,
  :delivery_destination_type,
  :output_format,
  :delivery_destination_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags that have been assigned to this delivery destination.

Returns:

  • (Hash<String,String>) 


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 1190

class DeliveryDestination < Struct.new(
  :name,
  :arn,
  :delivery_destination_type,
  :output_format,
  :delivery_destination_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end