community.aws.route53_zone module – add or delete Route53 zones
Note
This module is part of the community.aws collection (version 3.6.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.aws
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.route53_zone
.
New in community.aws 1.0.0
Synopsis
Creates and deletes Route53 private and public zones.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.16.0
botocore >= 1.19.0
Parameters
Parameter |
Comments |
---|---|
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. |
|
The location of a CA Bundle to use when validating SSL certificates. Not used by boto 2 based modules. Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally. |
|
A dictionary to modify the botocore configuration. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. 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. |
|
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. |
|
Comment associated with the zone. Default: |
|
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. Choices:
|
|
The reusable delegation set ID to be associated with the zone. Note that you can’t associate a reusable delegation set with a private hosted zone. |
|
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. |
|
The unique zone identifier you want to delete or “all” if there are many zones with the same domain name. Required if there are multiple zones identified with the above options. |
|
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. |
|
Delete any tags not specified in the task that are on the zone. This means you have to specify all the desired tags on each task affecting a zone. Choices:
|
|
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 |
|
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_session_token and session_token have been added in version 3.2.0. |
|
Whether or not the zone should exist or not. Choices:
|
|
A hash/dictionary of tags to add to the new instance or to add/remove from an existing one. |
|
When set to “no”, SSL certificates will not be validated for communication with the AWS APIs. Choices:
|
|
The VPC ID the zone should be a part of (if this is going to be a private zone). |
|
The VPC Region the zone should be a part of (if this is going to be a private zone). |
|
The DNS zone record (eg: foo.com.) |
Notes
Note
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_PROFILE
orAWS_DEFAULT_PROFILE
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_REGION
,AWS_CA_BUNDLE
When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
AWS_REGION
orEC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
Examples
- name: create a public zone
community.aws.route53_zone:
zone: example.com
comment: this is an example
- name: delete a public zone
community.aws.route53_zone:
zone: example.com
state: absent
- name: create a private zone
community.aws.route53_zone:
zone: devel.example.com
vpc_id: '{{ myvpc_id }}'
vpc_region: us-west-2
comment: developer domain
- name: create a public zone associated with a specific reusable delegation set
community.aws.route53_zone:
zone: example.com
comment: reusable delegation set example
delegation_set_id: A1BCDEF2GHIJKL
- name: create a public zone with tags
community.aws.route53_zone:
zone: example.com
comment: this is an example
tags:
Owner: Ansible Team
- name: modify a public zone, removing all previous tags and adding a new one
community.aws.route53_zone:
zone: example.com
comment: this is an example
tags:
Support: Ansible Community
purge_tags: true
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
optional hosted zone comment Returned: when hosted zone exists Sample: |
|
id of the associated reusable delegation set Returned: for public hosted zones, if they have been associated with a reusable delegation set Sample: |
|
hosted zone name Returned: when hosted zone exists Sample: |
|
whether hosted zone is private or public Returned: when hosted zone exists Sample: |
|
tags associated with the zone Returned: when tags are defined |
|
id of vpc attached to private hosted zone Returned: for private hosted zone Sample: |
|
region of vpc attached to private hosted zone Returned: for private hosted zone Sample: |
|
hosted zone id Returned: when hosted zone exists Sample: |