Skip to main content

configuration_templates

Creates, updates, deletes, gets or lists a configuration_templates resource.

Overview

Nameconfiguration_templates
TypeResource
Idaws.logs.configuration_templates

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
allowed_action_for_allow_vended_logs_delivery_for_resourcestringThe 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_delimitersarrayThe 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_fieldsarrayThe allowed fields that a caller can use in the recordFields parameter of a CreateDelivery or UpdateDeliveryConfiguration operation.
allowed_output_formatsarrayThe list of delivery destination output formats that are supported by this log source.
allowed_suffix_path_fieldsarrayThe list of variable fields that can be used in the suffix path of a delivery that delivers to an S3 bucket.
default_delivery_config_valuesobjectA mapping that displays the default value of each property within a delivery's configuration, if it is not specified in the request.
delivery_destination_typestringA string specifying which destination type this configuration template applies to. (S3, CWL, FH, XRAY)
delivery_source_configurationarrayThe 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_typestringA string specifying which log type this configuration template applies to. (pattern: <code>[\w]*</code>)
resource_typestringA string specifying which resource type this configuration template applies to. (pattern: <code>[\w-_]*</code>)
s_3_tables_integrationobjectThe S3 Tables integration configuration for this configuration template, including the datasource name and type.
servicestringA string specifying which service this configuration template applies to. For more information about supported services see Enable logging from Amazon Web Services services.. (pattern: <code>[\w_-]*</code>)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_configuration_templatesselectregionUse this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries. For more information about deliveries, see CreateDelivery.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries. For more information about deliveries, see CreateDelivery.

SELECT
allowed_action_for_allow_vended_logs_delivery_for_resource,
allowed_field_delimiters,
allowed_fields,
allowed_output_formats,
allowed_suffix_path_fields,
default_delivery_config_values,
delivery_destination_type,
delivery_source_configuration,
log_type,
resource_type,
s_3_tables_integration,
service
FROM aws.logs.configuration_templates
WHERE region = '{{ region }}' -- required
;