interface CfnDeliveryProps

Language	Type name
.NET	`Amazon.CDK.AWS.Logs.CfnDeliveryProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awslogs#CfnDeliveryProps`
Java	`software.amazon.awscdk.services.logs.CfnDeliveryProps`
Python	`aws_cdk.aws_logs.CfnDeliveryProps`
TypeScript	`aws-cdk-lib` » `aws_logs` » `CfnDeliveryProps`

Properties for defining a CfnDelivery.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_logs as logs } from 'aws-cdk-lib';
const cfnDeliveryProps: logs.CfnDeliveryProps = {
  deliveryDestinationArn: 'deliveryDestinationArn',
  deliverySourceName: 'deliverySourceName',

  // the properties below are optional
  fieldDelimiter: 'fieldDelimiter',
  recordFields: ['recordFields'],
  s3EnableHiveCompatiblePath: false,
  s3SuffixPath: 's3SuffixPath',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
deliveryDestinationArn	`string`	The ARN of the delivery destination that is associated with this delivery.
deliverySourceName	`string`	The name of the delivery source that is associated with this delivery.
fieldDelimiter?	`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.
recordFields?	`string[]`	The record fields used in this delivery.
s3EnableHiveCompatiblePath?	`boolean \|` `IResolvable`	This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.
s3SuffixPath?	`string`	This string allows re-configuring the S3 object prefix to contain either static or variable sections.
tags?	`CfnTag[]`	The tags that have been assigned to this delivery.

deliveryDestinationArn

Type: string

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

deliverySourceName

Type: string

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

fieldDelimiter?

Type: string (optional)

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

recordFields?

Type: string[] (optional)

The record fields used in this delivery.

s3EnableHiveCompatiblePath?

Type: boolean | IResolvable (optional)

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

s3SuffixPath?

Type: string (optional)

This string allows re-configuring 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. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.

tags?

Type: CfnTag[] (optional)

The tags that have been assigned to this delivery.