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 = 'us-east-1' 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 = 'us-east-1';

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 }}';

All Properties

/*+ create */
INSERT INTO awscc.ses.contact_lists (
  ContactListName,
  Description,
  Topics,
  Tags,
  region
)
SELECT
  '{{ contact_list_name }}',
  '{{ description }}',
  '{{ topics }}',
  '{{ tags }}',
  '{{ region }}';

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 }}';

DELETE example

/*+ delete */
DELETE FROM awscc.ses.contact_lists
WHERE
  Identifier = '{{ contact_list_name }}' AND
  region = 'us-east-1';

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