deliveries

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

Overview

Name	`deliveries`
Type	Resource
Id	`aws.logs.deliveries`

Fields

The following fields are returned by SELECT queries:

get_delivery
describe_deliveries

Name	Datatype	Description
`id`	`string`	The unique ID that identifies this delivery in your account. (pattern: <code>^[0-9A-Za-z]+$</code>)
`arn`	`string`	The Amazon Resource Name (ARN) that uniquely identifies this delivery.
`delivery_destination_arn`	`string`	The ARN of the delivery destination that is associated with this delivery.
`delivery_destination_type`	`string`	Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, Firehose, or X-Ray. (S3, CWL, FH, XRAY)
`delivery_source_name`	`string`	The name of the delivery source that is associated with this delivery. (pattern: <code>[\w-]*</code>)
`field_delimiter`	`string`	The field delimiter that is used between record fields when the final output format of a delivery is in Plain, W3C, or Raw format.
`record_fields`	`array`	The record fields used in this delivery.
`s_3_delivery_configuration`	`object`	This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.
`tags`	`object`	The tags that have been assigned to this delivery.

Name	Datatype	Description
`id`	`string`	The unique ID that identifies this delivery in your account. (pattern: <code>^[0-9A-Za-z]+$</code>)
`arn`	`string`	The Amazon Resource Name (ARN) that uniquely identifies this delivery.
`delivery_destination_arn`	`string`	The ARN of the delivery destination that is associated with this delivery.
`delivery_destination_type`	`string`	Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, Firehose, or X-Ray. (S3, CWL, FH, XRAY)
`delivery_source_name`	`string`	The name of the delivery source that is associated with this delivery. (pattern: <code>[\w-]*</code>)
`field_delimiter`	`string`	The field delimiter that is used between record fields when the final output format of a delivery is in Plain, W3C, or Raw format.
`record_fields`	`array`	The record fields used in this delivery.
`s_3_delivery_configuration`	`object`	This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.
`tags`	`object`	The tags that have been assigned to this delivery.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`get_delivery`	`select`	`region`	Returns complete information about one logical delivery. A delivery is a connection between a delivery source and a delivery destination . A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services. You need to specify the delivery id in this operation. You can find the IDs of the deliveries in your account with the DescribeDeliveries operation.
`describe_deliveries`	`select`	`region`	Retrieves a list of the deliveries that have been created in the account. A delivery is a connection between a delivery source and a delivery destination . A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, Firehose or X-Ray. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.
`create_delivery`	`insert`	`region`, `deliverySourceName`, `deliveryDestinationArn`	Creates a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination that you have already created. Only some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services. A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, a delivery stream in Firehose, or X-Ray. 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. Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination. 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. 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. To update an existing delivery configuration, use UpdateDeliveryConfiguration.
`update_delivery_configuration`	`update`	`region`, `id`	Use this operation to update the configuration of a delivery to change either the S3 path pattern or the format of the delivered logs. You can't use this operation to change the source or destination of the delivery.
`delete_delivery`	`delete`	`region`	Deletes a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does not delete the delivery destination or the delivery source.

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
describe_deliveries

Returns complete information about one logical delivery. A delivery is a connection between a delivery source and a delivery destination . A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services. You need to specify the delivery id in this operation. You can find the IDs of the deliveries in your account with the DescribeDeliveries operation.

SELECT
id,
arn,
delivery_destination_arn,
delivery_destination_type,
delivery_source_name,
field_delimiter,
record_fields,
s_3_delivery_configuration,
tags
FROM aws.logs.deliveries
WHERE region = '{{ region }}' -- required
;

Retrieves a list of the deliveries that have been created in the account. A delivery is a connection between a delivery source and a delivery destination . A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, Firehose or X-Ray. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.

SELECT
id,
arn,
delivery_destination_arn,
delivery_destination_type,
delivery_source_name,
field_delimiter,
record_fields,
s_3_delivery_configuration,
tags
FROM aws.logs.deliveries
WHERE region = '{{ region }}' -- required
;

`INSERT` examples

create_delivery
Manifest

Creates a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination that you have already created. Only some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services. A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, a delivery stream in Firehose, or X-Ray. 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. Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination. 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. 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. To update an existing delivery configuration, use UpdateDeliveryConfiguration.

INSERT INTO aws.logs.deliveries (
deliverySourceName,
deliveryDestinationArn,
recordFields,
fieldDelimiter,
s3DeliveryConfiguration,
tags,
region
)
SELECT 
'{{ deliverySourceName }}' /* required */,
'{{ deliveryDestinationArn }}' /* required */,
'{{ recordFields }}',
'{{ fieldDelimiter }}',
'{{ s3DeliveryConfiguration }}',
'{{ tags }}',
'{{ region }}'
RETURNING
delivery
;

# Description fields are for documentation purposes
- name: deliveries
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the deliveries resource.
  - name: deliverySourceName
    value: "{{ deliverySourceName }}"
    description: |
      The name of the delivery source to use for this delivery.
  - name: deliveryDestinationArn
    value: "{{ deliveryDestinationArn }}"
    description: |
      The ARN of the delivery destination to use for this delivery.
  - name: recordFields
    value:
      - "{{ recordFields }}"
    description: |
      The list of record fields to be delivered to the destination, in order. If the delivery's log source has mandatory fields, they must be included in this list.
  - name: fieldDelimiter
    value: "{{ fieldDelimiter }}"
    description: |
      The field delimiter to use between record fields when the final output format of a delivery is in Plain, W3C, or Raw format.
  - name: s3DeliveryConfiguration
    description: |
      This structure contains parameters that are valid only when the delivery's delivery destination is an S3 bucket.
    value:
      suffixPath: "{{ suffixPath }}"
      enableHiveCompatiblePath: {{ enableHiveCompatiblePath }}
  - name: tags
    value: "{{ tags }}"
    description: |
      An optional list of key-value pairs to associate with the resource. For more information about tagging, see Tagging Amazon Web Services resources

`UPDATE` examples

update_delivery_configuration

Use this operation to update the configuration of a delivery to change either the S3 path pattern or the format of the delivered logs. You can't use this operation to change the source or destination of the delivery.

UPDATE aws.logs.deliveries
SET 
id = '{{ id }}',
recordFields = '{{ recordFields }}',
fieldDelimiter = '{{ fieldDelimiter }}',
s3DeliveryConfiguration = '{{ s3DeliveryConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND id = '{{ id }}' --required;

`DELETE` examples

delete_delivery

Deletes a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does not delete the delivery destination or the delivery source.

DELETE FROM aws.logs.deliveries
WHERE region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​