AWS::Logs::DeliverySource - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Logs::DeliverySource

Creates or updates one delivery source in your account. A delivery source is an AWS resource that sends logs to an AWS destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.

Only some AWS services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from AWS services.

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.

  • Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see AWS::Logs::DeliveryDestination or PutDeliveryDestination.

  • Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see AWS::Logs::Delivery or 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::DeliverySource",
  "Properties" : {
      "LogType" : String,
      "Name" : String,
      "ResourceArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Logs::DeliverySource
Properties:
  LogType: String
  Name: String
  ResourceArn: String
  Tags: 
    - Tag

Properties

LogType

The type of log that the source is sending. For valid values for this parameter, see the documentation for the source service.

Required: No

Type: String

Pattern: [\w-]*$

Minimum: 1

Maximum: 255

Update requires: No interruption

Name

The unique name of the delivery source.

Required: Yes

Type: String

Pattern: [\w-]*$

Minimum: 1

Maximum: 60

Update requires: Replacement

ResourceArn

The ARN of the AWS resource that is generating and sending logs. For example, arn:aws:workmail:us-east-1:123456789012:organization/m-1234EXAMPLEabcd1234abcd1234abcd1234

Required: No

Type: String

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

Minimum: 16

Maximum: 2048

Update requires: No interruption

Tags

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

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 source.

ResourceArns

This array contains the ARN of the AWS resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array.

Service

The AWS service that is sending logs.