AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Logs::Delivery

CfnDelivery

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](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html) . To update an existing delivery configuration, use [UpdateDeliveryConfiguration](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html) .

Import

import { CfnDelivery } from 'aws-cdk-lib/aws-logs';

Or use the module namespace:

import * as logs from 'aws-cdk-lib/aws-logs';
// logs.CfnDelivery

Properties

Configuration passed to the constructor as CfnDeliveryProps.

deliveryDestinationArnRequired
string

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

deliverySourceNameRequired
string

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

fieldDelimiterOptional
string

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

recordFieldsOptional
string[]

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.

s3EnableHiveCompatiblePathOptional
boolean | IResolvable

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

s3SuffixPathOptional
string

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](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeConfigurationTemplates.html) operation and check the `allowedSuffixPathFields` field in the response.

tagsOptional
CfnTag[]

An array of key-value pairs to apply to the delivery. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Logs::DeliveryView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-logs
CFN TypeAWS::Logs::Delivery
Properties7

Related Constructs

Explore This Service

External Links