community.aws.aws_ses_identity – Manages SES email and domain identity

Note

This plugin is part of the community.aws collection (version 1.4.0).

To install it use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.aws_ses_identity.

New in version 1.0.0: of community.aws

Synopsis

  • This module allows the user to manage verified email and domain identity for SES.

  • This covers verifying and removing identities as well as setting up complaint, bounce and delivery notification settings.

Requirements

The below requirements are needed on the host that executes this module.

  • boto

  • boto3

  • botocore

  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
aws_access_key
string
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key
string
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
bounce_notifications
dictionary
Setup the SNS topic used to report bounce notifications.
If omitted, bounce notifications will not be delivered to a SNS topic.
If bounce notifications are not delivered to a SNS topic, feedback_forwarding must be enabled.
include_headers
boolean
    Choices:
  • no ←
  • yes
Whether or not to include headers when delivering to the SNS topic.
If topic is not specified this will have no impact, but the SES setting is updated even if there is no topic.
topic
string
The ARN of the topic to send notifications to.
If omitted, notifications will not be delivered to a SNS topic.
complaint_notifications
dictionary
Setup the SNS topic used to report complaint notifications.
If omitted, complaint notifications will not be delivered to a SNS topic.
If complaint notifications are not delivered to a SNS topic, feedback_forwarding must be enabled.
include_headers
boolean
    Choices:
  • no ←
  • yes
Whether or not to include headers when delivering to the SNS topic.
If topic is not specified this will have no impact, but the SES setting is updated even if there is no topic.
topic
string
The ARN of the topic to send notifications to.
If omitted, notifications will not be delivered to a SNS topic.
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
delivery_notifications
dictionary
Setup the SNS topic used to report delivery notifications.
If omitted, delivery notifications will not be delivered to a SNS topic.
include_headers
boolean
    Choices:
  • no ←
  • yes
Whether or not to include headers when delivering to the SNS topic.
If topic is not specified this will have no impact, but the SES setting is updated even if there is no topic.
topic
string
The ARN of the topic to send notifications to.
If omitted, notifications will not be delivered to a SNS topic.
ec2_url
string
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
feedback_forwarding
boolean
    Choices:
  • no
  • yes ←
Whether or not to enable feedback forwarding.
This can only be false if both bounce_notifications and complaint_notifications specify SNS topics.
identity
string / required
This is the email address or domain to verify / delete.
If this contains an '@' then it will be considered an email. Otherwise it will be considered a domain.
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
region
string
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
security_token
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
state
string
    Choices:
  • present ←
  • absent
Whether to create(or update) or delete the identity.
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE

  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html

  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Ensure [email protected] email identity exists
  community.aws.aws_ses_identity:
    identity: [email protected]
    state: present

- name: Delete [email protected] email identity
  community.aws.aws_ses_identity:
    email: [email protected]
    state: absent

- name: Ensure example.com domain identity exists
  community.aws.aws_ses_identity:
    identity: example.com
    state: present

# Create an SNS topic and send bounce and complaint notifications to it
# instead of emailing the identity owner
- name: Ensure complaints-topic exists
  community.aws.sns_topic:
    name: "complaints-topic"
    state: present
    purge_subscriptions: False
  register: topic_info

- name: Deliver feedback to topic instead of owner email
  community.aws.aws_ses_identity:
    identity: [email protected]
    state: present
    complaint_notifications:
      topic: "{{ topic_info.sns_arn }}"
      include_headers: True
    bounce_notifications:
      topic: "{{ topic_info.sns_arn }}"
      include_headers: False
    feedback_forwarding: False

# Create an SNS topic for delivery notifications and leave complaints
# Being forwarded to the identity owner email
- name: Ensure delivery-notifications-topic exists
  community.aws.sns_topic:
    name: "delivery-notifications-topic"
    state: present
    purge_subscriptions: False
  register: topic_info

- name: Delivery notifications to topic
  community.aws.aws_ses_identity:
    identity: [email protected]
    state: present
    delivery_notifications:
      topic: "{{ topic_info.sns_arn }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
identity
string
success
The identity being modified.

Sample:
identity_arn
string
success
The arn of the identity being modified.

Sample:
arn:aws:ses:us-east-1:12345678:identity/[email protected]
notification_attributes
complex
success
The notification setup for the identity.

Sample:
{'bounce_topic': 'arn:aws:sns:....', 'complaint_topic': 'arn:aws:sns:....', 'delivery_topic': 'arn:aws:sns:....', 'forwarding_enabled': False, 'headers_in_bounce_notifications_enabled': True, 'headers_in_complaint_notifications_enabled': True, 'headers_in_delivery_notifications_enabled': True}
 
bounce_topic
string
success
The ARN of the topic bounce notifications are delivered to.
Omitted if bounce notifications are not delivered to a topic.

 
complaint_topic
string
success
The ARN of the topic complaint notifications are delivered to.
Omitted if complaint notifications are not delivered to a topic.

 
delivery_topic
string
success
The ARN of the topic delivery notifications are delivered to.
Omitted if delivery notifications are not delivered to a topic.

 
forwarding_enabled
boolean
success
Whether or not feedback forwarding is enabled.

 
headers_in_bounce_notifications_enabled
boolean
success
Whether or not headers are included in messages delivered to the bounce topic.

 
headers_in_complaint_notifications_enabled
boolean
success
Whether or not headers are included in messages delivered to the complaint topic.

 
headers_in_delivery_notifications_enabled
boolean
success
Whether or not headers are included in messages delivered to the delivery topic.

verification_attributes
complex
success
The verification information for the identity.

Sample:
{'verification_status': 'Pending', 'verification_token': '....'}
 
verification_status
string
success
The verification status of the identity.

Sample:
Pending
 
verification_token
string
success
The verification token for a domain identity.



Authors

  • Ed Costello (@orthanc)