delivery_channels

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

Overview

Name	delivery_channels
Type	Resource
Id	aws.config.delivery_channels

Fields

The following fields are returned by SELECT queries:

describe_delivery_channels

Name	Datatype	Description
delivery_channels	array	A list that contains the descriptions of the specified delivery channel.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_delivery_channels	select	region		Returns details about the specified delivery channel. If a delivery channel is not specified, this operation returns the details of all delivery channels associated with the account. Currently, you can specify only one delivery channel per region in your account.
put_delivery_channel	replace	region, DeliveryChannel		Creates or updates a delivery channel to deliver configuration information and other compliance information. You can use this operation to create a new delivery channel or to update the Amazon S3 bucket and the Amazon SNS topic of an existing delivery channel. For more information, see Working with the Delivery Channel in the Config Developer Guide. One delivery channel per account per Region You can have only one delivery channel for each account for each Amazon Web Services Region.
delete_delivery_channel	delete	region		Deletes the delivery channel. Before you can delete the delivery channel, you must stop the customer managed configuration recorder. You can use the StopConfigurationRecorder operation to stop the customer managed configuration recorder.
deliver_config_snapshot	exec	region		Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, Config sends the following notifications using an Amazon SNS topic that you have specified. Notification of the start of the delivery. Notification of the completion of the delivery, if the delivery was successfully completed. Notification of delivery failure, if the delivery failed.

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.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_delivery_channels

Returns details about the specified delivery channel. If a delivery channel is not specified, this operation returns the details of all delivery channels associated with the account. Currently, you can specify only one delivery channel per region in your account.

SELECT
delivery_channels
FROM aws.config.delivery_channels
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_delivery_channel

Creates or updates a delivery channel to deliver configuration information and other compliance information. You can use this operation to create a new delivery channel or to update the Amazon S3 bucket and the Amazon SNS topic of an existing delivery channel. For more information, see Working with the Delivery Channel in the Config Developer Guide. One delivery channel per account per Region You can have only one delivery channel for each account for each Amazon Web Services Region.

REPLACE aws.config.delivery_channels
SET 
DeliveryChannel = '{{ DeliveryChannel }}'
WHERE 
region = '{{ region }}' --required
AND DeliveryChannel = '{{ DeliveryChannel }}' --required;

DELETE examples

delete_delivery_channel

Deletes the delivery channel. Before you can delete the delivery channel, you must stop the customer managed configuration recorder. You can use the StopConfigurationRecorder operation to stop the customer managed configuration recorder.

DELETE FROM aws.config.delivery_channels
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

deliver_config_snapshot

Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, Config sends the following notifications using an Amazon SNS topic that you have specified. Notification of the start of the delivery. Notification of the completion of the delivery, if the delivery was successfully completed. Notification of delivery failure, if the delivery failed.

EXEC aws.config.delivery_channels.deliver_config_snapshot 
@region='{{ region }}' --required 
@@json=
'{
"deliveryChannelName": "{{ deliveryChannelName }}"
}'
;