New in version 1.3.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
alias
(added in 1.9) |
|
Indicates if this is an alias record.
|
alias_evaluate_target_health
(added in 2.1) |
|
Whether or not to evaluate an alias target health. Useful for aliases to Elastic Load Balancers.
|
alias_hosted_zone_id
(added in 1.9) |
|
The hosted zone identifier.
|
aws_access_key
|
|
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.
aliases: ec2_access_key, access_key |
aws_secret_key
|
|
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.
aliases: ec2_secret_key, secret_key |
ec2_url
|
|
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.
|
failover
(added in 2.0) |
|
Failover resource record sets only. Whether this is the primary or secondary resource record set. Allowed values are PRIMARY and SECONDARY
|
health_check
(added in 2.0) |
|
Health check to associate with this record
|
hosted_zone_id
(added in 2.0) |
|
The Hosted Zone ID of the DNS zone to modify
|
identifier
(added in 2.0) |
|
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.
|
overwrite
|
|
Whether an existing record should be overwritten on create if values do not match
|
private_zone
(added in 1.9) |
|
If set to
yes , 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. |
profile
(added in 1.6) |
|
Uses a boto profile. Only works with boto >= 2.24.0.
|
record
required |
|
The full DNS record to create or delete
|
region
(added in 2.0) |
|
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
|
retry_interval
|
Default:
500
|
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.
|
security_token
(added in 1.6) |
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
aliases: access_token |
state
required |
|
Specifies the state of the resource record. As of Ansible 2.4, the command option has been changed to state as default and the choices 'present' and 'absent' have been added, but command still works as well.
aliases: command |
ttl
|
Default:
3600 (one hour)
|
The TTL to give the new record
|
type
required |
|
The type of DNS record to create
|
validate_certs
(added in 1.5) |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
value
|
|
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.
|
vpc_id
(added in 2.0) |
|
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.
|
wait
(added in 2.1) |
|
Wait until the changes have been replicated to all Amazon Route 53 DNS servers.
|
wait_timeout
(added in 2.1) |
Default:
300
|
How long to wait for the changes to be replicated, in seconds.
|
weight
(added in 2.0) |
|
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.
|
zone
required |
|
The DNS zone to modify
|
Note
# 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"
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
---|---|---|
nameservers
list
|
when state is 'get' |
nameservers associated with the zone
Sample:
['ns-1036.awsdns-00.org.', 'ns-516.awsdns-00.net.', 'ns-1504.awsdns-00.co.uk.', 'ns-1.awsdns-00.com.']
|
set
complex
|
when state is 'get' |
info specific to the resource record
|
health_check
NoneType
|
always |
health_check associated with this record
|
weight
string
|
always |
weight of the record
Sample:
3
|
zone
string
|
always |
zone this record set belongs to
Sample:
foo.bar.com.
|
alias
bool
|
always |
whether this is an alias
|
failover
NoneType
|
always |
|
value
string
|
always |
value
Sample:
52.43.18.27
|
record
string
|
always |
domain name for the record set
Sample:
new.foo.com.
|
values
list
|
always |
values
Sample:
['52.43.18.27']
|
ttl
string
|
always |
resource record cache TTL
Sample:
3600
|
identifier
NoneType
|
always |
|
type
string
|
always |
record set type
Sample:
A
|
region
None
|
always |
|
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
Hint
If you notice any issues in this documentation you can edit this document to improve it.