CfnDeliveryProps Struct
Properties for defining a CfnDelivery.
Example
ts
// 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
deliveryDestinationArnstringdelivery_destination_arnstrdeliveryDestinationArnStringDeliveryDestinationArnstringDeliveryDestinationArn*stringrequired#The ARN of the delivery destination that is associated with this delivery.
deliverySourceNamestringdelivery_source_namestrdeliverySourceNameStringDeliverySourceNamestringDeliverySourceName*stringrequired#The name of the delivery source that is associated with this delivery.
fieldDelimiterstringfield_delimiterstrfieldDelimiterStringFieldDelimiterstringFieldDelimiter*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.
recordFieldsstring[]record_fieldstyping.List[str]recordFieldsList<String>RecordFieldsstring[]RecordFields*[]*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.
s3EnableHiveCompatiblePathboolean | IResolvables3_enable_hive_compatible_pathtyping.Union[bool, IResolvable]s3EnableHiveCompatiblePathBooleanS3EnableHiveCompatiblePathboolS3EnableHiveCompatiblePathinterface{}#Use this parameter to cause the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.
Use this to reconfigure the S3 object prefix to contain either static or variable sections.
notes
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.