Skip to content

Commit

Permalink
Rename ses modules (ansible-collections#1264)
Browse files Browse the repository at this point in the history
Rename SES modules

SUMMARY
In line with what I understood to be the consensus on ansible-collections#881 and ansible-collections#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
tremble authored and abikouo committed Sep 18, 2023
1 parent 8daccc5 commit 9a4f1a6
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 31 deletions.
23 changes: 12 additions & 11 deletions aws_ses_identity.py → ses_identity.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand All @@ -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:
Expand All @@ -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:
Expand Down
23 changes: 13 additions & 10 deletions aws_ses_identity_policy.py → ses_identity_policy.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down
21 changes: 11 additions & 10 deletions aws_ses_rule_set.py → ses_rule_set.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@

DOCUMENTATION = '''
---
module: aws_ses_rule_set
module: ses_rule_set
version_added: 1.0.0
short_description: Manages SES inbound receipt rule sets
description:
- The M(community.aws.aws_ses_rule_set) module allows you to create, delete, and manage SES receipt rule sets
- This module allows you to create, delete, and manage SES receipt rule sets
- Prior to release 5.0.0 this module was called C(community.aws.aws_ses_rule_set).
The usage did not change.
author:
- "Ben Tomasik (@tomislacker)"
- "Ed Costello (@orthanc)"
Expand Down Expand Up @@ -44,39 +46,38 @@
required: False
default: False
extends_documentation_fragment:
- amazon.aws.aws
- amazon.aws.ec2
- amazon.aws.aws
- amazon.aws.ec2
'''

EXAMPLES = """
# Note: None of these examples set aws_access_key, aws_secret_key, or region.
# It is assumed that their matching environment variables are set.
---
- name: Create default rule set and activate it if not already
community.aws.aws_ses_rule_set:
community.aws.ses_rule_set:
name: default-rule-set
state: present
active: yes
- name: Create some arbitrary rule set but do not activate it
community.aws.aws_ses_rule_set:
community.aws.ses_rule_set:
name: arbitrary-rule-set
state: present
- name: Explicitly deactivate the default rule set leaving no active rule set
community.aws.aws_ses_rule_set:
community.aws.ses_rule_set:
name: default-rule-set
state: present
active: no
- name: Remove an arbitrary inactive rule set
community.aws.aws_ses_rule_set:
community.aws.ses_rule_set:
name: arbitrary-rule-set
state: absent
- name: Remove an ruleset even if we have to first deactivate it to remove it
community.aws.aws_ses_rule_set:
community.aws.ses_rule_set:
name: default-rule-set
state: absent
force: yes
Expand Down

0 comments on commit 9a4f1a6

Please sign in to comment.