email_addresses

Creates, updates, deletes or gets an email_address resource or lists email_addresses in a region

Overview

Name	email_addresses
Type	Resource
Description	Resource Type definition for AWS::Connect::EmailAddress
Id	aws.connect.email_addresses

Fields

Name	Datatype	Description
instance_arn	string	The identifier of the Amazon Connect instance.
email_address_arn	string	The identifier of the email address.
description	string	A description for the email address.
email_address	string	Email address to be created for this instance
display_name	string	The display name for the email address.
tags	array	One or more tags.
region	string	AWS region.

For more information, see AWS::Connect::EmailAddress.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	InstanceArn, EmailAddress, 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 email_addresses in a region.

SELECT
region,
instance_arn,
email_address_arn,
description,
email_address,
display_name,
tags
FROM aws.connect.email_addresses
WHERE region = 'us-east-1';

Gets all properties from an individual email_address.

SELECT
region,
instance_arn,
email_address_arn,
description,
email_address,
display_name,
tags
FROM aws.connect.email_addresses
WHERE region = 'us-east-1' AND data__Identifier = '<EmailAddressArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.connect.email_addresses (
 InstanceArn,
 EmailAddress,
 region
)
SELECT 
'{{ InstanceArn }}',
 '{{ EmailAddress }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.connect.email_addresses (
 InstanceArn,
 Description,
 EmailAddress,
 DisplayName,
 Tags,
 region
)
SELECT 
 '{{ InstanceArn }}',
 '{{ Description }}',
 '{{ EmailAddress }}',
 '{{ DisplayName }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: email_address
    props:
      - name: InstanceArn
        value: '{{ InstanceArn }}'
      - name: Description
        value: '{{ Description }}'
      - name: EmailAddress
        value: '{{ EmailAddress }}'
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.connect.email_addresses
WHERE data__Identifier = '<EmailAddressArn>'
AND region = 'us-east-1';

Permissions

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

Create

connect:CreateEmailAddress,
connect:TagResource,
connect:ListIntegrationAssociations,
ses:GetEmailIdentity,
ses:DescribeReceiptRule,
ses:UpdateReceiptRule,
iam:PassRole

Read

connect:DescribeEmailAddress

Update

connect:UpdateEmailAddressMetadata,
connect:TagResource,
connect:UntagResource

Delete

connect:DeleteEmailAddress,
connect:UntagResource,
iam:PassRole,
ses:DescribeReceiptRule,
ses:UpdateReceiptRule

List

connect:DescribeEmailAddress,
connect:SearchEmailAddresses