AWS::Logs::Delivery - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Logs::Delivery

This structure contains information about one delivery in your account.

A delivery is a connection between a logical delivery source and a logical delivery destination.

For more information, see CreateDelivery.

To update an existing delivery configuration, use UpdateDeliveryConfiguration.

Syntax

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

JSON

{
  "Type" : "AWS::Logs::Delivery",
  "Properties" : {
      "DeliveryDestinationArn" : String,
      "DeliverySourceName" : String,
      "FieldDelimiter" : String,
      "RecordFields" : [ String, ... ],
      "S3EnableHiveCompatiblePath" : Boolean,
      "S3SuffixPath" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Logs::Delivery
Properties:
  DeliveryDestinationArn: String
  DeliverySourceName: String
  FieldDelimiter: String
  RecordFields: 
    - String
  S3EnableHiveCompatiblePath: Boolean
  S3SuffixPath: String
  Tags: 
    - Tag

Properties

DeliveryDestinationArn

The ARN of the delivery destination that is associated with this delivery.

Required: Yes

Type: String

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

Minimum: 16

Maximum: 2048

Update requires: Replacement

DeliverySourceName

The name of the delivery source that is associated with this delivery.

Required: Yes

Type: String

Pattern: [\w-]*$

Minimum: 1

Maximum: 60

Update requires: Replacement

FieldDelimiter

The field delimiter that is used between record fields when the final output format of a delivery is in Plain, W3C, or Raw format.

Required: No

Type: String

Minimum: 1

Maximum: 5

Update requires: No interruption

RecordFields

The list of record fields to be delivered to the destination, in order. If the delivery's log source has mandatory fields, they must be included in this list.

Required: No

Type: Array of String

Minimum: 0

Maximum: 128

Update requires: No interruption

S3EnableHiveCompatiblePath

Use this parameter to cause the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.

Required: No

Type: Boolean

Update requires: No interruption

S3SuffixPath

Use this to reconfigure the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. To find the values supported for the suffix path for each log source, use the DescribeConfigurationTemplates operation and check the allowedSuffixPathFields field in the response.

Required: No

Type: String

Minimum: 0

Maximum: 256

Update requires: No interruption

Tags

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

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.

DeliveryDestinationType

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

DeliveryId

The unique ID that identifies this delivery in your account.