AWS::Logs::DeliveryDestination - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Logs::DeliveryDestination

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

To configure logs delivery between a supported AWS 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 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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Logs::DeliveryDestination",
  "Properties" : {
      "DeliveryDestinationPolicy" : Json,
      "DestinationResourceArn" : String,
      "Name" : String,
      "OutputFormat" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Logs::DeliveryDestination
Properties:
  DeliveryDestinationPolicy: Json
  DestinationResourceArn: String
  Name: String
  OutputFormat: String
  Tags: 
    - Tag

Properties

DeliveryDestinationPolicy

An IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. For examples of this policy, see Examples in the CloudWatch Logs API Reference.

Required: No

Type: Json

Update requires: No interruption

DestinationResourceArn

The ARN of the AWS destination that this delivery destination represents. That AWS destination can be a log group in CloudWatch Logs, an Amazon S3 bucket, or a Firehose stream.

Required: No

Type: String

Pattern: [\w#+=/:,.@-]*\*?

Minimum: 16

Maximum: 2048

Update requires: Replacement

Name

The name of this delivery destination.

Required: Yes

Type: String

Pattern: [\w-]*$

Minimum: 1

Maximum: 60

Update requires: Replacement

OutputFormat

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

Required: No

Type: String

Pattern: ^[0-9A-Za-z]+$

Minimum: 1

Maximum: 12

Update requires: Replacement

Tags

An array of key-value pairs to apply to the delivery destination.

For more information, see Tag.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

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

DeliveryDestinationType

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