email_contacts

Creates, updates, deletes or gets an email_contact resource or lists email_contacts in a region

Overview

Name	email_contacts
Type	Resource
Description	Definition of AWS::NotificationsContacts::EmailContact Resource Type
Id	awscc.notificationscontacts.email_contacts

Fields

get (all properties)

Name	Datatype	Description
arn	string
email_address	string
name	string
▶email_contact	object	Definition of AWS::NotificationsContacts::EmailContact Resource Type
▶tags	array	A list of tags that are attached to the role.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

For more information, see AWS::NotificationsContacts::EmailContact.

Methods

Name	Resource	Accessible by	Required Params
create_resource	email_contacts	INSERT	EmailAddress, Name, region
delete_resource	email_contacts	DELETE	Identifier, region
list_resources	email_contacts_list_only	SELECT	region
get_resource	email_contacts	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual email_contact.

SELECT
  region,
  arn,
  email_address,
  name,
  email_contact,
  tags
FROM awscc.notificationscontacts.email_contacts
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all email_contacts in a region.

SELECT
  region,
  arn
FROM awscc.notificationscontacts.email_contacts_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.notificationscontacts.email_contacts (
  EmailAddress,
  Name,
  region
)
SELECT
  '{{ email_address }}',
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.notificationscontacts.email_contacts (
  EmailAddress,
  Name,
  Tags,
  region
)
SELECT
  '{{ email_address }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: email_contact
    props:
      - name: email_address
        value: '{{ email_address }}'
      - name: name
        value: '{{ name }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.notificationscontacts.email_contacts
WHERE
  Identifier = '{{ arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

notifications-contacts:CreateEmailContact,
notifications-contacts:GetEmailContact,
notifications-contacts:SendActivationCode,
notifications-contacts:ListEmailContacts,
notifications-contacts:TagResource,
notifications-contacts:UntagResource,
notifications-contacts:ListTagsForResource

Read

notifications-contacts:GetEmailContact,
notifications-contacts:ListTagsForResource,
notifications-contacts:TagResource

Delete

notifications-contacts:DeleteEmailContact,
notifications-contacts:GetEmailContact

List

notifications-contacts:ListEmailContacts