email_identities

Creates, updates, deletes or gets an email_identity resource or lists email_identities in a region

Overview

Name	email_identities
Type	Resource
Description	Resource Type definition for AWS::SES::EmailIdentity
Id	awscc.ses.email_identities

Fields

get (all properties)

Name	Datatype	Description
email_identity	string	The email address or domain to verify.
▶configuration_set_attributes	object	Used to associate a configuration set with an email identity.
▶dkim_signing_attributes	object	If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM.
▶dkim_attributes	object	Used to enable or disable DKIM authentication for an email identity.
▶mail_from_attributes	object	Used to enable or disable the custom Mail-From domain configuration for an email identity.
▶feedback_attributes	object	Used to enable or disable feedback forwarding for an identity.
dkim_dns_token_name1	string
dkim_dns_token_name2	string
dkim_dns_token_name3	string
dkim_dns_token_value1	string
dkim_dns_token_value2	string
dkim_dns_token_value3	string
▶tags	array	The tags (keys and values) associated with the email identity.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
email_identity	string	The email address or domain to verify.
region	string	AWS region.

For more information, see AWS::SES::EmailIdentity.

Methods

Name	Resource	Accessible by	Required Params
create_resource	email_identities	INSERT	EmailIdentity, region
delete_resource	email_identities	DELETE	Identifier, region
update_resource	email_identities	UPDATE	Identifier, PatchDocument, region
list_resources	email_identities_list_only	SELECT	region
get_resource	email_identities	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual email_identity.

SELECT
  region,
  email_identity,
  configuration_set_attributes,
  dkim_signing_attributes,
  dkim_attributes,
  mail_from_attributes,
  feedback_attributes,
  dkim_dns_token_name1,
  dkim_dns_token_name2,
  dkim_dns_token_name3,
  dkim_dns_token_value1,
  dkim_dns_token_value2,
  dkim_dns_token_value3,
  tags
FROM awscc.ses.email_identities
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ email_identity }}';

list (identifiers only)

Lists all email_identities in a region.

SELECT
  region,
  email_identity
FROM awscc.ses.email_identities_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ses.email_identities (
  EmailIdentity,
  region
)
SELECT
  '{{ email_identity }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ses.email_identities (
  EmailIdentity,
  ConfigurationSetAttributes,
  DkimSigningAttributes,
  DkimAttributes,
  MailFromAttributes,
  FeedbackAttributes,
  Tags,
  region
)
SELECT
  '{{ email_identity }}',
  '{{ configuration_set_attributes }}',
  '{{ dkim_signing_attributes }}',
  '{{ dkim_attributes }}',
  '{{ mail_from_attributes }}',
  '{{ feedback_attributes }}',
  '{{ 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_identity
  props:
    - name: email_identity
      value: '{{ email_identity }}'
    - name: configuration_set_attributes
      value:
        configuration_set_name: '{{ configuration_set_name }}'
    - name: dkim_signing_attributes
      value:
        domain_signing_selector: '{{ domain_signing_selector }}'
        domain_signing_private_key: '{{ domain_signing_private_key }}'
        next_signing_key_length: '{{ next_signing_key_length }}'
    - name: dkim_attributes
      value:
        signing_enabled: '{{ signing_enabled }}'
    - name: mail_from_attributes
      value:
        mail_from_domain: '{{ mail_from_domain }}'
        behavior_on_mx_failure: '{{ behavior_on_mx_failure }}'
    - name: feedback_attributes
      value:
        email_forwarding_enabled: '{{ email_forwarding_enabled }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ses.email_identities
SET PatchDocument = string('{{ {
    "ConfigurationSetAttributes": configuration_set_attributes,
    "DkimSigningAttributes": dkim_signing_attributes,
    "DkimAttributes": dkim_attributes,
    "MailFromAttributes": mail_from_attributes,
    "FeedbackAttributes": feedback_attributes,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ email_identity }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ses.email_identities
WHERE
  Identifier = '{{ email_identity }}' 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_identities resource, the following permissions are required:

Create

ses:CreateEmailIdentity,
ses:PutEmailIdentityMailFromAttributes,
ses:PutEmailIdentityFeedbackAttributes,
ses:PutEmailIdentityDkimAttributes,
ses:GetEmailIdentity,
ses:TagResource,
ses:UntagResource

Read

ses:GetEmailIdentity

Update

ses:PutEmailIdentityMailFromAttributes,
ses:PutEmailIdentityFeedbackAttributes,
ses:PutEmailIdentityConfigurationSetAttributes,
ses:PutEmailIdentityDkimSigningAttributes,
ses:PutEmailIdentityDkimAttributes,
ses:GetEmailIdentity,
ses:TagResource,
ses:UntagResource

Delete

ses:DeleteEmailIdentity

List

ses:ListEmailIdentities