archives

Creates, updates, deletes or gets an archive resource or lists archives in a region

Overview

Name	archives
Type	Resource
Description	Resource Type definition for AWS::Events::Archive
Id	awscc.events.archives

Fields

get (all properties)

Name	Datatype	Description
archive_name	string
source_arn	string
description	string
event_pattern	object
arn	string
retention_days	integer
kms_key_identifier	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
archive_name	string
region	string	AWS region.

For more information, see AWS::Events::Archive.

Methods

Name	Resource	Accessible by	Required Params
create_resource	archives	INSERT	SourceArn, region
delete_resource	archives	DELETE	Identifier, region
update_resource	archives	UPDATE	Identifier, PatchDocument, region
list_resources	archives_list_only	SELECT	region
get_resource	archives	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual archive.

SELECT
  region,
  archive_name,
  source_arn,
  description,
  event_pattern,
  arn,
  retention_days,
  kms_key_identifier
FROM awscc.events.archives
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ archive_name }}';

list (identifiers only)

Lists all archives in a region.

SELECT
  region,
  archive_name
FROM awscc.events.archives_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.events.archives (
  SourceArn,
  region
)
SELECT
  '{{ source_arn }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.events.archives (
  ArchiveName,
  SourceArn,
  Description,
  EventPattern,
  RetentionDays,
  KmsKeyIdentifier,
  region
)
SELECT
  '{{ archive_name }}',
  '{{ source_arn }}',
  '{{ description }}',
  '{{ event_pattern }}',
  '{{ retention_days }}',
  '{{ kms_key_identifier }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: archive
    props:
      - name: archive_name
        value: '{{ archive_name }}'
      - name: source_arn
        value: '{{ source_arn }}'
      - name: description
        value: '{{ description }}'
      - name: event_pattern
        value: {}
      - name: retention_days
        value: '{{ retention_days }}'
      - name: kms_key_identifier
        value: '{{ kms_key_identifier }}'

UPDATE example

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

/*+ update */
UPDATE awscc.events.archives
SET PatchDocument = string('{{ {
    "Description": description,
    "EventPattern": event_pattern,
    "RetentionDays": retention_days,
    "KmsKeyIdentifier": kms_key_identifier
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ archive_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.events.archives
WHERE
  Identifier = '{{ archive_name }}' AND
  region = 'us-east-1';

Permissions

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

Create

events:DescribeArchive,
events:CreateArchive,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

Delete

events:DescribeArchive,
events:DeleteArchive

List

events:ListArchives

Update

events:DescribeArchive,
events:UpdateArchive,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt,
kms:ReEncryptTo,
kms:ReEncryptFrom

Read

events:DescribeArchive,
kms:Decrypt