mail_manager_archives

Creates, updates, deletes or gets a mail_manager_archive resource or lists mail_manager_archives in a region

Overview

Name	mail_manager_archives
Type	Resource
Description	Definition of AWS::SES::MailManagerArchive Resource Type
Id	awscc.ses.mail_manager_archives

Fields

get (all properties)

Name	Datatype	Description
archive_arn	string
archive_id	string
archive_name	string
archive_state	string
kms_key_arn	string
retention	object
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
archive_id	string
region	string	AWS region.

For more information, see AWS::SES::MailManagerArchive.

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual mail_manager_archive.

SELECT
  region,
  archive_arn,
  archive_id,
  archive_name,
  archive_state,
  kms_key_arn,
  retention,
  tags
FROM awscc.ses.mail_manager_archives
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ archive_id }}';

list (identifiers only)

Lists all mail_manager_archives in a region.

SELECT
  region,
  archive_id
FROM awscc.ses.mail_manager_archives_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ses.mail_manager_archives (
  ArchiveName,
  KmsKeyArn,
  Retention,
  Tags,
  region
)
SELECT
  '{{ archive_name }}',
  '{{ kms_key_arn }}',
  '{{ retention }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ses.mail_manager_archives (
  ArchiveName,
  KmsKeyArn,
  Retention,
  Tags,
  region
)
SELECT
  '{{ archive_name }}',
  '{{ kms_key_arn }}',
  '{{ retention }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: mail_manager_archive
  props:
    - name: archive_name
      value: '{{ archive_name }}'
    - name: kms_key_arn
      value: '{{ kms_key_arn }}'
    - name: retention
      value: null
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ses.mail_manager_archives
SET PatchDocument = string('{{ {
    "ArchiveName": archive_name,
    "Retention": retention,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ archive_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ses.mail_manager_archives
WHERE
  Identifier = '{{ archive_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

ses:TagResource,
ses:ListTagsForResource,
ses:GetArchive,
ses:CreateArchive,
kms:DescribeKey,
kms:Decrypt,
kms:GenerateDataKey

Read

ses:ListTagsForResource,
ses:GetArchive

Update

ses:TagResource,
ses:UntagResource,
ses:ListTagsForResource,
ses:GetArchive,
ses:UpdateArchive

Delete

ses:GetArchive,
ses:DeleteArchive

List

ses:ListArchives