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	awscc.connect.email_addresses

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
email_address_arn	string	The identifier of the email address.
email_address	string	Email address to be created for this instance
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	email_addresses	INSERT	InstanceArn, EmailAddress, region
delete_resource	email_addresses	DELETE	Identifier, region
update_resource	email_addresses	UPDATE	Identifier, PatchDocument, region
list_resources	email_addresses_list_only	SELECT	region
get_resource	email_addresses	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual email_address.

SELECT
  region,
  instance_arn,
  email_address_arn,
  description,
  email_address,
  display_name,
  tags
FROM awscc.connect.email_addresses
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ email_address_arn }}';

list (identifiers only)

Lists all email_addresses in a region.

SELECT
  region,
  email_address_arn
FROM awscc.connect.email_addresses_list_only
WHERE
  region = '{{ region }}';

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 awscc.connect.email_addresses (
  InstanceArn,
  EmailAddress,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ email_address }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.connect.email_addresses (
  InstanceArn,
  Description,
  EmailAddress,
  DisplayName,
  Tags,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ description }}',
  '{{ email_address }}',
  '{{ display_name }}',
  '{{ 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: email_address
  props:
    - name: instance_arn
      value: '{{ instance_arn }}'
    - name: description
      value: '{{ description }}'
    - name: email_address
      value: '{{ email_address }}'
    - name: display_name
      value: '{{ display_name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.connect.email_addresses
SET PatchDocument = string('{{ {
    "InstanceArn": instance_arn,
    "Description": description,
    "DisplayName": display_name,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ email_address_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.connect.email_addresses
WHERE
  Identifier = '{{ email_address_arn }}' 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 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