contact_lists

Creates, updates, deletes or gets a contact_list resource or lists contact_lists in a region

Overview

Name	contact_lists
Type	Resource
Description	Resource schema for AWS::SES::ContactList.
Id	awscc.ses.contact_lists

Fields

get (all properties)

Name	Datatype	Description
contact_list_name	string	The name of the contact list.
description	string	The description of the contact list.
▶topics	array	The topics associated with the contact list.
▶tags	array	The tags (keys and values) associated with the contact list.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
contact_list_name	string	The name of the contact list.
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual contact_list.

SELECT
  region,
  contact_list_name,
  description,
  topics,
  tags
FROM awscc.ses.contact_lists
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ contact_list_name }}';

list (identifiers only)

Lists all contact_lists in a region.

SELECT
  region,
  contact_list_name
FROM awscc.ses.contact_lists_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ses.contact_lists (
  ContactListName,
  Description,
  Topics,
  Tags,
  region
)
SELECT
  '{{ contact_list_name }}',
  '{{ description }}',
  '{{ topics }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ses.contact_lists (
  ContactListName,
  Description,
  Topics,
  Tags,
  region
)
SELECT
  '{{ contact_list_name }}',
  '{{ description }}',
  '{{ topics }}',
  '{{ 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: contact_list
  props:
    - name: contact_list_name
      value: '{{ contact_list_name }}'
    - name: description
      value: '{{ description }}'
    - name: topics
      value:
        - topic_name: '{{ topic_name }}'
          display_name: '{{ display_name }}'
          description: '{{ description }}'
          default_subscription_status: '{{ default_subscription_status }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ses.contact_lists
SET PatchDocument = string('{{ {
    "Description": description,
    "Topics": topics,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ contact_list_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ses.contact_lists
WHERE
  Identifier = '{{ contact_list_name }}' 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 contact_lists resource, the following permissions are required:

Create

ses:CreateContactList,
ses:UntagResource,
ses:TagResource,
ses:GetContactList

Read

ses:GetContactList,
ses:ListTagsForResource

Update

ses:UpdateContactList,
ses:UntagResource,
ses:TagResource,
ses:GetContactList

Delete

ses:DeleteContactList,
ses:GetContactList

List

ses:ListContactLists