Skip to content

ConfigurationTemplate

Source code in docs_src/capo_cloudwatch_logs/types/configuration_template.py
class ConfigurationTemplate(TypedDict, closed=True):
    service: NotRequired["capo_cloudwatch_logs.types.service.Service"]
    """<p>A string specifying which service this configuration template applies to. For more information about supported services see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enable logging from Amazon Web Services services.</a>.</p>"""
    log_type: NotRequired["capo_cloudwatch_logs.types.log_type.LogType"]
    """<p>A string specifying which log type this configuration template applies to.</p>"""
    resource_type: NotRequired["capo_cloudwatch_logs.types.resource_type.ResourceType"]
    """<p>A string specifying which resource type this configuration template applies to.</p>"""
    delivery_destination_type: NotRequired[
        "capo_cloudwatch_logs.types.delivery_destination_type.DeliveryDestinationType"
    ]
    """<p>A string specifying which destination type this configuration template applies to.</p>"""
    default_delivery_config_values: NotRequired[
        "capo_cloudwatch_logs.types.configuration_template_delivery_config_values.ConfigurationTemplateDeliveryConfigValues"
    ]
    """<p>A mapping that displays the default value of each property within a delivery's configuration, if it is not specified in the request.</p>"""
    allowed_fields: NotRequired[
        "capo_cloudwatch_logs.types.allowed_fields.AllowedFields"
    ]
    """<p>The allowed fields that a caller can use in the <code>recordFields</code> parameter of a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a> or <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html">UpdateDeliveryConfiguration</a> operation.</p>"""
    allowed_output_formats: NotRequired[
        "capo_cloudwatch_logs.types.output_formats.OutputFormats"
    ]
    """<p>The list of delivery destination output formats that are supported by this log source.</p>"""
    allowed_action_for_allow_vended_logs_delivery_for_resource: NotRequired[
        "capo_cloudwatch_logs.types.allowed_action_for_allow_vended_logs_delivery_for_resource.AllowedActionForAllowVendedLogsDeliveryForResource"
    ]
    """<p>The action permissions that a caller needs to have to be able to successfully create a delivery source on the desired resource type when calling <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html">PutDeliverySource</a>.</p>"""
    allowed_field_delimiters: NotRequired[
        "capo_cloudwatch_logs.types.allowed_field_delimiters.AllowedFieldDelimiters"
    ]
    """<p>The valid values that a caller can use as field delimiters when calling <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a> or <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html">UpdateDeliveryConfiguration</a> on a delivery that delivers in <code>Plain</code>, <code>W3C</code>, or <code>Raw</code> format.</p>"""
    allowed_suffix_path_fields: NotRequired[
        "capo_cloudwatch_logs.types.record_fields.RecordFields"
    ]
    """<p>The list of variable fields that can be used in the suffix path of a delivery that delivers to an S3 bucket.</p>"""
    delivery_source_configuration: NotRequired[
        "capo_cloudwatch_logs.types.delivery_source_configuration_schemas.DeliverySourceConfigurationSchemas"
    ]
    """<p>The schema of the delivery source configuration that is available for this log type. Each element describes a configuration that can be set when calling <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html">PutDeliverySource</a>, including the configuration name, type, and default value.</p>"""
    s3_tables_integration: NotRequired[
        "capo_cloudwatch_logs.types.s3_tables_integration.S3TablesIntegration"
    ]
    """<p>The S3 Tables integration configuration for this configuration template, including the datasource name and type.</p>"""

allowed_action_for_allow_vended_logs_delivery_for_resource instance-attribute

allowed_action_for_allow_vended_logs_delivery_for_resource: NotRequired[
    AllowedActionForAllowVendedLogsDeliveryForResource
]

The action permissions that a caller needs to have to be able to successfully create a delivery source on the desired resource type when calling PutDeliverySource.

allowed_field_delimiters instance-attribute

allowed_field_delimiters: NotRequired[AllowedFieldDelimiters]

The valid values that a caller can use as field delimiters when calling CreateDelivery or UpdateDeliveryConfiguration on a delivery that delivers in Plain, W3C, or Raw format.

allowed_fields instance-attribute

allowed_fields: NotRequired[AllowedFields]

The allowed fields that a caller can use in the recordFields parameter of a CreateDelivery or UpdateDeliveryConfiguration operation.

allowed_output_formats instance-attribute

allowed_output_formats: NotRequired[OutputFormats]

The list of delivery destination output formats that are supported by this log source.

allowed_suffix_path_fields instance-attribute

allowed_suffix_path_fields: NotRequired[RecordFields]

The list of variable fields that can be used in the suffix path of a delivery that delivers to an S3 bucket.

default_delivery_config_values instance-attribute

default_delivery_config_values: NotRequired[ConfigurationTemplateDeliveryConfigValues]

A mapping that displays the default value of each property within a delivery's configuration, if it is not specified in the request.

delivery_destination_type instance-attribute

delivery_destination_type: NotRequired[DeliveryDestinationType]

A string specifying which destination type this configuration template applies to.

delivery_source_configuration instance-attribute

delivery_source_configuration: NotRequired[DeliverySourceConfigurationSchemas]

The schema of the delivery source configuration that is available for this log type. Each element describes a configuration that can be set when calling PutDeliverySource, including the configuration name, type, and default value.

log_type instance-attribute

log_type: NotRequired[LogType]

A string specifying which log type this configuration template applies to.

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

A string specifying which resource type this configuration template applies to.

s3_tables_integration instance-attribute

s3_tables_integration: NotRequired[S3TablesIntegration]

The S3 Tables integration configuration for this configuration template, including the datasource name and type.

service instance-attribute

service: NotRequired[Service]

A string specifying which service this configuration template applies to. For more information about supported services see Enable logging from Amazon Web Services services..