Skip to content

S3DeliveryConfiguration

Source code in docs_src/capo_cloudwatch_logs/types/s3_delivery_configuration.py
class S3DeliveryConfiguration(TypedDict, closed=True):
    suffix_path: NotRequired[
        "capo_cloudwatch_logs.types.delivery_suffix_path.DeliverySuffixPath"
    ]
    """<p>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 vary by log type. To find the values supported for the suffix path for each log type, use the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeConfigurationTemplates.html">DescribeConfigurationTemplates</a> operation and check the <code>allowedSuffixPathFields</code> field in the response. For more information about how the destination prefix, suffix path, and Hive-compatible setting determine the Amazon S3 object key, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-infrastructure-V2-S3.html#AWS-logs-infrastructure-V2-S3-object-key">Amazon S3 object key for V2 deliveries</a>.</p>"""
    enable_hive_compatible_path: NotRequired[
        "capo_cloudwatch_logs.types.boolean.Boolean"
    ]
    """<p>This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.</p>"""

enable_hive_compatible_path instance-attribute

enable_hive_compatible_path: NotRequired[Boolean]

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

suffix_path instance-attribute

suffix_path: NotRequired[DeliverySuffixPath]

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 vary by log type. To find the values supported for the suffix path for each log type, use the DescribeConfigurationTemplates operation and check the allowedSuffixPathFields field in the response. For more information about how the destination prefix, suffix path, and Hive-compatible setting determine the Amazon S3 object key, see Amazon S3 object key for V2 deliveries.