CfnDeliveryProps

class aws_cdk.aws_logs.CfnDeliveryProps(*, delivery_destination_arn, delivery_source_name, field_delimiter=None, record_fields=None, s3_enable_hive_compatible_path=None, s3_suffix_path=None, tags=None)

Bases: object

Properties for defining a CfnDelivery.

Parameters:

  • delivery_destination_arn (str) – The ARN of the delivery destination that is associated with this delivery.

  • delivery_source_name (str) – The name of the delivery source that is associated with this delivery.

  • field_delimiter (Optional[str]) – 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_fields (Optional[Sequence[str]]) – 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.

  • s3_enable_hive_compatible_path (Union[bool, IResolvable, None]) – 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_suffix_path (Optional[str]) – 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 (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to the delivery. For more information, see Tag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_logs as logs

cfn_delivery_props = logs.CfnDeliveryProps(
    delivery_destination_arn="deliveryDestinationArn",
    delivery_source_name="deliverySourceName",

    # the properties below are optional
    field_delimiter="fieldDelimiter",
    record_fields=["recordFields"],
    s3_enable_hive_compatible_path=False,
    s3_suffix_path="s3SuffixPath",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

delivery_destination_arn

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-deliverydestinationarn

delivery_source_name

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-deliverysourcename

field_delimiter

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-fielddelimiter

record_fields

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-recordfields

s3_enable_hive_compatible_path

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-s3enablehivecompatiblepath

s3_suffix_path

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-s3suffixpath

tags

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

For more information, see Tag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-tags