interface CfnDeliveryProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Logs.CfnDeliveryProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awslogs#CfnDeliveryProps |
![]() | software.amazon.awscdk.services.logs.CfnDeliveryProps |
![]() | aws_cdk.aws_logs.CfnDeliveryProps |
![]() | aws-cdk-lib » aws_logs » CfnDeliveryProps |
Properties for defining a CfnDelivery
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html
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 |
---|---|---|
delivery | string | The ARN of the delivery destination that is associated with this delivery. |
delivery | string | The name of the delivery source that is associated with this delivery. |
field | 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. |
record | string[] | The list of record fields to be delivered to the destination, in order. |
s3 | 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. |
s3 | string | Use this to reconfigure the S3 object prefix to contain either static or variable sections. |
tags? | Cfn [] | An array of key-value pairs to apply to the 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 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.
s3EnableHiveCompatiblePath?
Type:
boolean |
IResolvable
(optional)
Use this parameter to cause the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.
s3SuffixPath?
Type:
string
(optional)
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.
tags?
Type:
Cfn
[]
(optional)
An array of key-value pairs to apply to the delivery.
For more information, see Tag .