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

Fields

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
region	string	AWS region.

Methods

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

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
FROM aws.ses.email_identities
WHERE region = 'us-east-1';

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
FROM aws.ses.email_identities
WHERE region = 'us-east-1' AND data__Identifier = '<EmailIdentity>';

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 aws.ses.email_identities (
 EmailIdentity,
 region
)
SELECT 
'{{ EmailIdentity }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ses.email_identities (
 EmailIdentity,
 ConfigurationSetAttributes,
 DkimSigningAttributes,
 DkimAttributes,
 MailFromAttributes,
 FeedbackAttributes,
 region
)
SELECT 
 '{{ EmailIdentity }}',
 '{{ ConfigurationSetAttributes }}',
 '{{ DkimSigningAttributes }}',
 '{{ DkimAttributes }}',
 '{{ MailFromAttributes }}',
 '{{ FeedbackAttributes }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: email_identity
    props:
      - name: EmailIdentity
        value: '{{ EmailIdentity }}'
      - name: ConfigurationSetAttributes
        value:
          ConfigurationSetName: '{{ ConfigurationSetName }}'
      - name: DkimSigningAttributes
        value:
          DomainSigningSelector: '{{ DomainSigningSelector }}'
          DomainSigningPrivateKey: '{{ DomainSigningPrivateKey }}'
          NextSigningKeyLength: '{{ NextSigningKeyLength }}'
      - name: DkimAttributes
        value:
          SigningEnabled: '{{ SigningEnabled }}'
      - name: MailFromAttributes
        value:
          MailFromDomain: '{{ MailFromDomain }}'
          BehaviorOnMxFailure: '{{ BehaviorOnMxFailure }}'
      - name: FeedbackAttributes
        value:
          EmailForwardingEnabled: '{{ EmailForwardingEnabled }}'

DELETE example

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

Permissions

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

Create

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

Read

ses:GetEmailIdentity

Update

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

Delete

ses:DeleteEmailIdentity

List

ses:ListEmailIdentities