Try Spotteradd or delete entries in Amazons Route53 DNS service
| "added in version" 1.3 of ansible.builtin"
Authors: Bruce Pennypacker (@bpennypacker), Mike Buzzetti <mike.buzzetti@gmail.com>
stableinterface | supported by community
pipInstall with pip install ansible==2.5.10
Creates and deletes DNS records in Amazons Route53 service
# Add new.foo.com as an A record with 3 IPs and wait until the changes have been replicated
- route53:
state: present
zone: foo.com
record: new.foo.com
type: A
ttl: 7200
value: 1.1.1.1,2.2.2.2,3.3.3.3
wait: yes
# Update new.foo.com as an A record with a list of 3 IPs and wait until the changes have been replicated
- route53:
state: present
zone: foo.com
record: new.foo.com
type: A
ttl: 7200
value:
- 1.1.1.1
- 2.2.2.2
- 3.3.3.3
wait: yes
# Retrieve the details for new.foo.com
- route53:
state: get
zone: foo.com
record: new.foo.com
type: A
register: rec
# Delete new.foo.com A record using the results from the get command
- route53:
state: absent
zone: foo.com
record: "{{ rec.set.record }}"
ttl: "{{ rec.set.ttl }}"
type: "{{ rec.set.type }}"
value: "{{ rec.set.value }}"
# Add an AAAA record. Note that because there are colons in the value
# that the IPv6 address must be quoted. Also shows using the old form command=create.
- route53:
command: create
zone: foo.com
record: localhost.foo.com
type: AAAA
ttl: 7200
value: "::1"
# Add a SRV record with multiple fields for a service on port 22222
# For more information on SRV records see:
# https://en.wikipedia.org/wiki/SRV_record
- route53:
state: present
zone: foo.com
record: "_example-service._tcp.foo.com"
type: SRV
value: "0 0 22222 host1.foo.com,0 0 22222 host2.foo.com"
# Add a TXT record. Note that TXT and SPF records must be surrounded
# by quotes when sent to Route 53:
- route53:
state: present
zone: foo.com
record: localhost.foo.com
type: TXT
ttl: 7200
value: '"bar"'
# Add an alias record that points to an Amazon ELB:
- route53:
state: present
zone: foo.com
record: elb.foo.com
type: A
value: "{{ elb_dns_name }}"
alias: True
alias_hosted_zone_id: "{{ elb_zone_id }}"
# Retrieve the details for elb.foo.com
- route53:
state: get
zone: foo.com
record: elb.foo.com
type: A
register: rec
# Delete an alias record using the results from the get command
- route53:
state: absent
zone: foo.com
record: "{{ rec.set.record }}"
ttl: "{{ rec.set.ttl }}"
type: "{{ rec.set.type }}"
value: "{{ rec.set.value }}"
alias: True
alias_hosted_zone_id: "{{ rec.set.alias_hosted_zone_id }}"
# Add an alias record that points to an Amazon ELB and evaluates it health:
- route53:
state: present
zone: foo.com
record: elb.foo.com
type: A
value: "{{ elb_dns_name }}"
alias: True
alias_hosted_zone_id: "{{ elb_zone_id }}"
alias_evaluate_target_health: True
# Add an AAAA record with Hosted Zone ID.
- route53:
state: present
zone: foo.com
hosted_zone_id: Z2AABBCCDDEEFF
record: localhost.foo.com
type: AAAA
ttl: 7200
value: "::1"
# Use a routing policy to distribute traffic:
- route53:
state: present
zone: foo.com
record: www.foo.com
type: CNAME
value: host1.foo.com
ttl: 30
# Routing policy
identifier: "host1@www"
weight: 100
health_check: "d994b780-3150-49fd-9205-356abdd42e75"
# Add a CAA record (RFC 6844):
- route53:
state: present
zone: example.com
record: example.com
type: CAA
value:
- 0 issue "ca.example.net"
- 0 issuewild ";"
- 0 iodef "mailto:security@example.com"
ttl:
default: 3600 (one hour)
description:
- The TTL to give the new record
required: false
type:
choices:
- A
- CNAME
- MX
- AAAA
- TXT
- PTR
- SRV
- SPF
- CAA
- NS
- SOA
description:
- The type of DNS record to create
required: true
wait:
default: false
description:
- Wait until the changes have been replicated to all Amazon Route 53 DNS servers.
required: false
version_added: '2.1'
version_added_collection: ansible.builtin
zone:
description:
- The DNS zone to modify
required: true
alias:
choices:
- 'True'
- 'False'
default: false
description:
- Indicates if this is an alias record.
required: false
version_added: '1.9'
version_added_collection: ansible.builtin
state:
aliases:
- command
choices:
- present
- absent
- get
- create
- delete
description:
- Specifies the state of the resource record. As of Ansible 2.4, the I(command) option
has been changed to I(state) as default and the choices 'present' and 'absent' have
been added, but I(command) still works as well.
required: true
value:
default: null
description:
- The new value when creating a DNS record. YAML lists or multiple comma-spaced values
are allowed for non-alias records.
- When deleting a record all values for the record must be specified or Route53 will
not delete it.
required: false
record:
description:
- The full DNS record to create or delete
required: true
region:
default: null
description:
- Latency-based resource record sets only Among resource record sets that have the
same combination of DNS name and type, a value that determines which region this
should be associated with for the latency-based routing
required: false
version_added: '2.0'
version_added_collection: ansible.builtin
vpc_id:
default: null
description:
- 'When used in conjunction with private_zone: true, this will only modify records
in the private hosted zone attached to this VPC.'
- This allows you to have multiple private hosted zones, all with the same name, attached
to different VPCs.
required: false
version_added: '2.0'
version_added_collection: ansible.builtin
weight:
default: null
description:
- Weighted resource record sets only. Among resource record sets that have the same
combination of DNS name and type, a value that determines what portion of traffic
for the current resource record set is routed to the associated location.
required: false
version_added: '2.0'
version_added_collection: ansible.builtin
profile:
aliases:
- aws_profile
description:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
failover:
default: null
description:
- Failover resource record sets only. Whether this is the primary or secondary resource
record set. Allowed values are PRIMARY and SECONDARY
required: false
version_added: '2.0'
version_added_collection: ansible.builtin
overwrite:
default: null
description:
- Whether an existing record should be overwritten on create if values do not match
required: false
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
identifier:
default: null
description:
- Have to be specified for Weighted, latency-based and failover resource record sets
only. An identifier that differentiates among multiple resource record sets that
have the same combination of DNS name and type.
required: false
version_added: '2.0'
version_added_collection: ansible.builtin
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- URL to connect to instead of the default AWS endpoints. While this can be used
to connection to other AWS-compatible services the amazon.aws and community.aws
collections are only tested against AWS.
- The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
health_check:
default: null
description:
- Health check to associate with this record
required: false
version_added: '2.0'
version_added_collection: ansible.builtin
private_zone:
default: false
description:
- If set to true, the private zone matching the requested name within the domain will
be used if there are both public and private zones. The default is to use the public
zone.
required: false
version_added: '1.9'
version_added_collection: ansible.builtin
wait_timeout:
default: 300
description:
- How long to wait for the changes to be replicated, in seconds.
required: false
version_added: '2.1'
version_added_collection: ansible.builtin
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
hosted_zone_id:
default: null
description:
- The Hosted Zone ID of the DNS zone to modify
required: false
version_added: '2.0'
version_added_collection: ansible.builtin
retry_interval:
default: 500
description:
- In the case that route53 is still servicing a prior request, this module will wait
and try again after this many seconds. If you have many domain names, the default
of 500 seconds may be too long.
required: false
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
type: bool
alias_hosted_zone_id:
default: null
description:
- The hosted zone identifier.
required: false
version_added: '1.9'
version_added_collection: ansible.builtin
alias_evaluate_target_health:
default: false
description:
- Whether or not to evaluate an alias target health. Useful for aliases to Elastic
Load Balancers.
required: false
version_added: '2.1'
version_added_collection: ansible.builtin
debug_botocore_endpoint_logs:
default: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used.
type: bool
nameservers:
description: nameservers associated with the zone
returned: when state is 'get'
sample:
- ns-1036.awsdns-00.org.
- ns-516.awsdns-00.net.
- ns-1504.awsdns-00.co.uk.
- ns-1.awsdns-00.com.
type: list
set:
contains:
alias:
description: whether this is an alias
returned: always
sample: false
type: bool
failover:
description: ''
returned: always
sample: null
type: NoneType
health_check:
description: health_check associated with this record
returned: always
sample: null
type: NoneType
identifier:
description: ''
returned: always
sample: null
type: NoneType
record:
description: domain name for the record set
returned: always
sample: new.foo.com.
type: string
region:
description: ''
returned: always
sample: null
type: null
ttl:
description: resource record cache TTL
returned: always
sample: '3600'
type: string
type:
description: record set type
returned: always
sample: A
type: string
value:
description: value
returned: always
sample: 52.43.18.27
type: string
values:
description: values
returned: always
sample:
- 52.43.18.27
type: list
weight:
description: weight of the record
returned: always
sample: '3'
type: string
zone:
description: zone this record set belongs to
returned: always
sample: foo.bar.com.
type: string
description: info specific to the resource record
returned: when state is 'get'
type: complex