deliveries

Creates, updates, deletes or gets a delivery resource or lists deliveries in a region

Overview

Name	deliveries
Type	Resource
Description	This structure contains information about one delivery in your account. A delivery is a connection between a logical delivery source and a logical delivery destination. For more information, see [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html).
Id	aws.logs.deliveries

Fields

Name	Datatype	Description
delivery_id	string	The unique ID that identifies this delivery in your account.
arn	string	The Amazon Resource Name (ARN) that uniquely identifies this delivery.
delivery_source_name	string	The name of the delivery source that is associated with 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, or Kinesis Data Firehose.
tags	array	The tags that have been assigned to this delivery.
record_fields	array	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.
field_delimiter	string	The field delimiter to use between record fields when the final output format of a delivery is in Plain , W3C , or Raw format.
s3_suffix_path	string	This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.
s3_enable_hive_compatible_path	boolean	This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.
region	string	AWS region.

For more information, see AWS::Logs::Delivery.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DeliverySourceName, DeliveryDestinationArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all deliveries in a region.

SELECT
region,
delivery_id,
arn,
delivery_source_name,
delivery_destination_arn,
delivery_destination_type,
tags,
record_fields,
field_delimiter,
s3_suffix_path,
s3_enable_hive_compatible_path
FROM aws.logs.deliveries
WHERE region = 'us-east-1';

Gets all properties from an individual delivery.

SELECT
region,
delivery_id,
arn,
delivery_source_name,
delivery_destination_arn,
delivery_destination_type,
tags,
record_fields,
field_delimiter,
s3_suffix_path,
s3_enable_hive_compatible_path
FROM aws.logs.deliveries
WHERE region = 'us-east-1' AND data__Identifier = '<DeliveryId>';

INSERT example

Use the following StackQL query and manifest file to create a new delivery resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.logs.deliveries (
 DeliverySourceName,
 DeliveryDestinationArn,
 region
)
SELECT 
'{{ DeliverySourceName }}',
 '{{ DeliveryDestinationArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.logs.deliveries (
 DeliverySourceName,
 DeliveryDestinationArn,
 Tags,
 RecordFields,
 FieldDelimiter,
 S3SuffixPath,
 S3EnableHiveCompatiblePath,
 region
)
SELECT 
 '{{ DeliverySourceName }}',
 '{{ DeliveryDestinationArn }}',
 '{{ Tags }}',
 '{{ RecordFields }}',
 '{{ FieldDelimiter }}',
 '{{ S3SuffixPath }}',
 '{{ S3EnableHiveCompatiblePath }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: delivery
    props:
      - name: DeliverySourceName
        value: '{{ DeliverySourceName }}'
      - name: DeliveryDestinationArn
        value: '{{ DeliveryDestinationArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: RecordFields
        value:
          - '{{ RecordFields[0] }}'
      - name: FieldDelimiter
        value: '{{ FieldDelimiter }}'
      - name: S3SuffixPath
        value: '{{ S3SuffixPath }}'
      - name: S3EnableHiveCompatiblePath
        value: '{{ S3EnableHiveCompatiblePath }}'

DELETE example

/*+ delete */
DELETE FROM aws.logs.deliveries
WHERE data__Identifier = '<DeliveryId>'
AND region = 'us-east-1';

Permissions

To operate on the deliveries resource, the following permissions are required:

Create

logs:CreateDelivery,
logs:GetDelivery,
logs:DescribeDeliveries,
logs:ListTagsForResource,
logs:TagResource,
logs:GetDeliverySource,
logs:GetDeliveryDestination

Read

logs:GetDelivery,
logs:ListTagsForResource

Update

logs:GetDelivery,
logs:ListTagsForResource,
logs:TagResource,
logs:UntagResource

Delete

logs:DeleteDelivery,
logs:ListTagsForResource,
logs:UntagResource

List

logs:DescribeDeliveries,
logs:ListTagsForResource