delivery_destinations

Creates, updates, deletes or gets a delivery_destination resource or lists delivery_destinations in a region

Overview

Name	delivery_destinations
Type	Resource
Description	This structure contains information about one delivery destination in your account. A delivery destination is an AWS resource that represents an AWS service that logs can be sent to CloudWatch Logs, Amazon S3, are supported as Kinesis Data Firehose delivery destinations.
Id	awscc.logs.delivery_destinations

Fields

get (all properties)

Name	Datatype	Description
name	string	The name of this delivery destination.
arn	string	The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
▶tags	array	The tags that have been assigned to this delivery destination.
delivery_destination_type	string	Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
▶delivery_destination_policy	object	IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account.<br />The policy must be in JSON string format.<br />Length Constraints: Maximum length of 51200
output_format	string	The format of the logs that are sent to this delivery destination.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	The name of this delivery destination.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	delivery_destinations	INSERT	Name, region
delete_resource	delivery_destinations	DELETE	Identifier, region
update_resource	delivery_destinations	UPDATE	Identifier, PatchDocument, region
list_resources	delivery_destinations_list_only	SELECT	region
get_resource	delivery_destinations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual delivery_destination.

SELECT
  region,
  name,
  arn,
  destination_resource_arn,
  tags,
  delivery_destination_type,
  delivery_destination_policy,
  output_format
FROM awscc.logs.delivery_destinations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all delivery_destinations in a region.

SELECT
  region,
  name
FROM awscc.logs.delivery_destinations_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.logs.delivery_destinations (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.logs.delivery_destinations (
  Name,
  DestinationResourceArn,
  Tags,
  DeliveryDestinationPolicy,
  OutputFormat,
  region
)
SELECT
  '{{ name }}',
  '{{ destination_resource_arn }}',
  '{{ tags }}',
  '{{ delivery_destination_policy }}',
  '{{ output_format }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: delivery_destination
    props:
      - name: name
        value: '{{ name }}'
      - name: destination_resource_arn
        value: '{{ destination_resource_arn }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: delivery_destination_policy
        value:
          delivery_destination_name: '{{ delivery_destination_name }}'
          delivery_destination_policy: {}
      - name: output_format
        value: '{{ output_format }}'

UPDATE example

Use the following StackQL query and manifest file to update a delivery_destination resource, using stack-deploy.

/*+ update */
UPDATE awscc.logs.delivery_destinations
SET PatchDocument = string('{{ {
    "Tags": tags,
    "DeliveryDestinationPolicy": delivery_destination_policy
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.logs.delivery_destinations
WHERE
  Identifier = '{{ name }}' AND
  region = 'us-east-1';

Permissions

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

Create

logs:PutDeliveryDestination,
logs:GetDeliveryDestination,
logs:ListTagsForResource,
logs:TagResource,
logs:UntagResource,
logs:PutDeliveryDestinationPolicy,
logs:GetDeliveryDestinationPolicy

Read

logs:GetDeliveryDestination,
logs:ListTagsForResource,
logs:GetDeliveryDestinationPolicy

Update

logs:PutDeliveryDestination,
logs:GetDeliveryDestination,
logs:ListTagsForResource,
logs:TagResource,
logs:UntagResource,
logs:DeleteDeliveryDestinationPolicy,
logs:PutDeliveryDestinationPolicy,
logs:GetDeliveryDestinationPolicy

Delete

logs:DeleteDeliveryDestination,
logs:DeleteDeliveryDestinationPolicy

List

logs:DescribeDeliveryDestinations,
logs:GetDeliveryDestinationPolicy