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	aws.ses.contact_lists

Fields

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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all contact_lists in a region.

SELECT
region,
contact_list_name,
description,
topics,
tags
FROM aws.ses.contact_lists
WHERE region = 'us-east-1';

Gets all properties from an individual contact_list.

SELECT
region,
contact_list_name,
description,
topics,
tags
FROM aws.ses.contact_lists
WHERE region = 'us-east-1' AND data__Identifier = '<ContactListName>';

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 aws.ses.contact_lists (
 ContactListName,
 Description,
 Topics,
 Tags,
 region
)
SELECT 
'{{ ContactListName }}',
 '{{ Description }}',
 '{{ Topics }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ses.contact_lists (
 ContactListName,
 Description,
 Topics,
 Tags,
 region
)
SELECT 
 '{{ ContactListName }}',
 '{{ 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: ContactListName
        value: '{{ ContactListName }}'
      - name: Description
        value: '{{ Description }}'
      - name: Topics
        value:
          - TopicName: '{{ TopicName }}'
            DisplayName: '{{ DisplayName }}'
            Description: '{{ Description }}'
            DefaultSubscriptionStatus: '{{ DefaultSubscriptionStatus }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.ses.contact_lists
WHERE data__Identifier = '<ContactListName>'
AND region = 'us-east-1';

Permissions

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

Create

ses:CreateContactList

Read

ses:GetContactList

Update

ses:UpdateContactList,
ses:UntagResource,
ses:TagResource

Delete

ses:DeleteContactList

List

ses:ListContactLists