-
Notifications
You must be signed in to change notification settings - Fork 398
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rename SES modules SUMMARY In line with what I understood to be the consensus on ansible-collections/amazon.aws#881 and ansible-collections/amazon.aws#610 Rename ses modules to remove the aws_ prefix. ISSUE TYPE Feature Pull Request COMPONENT NAME plugins/modules/aws_ses_identity.py plugins/modules/aws_ses_identity_policy.py plugins/modules/aws_ses_rule_set.py plugins/modules/ses_identity.py plugins/modules/ses_identity_policy.py plugins/modules/ses_rule_set.py ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis <None>
- Loading branch information
Showing
28 changed files
with
87 additions
and
63 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
minor_changes: | ||
- aws_ses_identity - the ``aws_ses_identity`` module has been renamed to ``ses_identity``, ``aws_ses_identity`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1264). | ||
- aws_ses_identity_policy - the ``aws_ses_identity_policy`` module has been renamed to ``ses_identity_policy``, ``aws_ses_identity_policy`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1264). | ||
- aws_ses_rule_set - the ``aws_ses_rule_set`` module has been renamed to ``ses_rule_set``, ``aws_ses_rule_set`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1264). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,9 @@ | ||
.. _community.aws.aws_ses_identity_module: | ||
.. _community.aws.ses_identity_module: | ||
|
||
|
||
****************************** | ||
community.aws.aws_ses_identity | ||
****************************** | ||
************************** | ||
community.aws.ses_identity | ||
************************** | ||
|
||
**Manages SES email and domain identity** | ||
|
||
|
@@ -19,6 +19,7 @@ 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. | ||
- Prior to release 5.0.0 this module was called ``community.aws.aws_ses_identity``. The usage did not change. | ||
|
||
|
||
|
||
|
@@ -457,17 +458,17 @@ 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: | ||
community.aws.ses_identity: | ||
identity: [email protected] | ||
state: present | ||
- name: Delete [email protected] email identity | ||
community.aws.aws_ses_identity: | ||
community.aws.ses_identity: | ||
email: [email protected] | ||
state: absent | ||
- name: Ensure example.com domain identity exists | ||
community.aws.aws_ses_identity: | ||
community.aws.ses_identity: | ||
identity: example.com | ||
state: present | ||
|
@@ -481,7 +482,7 @@ Examples | |
register: topic_info | ||
- name: Deliver feedback to topic instead of owner email | ||
community.aws.aws_ses_identity: | ||
community.aws.ses_identity: | ||
identity: [email protected] | ||
state: present | ||
complaint_notifications: | ||
|
@@ -502,7 +503,7 @@ Examples | |
register: topic_info | ||
- name: Delivery notifications to topic | ||
community.aws.aws_ses_identity: | ||
community.aws.ses_identity: | ||
identity: [email protected] | ||
state: present | ||
delivery_notifications: | ||
|
@@ -752,4 +753,4 @@ Status | |
Authors | ||
~~~~~~~ | ||
|
||
- Ed Costello (@orthanc) | ||
- Ed Costello (@orthanc) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,9 @@ | ||
.. _community.aws.aws_ses_identity_policy_module: | ||
.. _community.aws.ses_identity_policy_module: | ||
|
||
|
||
************************************* | ||
community.aws.aws_ses_identity_policy | ||
************************************* | ||
********************************* | ||
community.aws.ses_identity_policy | ||
********************************* | ||
|
||
**Manages SES sending authorization policies** | ||
|
||
|
@@ -19,6 +19,7 @@ Synopsis | |
-------- | ||
- This module allows the user to manage sending authorization policies associated with an SES identity (email or domain). | ||
- SES authorization sending policies can be used to control what actors are able to send email on behalf of the validated identity and what conditions must be met by the sent emails. | ||
- Prior to release 5.0.0 this module was called ``community.aws.aws_ses_identity_policy``. The usage did not change. | ||
|
||
|
||
|
||
|
@@ -301,28 +302,28 @@ Examples | |
# Note: These examples do not set authentication details, see the AWS Guide for details. | ||
- name: add sending authorization policy to domain identity | ||
community.aws.aws_ses_identity_policy: | ||
community.aws.ses_identity_policy: | ||
identity: example.com | ||
policy_name: ExamplePolicy | ||
policy: "{{ lookup('template', 'policy.json.j2') }}" | ||
state: present | ||
- name: add sending authorization policy to email identity | ||
community.aws.aws_ses_identity_policy: | ||
community.aws.ses_identity_policy: | ||
identity: [email protected] | ||
policy_name: ExamplePolicy | ||
policy: "{{ lookup('template', 'policy.json.j2') }}" | ||
state: present | ||
- name: add sending authorization policy to identity using ARN | ||
community.aws.aws_ses_identity_policy: | ||
community.aws.ses_identity_policy: | ||
identity: "arn:aws:ses:us-east-1:12345678:identity/example.com" | ||
policy_name: ExamplePolicy | ||
policy: "{{ lookup('template', 'policy.json.j2') }}" | ||
state: present | ||
- name: remove sending authorization policy | ||
community.aws.aws_ses_identity_policy: | ||
community.aws.ses_identity_policy: | ||
identity: example.com | ||
policy_name: ExamplePolicy | ||
state: absent | ||
|
@@ -369,4 +370,4 @@ Status | |
Authors | ||
~~~~~~~ | ||
|
||
- Ed Costello (@orthanc) | ||
- Ed Costello (@orthanc) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,15 +8,17 @@ | |
|
||
DOCUMENTATION = ''' | ||
--- | ||
module: aws_ses_identity | ||
module: ses_identity | ||
version_added: 1.0.0 | ||
short_description: Manages SES email and domain identity | ||
description: | ||
- 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. | ||
author: Ed Costello (@orthanc) | ||
- Prior to release 5.0.0 this module was called C(community.aws.aws_ses_identity). | ||
The usage did not change. | ||
author: | ||
- Ed Costello (@orthanc) | ||
options: | ||
identity: | ||
description: | ||
|
@@ -86,26 +88,25 @@ | |
type: 'bool' | ||
default: True | ||
extends_documentation_fragment: | ||
- amazon.aws.aws | ||
- amazon.aws.ec2 | ||
- amazon.aws.aws | ||
- amazon.aws.ec2 | ||
''' | ||
|
||
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: | ||
community.aws.ses_identity: | ||
identity: [email protected] | ||
state: present | ||
- name: Delete [email protected] email identity | ||
community.aws.aws_ses_identity: | ||
community.aws.ses_identity: | ||
email: [email protected] | ||
state: absent | ||
- name: Ensure example.com domain identity exists | ||
community.aws.aws_ses_identity: | ||
community.aws.ses_identity: | ||
identity: example.com | ||
state: present | ||
|
@@ -119,7 +120,7 @@ | |
register: topic_info | ||
- name: Deliver feedback to topic instead of owner email | ||
community.aws.aws_ses_identity: | ||
community.aws.ses_identity: | ||
identity: [email protected] | ||
state: present | ||
complaint_notifications: | ||
|
@@ -140,7 +141,7 @@ | |
register: topic_info | ||
- name: Delivery notifications to topic | ||
community.aws.aws_ses_identity: | ||
community.aws.ses_identity: | ||
identity: [email protected] | ||
state: present | ||
delivery_notifications: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,14 +8,18 @@ | |
|
||
DOCUMENTATION = ''' | ||
--- | ||
module: aws_ses_identity_policy | ||
module: ses_identity_policy | ||
version_added: 1.0.0 | ||
short_description: Manages SES sending authorization policies | ||
description: | ||
- This module allows the user to manage sending authorization policies associated with an SES identity (email or domain). | ||
- This module allows the user to manage sending authorization policies associated with an SES | ||
identity (email or domain). | ||
- SES authorization sending policies can be used to control what actors are able to send email | ||
on behalf of the validated identity and what conditions must be met by the sent emails. | ||
author: Ed Costello (@orthanc) | ||
- Prior to release 5.0.0 this module was called C(community.aws.aws_ses_identity_policy). | ||
The usage did not change. | ||
author: | ||
- Ed Costello (@orthanc) | ||
options: | ||
identity: | ||
|
@@ -37,37 +41,36 @@ | |
choices: [ 'present', 'absent' ] | ||
type: str | ||
extends_documentation_fragment: | ||
- amazon.aws.aws | ||
- amazon.aws.ec2 | ||
- amazon.aws.aws | ||
- amazon.aws.ec2 | ||
''' | ||
|
||
EXAMPLES = ''' | ||
# Note: These examples do not set authentication details, see the AWS Guide for details. | ||
- name: add sending authorization policy to domain identity | ||
community.aws.aws_ses_identity_policy: | ||
community.aws.ses_identity_policy: | ||
identity: example.com | ||
policy_name: ExamplePolicy | ||
policy: "{{ lookup('template', 'policy.json.j2') }}" | ||
state: present | ||
- name: add sending authorization policy to email identity | ||
community.aws.aws_ses_identity_policy: | ||
community.aws.ses_identity_policy: | ||
identity: [email protected] | ||
policy_name: ExamplePolicy | ||
policy: "{{ lookup('template', 'policy.json.j2') }}" | ||
state: present | ||
- name: add sending authorization policy to identity using ARN | ||
community.aws.aws_ses_identity_policy: | ||
community.aws.ses_identity_policy: | ||
identity: "arn:aws:ses:us-east-1:12345678:identity/example.com" | ||
policy_name: ExamplePolicy | ||
policy: "{{ lookup('template', 'policy.json.j2') }}" | ||
state: present | ||
- name: remove sending authorization policy | ||
community.aws.aws_ses_identity_policy: | ||
community.aws.ses_identity_policy: | ||
identity: example.com | ||
policy_name: ExamplePolicy | ||
state: absent | ||
|
Oops, something went wrong.