delivery_destinations
Creates, updates, deletes, gets or lists a delivery_destinations resource.
Overview
| Name | delivery_destinations |
| Type | Resource |
| Id | aws.logs.delivery_destinations |
Fields
The following fields are returned by SELECT queries:
- get_delivery_destination
- describe_delivery_destinations
| Name | Datatype | Description |
|---|---|---|
name | string | The name of this delivery destination. (pattern: <code>[\w-]*</code>) |
arn | string | The Amazon Resource Name (ARN) that uniquely identifies this delivery destination. |
delivery_destination_configuration | object | A structure that contains the ARN of the Amazon Web Services resource that will receive the logs. |
delivery_destination_type | string | Displays whether this delivery destination is CloudWatch Logs, Amazon S3, Firehose, or X-Ray. (S3, CWL, FH, XRAY) |
output_format | string | The format of the logs that are sent to this delivery destination. (json, plain, w3c, raw, parquet) |
tags | object | The tags that have been assigned to this delivery destination. |
| Name | Datatype | Description |
|---|---|---|
name | string | The name of this delivery destination. (pattern: <code>[\w-]*</code>) |
arn | string | The Amazon Resource Name (ARN) that uniquely identifies this delivery destination. |
delivery_destination_configuration | object | A structure that contains the ARN of the Amazon Web Services resource that will receive the logs. |
delivery_destination_type | string | Displays whether this delivery destination is CloudWatch Logs, Amazon S3, Firehose, or X-Ray. (S3, CWL, FH, XRAY) |
output_format | string | The format of the logs that are sent to this delivery destination. (json, plain, w3c, raw, parquet) |
tags | object | The tags that have been assigned to this delivery destination. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_delivery_destination | select | region | Retrieves complete information about one delivery destination. | |
describe_delivery_destinations | select | region | Retrieves a list of the delivery destinations that have been created in the account. | |
put_delivery_destination | replace | region, name | Creates or updates a logical delivery destination. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are supported as logs delivery destinations and X-Ray as the trace delivery destination. To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following: Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource. Use PutDeliveryDestination to create a delivery destination in the same account of the actual delivery destination. The delivery destination that you create is a logical object that represents the actual delivery destination. If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination. Use CreateDelivery to create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery. You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination. Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services. If you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten with the new parameter values that you specify. | |
delete_delivery_destination | delete | region | Deletes a delivery destination. A delivery is a connection between a logical delivery source and a logical delivery destination. You can't delete a delivery destination if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery destination, use the DescribeDeliveries operation and check the deliveryDestinationArn field in the results. |
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
- get_delivery_destination
- describe_delivery_destinations
Retrieves complete information about one delivery destination.
SELECT
name,
arn,
delivery_destination_configuration,
delivery_destination_type,
output_format,
tags
FROM aws.logs.delivery_destinations
WHERE region = '{{ region }}' -- required
;
Retrieves a list of the delivery destinations that have been created in the account.
SELECT
name,
arn,
delivery_destination_configuration,
delivery_destination_type,
output_format,
tags
FROM aws.logs.delivery_destinations
WHERE region = '{{ region }}' -- required
;
REPLACE examples
- put_delivery_destination
Creates or updates a logical delivery destination. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are supported as logs delivery destinations and X-Ray as the trace delivery destination. To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following: Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource. Use PutDeliveryDestination to create a delivery destination in the same account of the actual delivery destination. The delivery destination that you create is a logical object that represents the actual delivery destination. If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination. Use CreateDelivery to create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery. You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination. Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services. If you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten with the new parameter values that you specify.
REPLACE aws.logs.delivery_destinations
SET
name = '{{ name }}',
outputFormat = '{{ outputFormat }}',
deliveryDestinationConfiguration = '{{ deliveryDestinationConfiguration }}',
deliveryDestinationType = '{{ deliveryDestinationType }}',
tags = '{{ tags }}'
WHERE
region = '{{ region }}' --required
AND name = '{{ name }}' --required
RETURNING
delivery_destination;
DELETE examples
- delete_delivery_destination
Deletes a delivery destination. A delivery is a connection between a logical delivery source and a logical delivery destination. You can't delete a delivery destination if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery destination, use the DescribeDeliveries operation and check the deliveryDestinationArn field in the results.
DELETE FROM aws.logs.delivery_destinations
WHERE region = '{{ region }}' --required
;