community / community.aws / 3.4.0 / module / route53 add or delete entries in Amazons Route 53 DNS service | "added in version" 1.0.0 of community.aws" Authors: Bruce Pennypacker (@bpennypacker), Mike Buzzetti (@jimbydamonk)community.aws.route53 (3.4.0) — module
Install with ansible-galaxy collection install community.aws:==3.4.0
collections: - name: community.aws version: 3.4.0
Creates and deletes DNS records in Amazons Route 53 service.
- name: Add new.foo.com as an A record with 3 IPs and wait until the changes have been replicated community.aws.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
- name: Update new.foo.com as an A record with a list of 3 IPs and wait until the changes have been replicated community.aws.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
- name: Retrieve the details for new.foo.com community.aws.route53: state: get zone: foo.com record: new.foo.com type: A register: rec
- name: Delete new.foo.com A record using the results from the get command community.aws.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. - name: Add an AAAA record community.aws.route53: command: create zone: foo.com record: localhost.foo.com type: AAAA ttl: 7200 value: "::1"
# For more information on SRV records see: # https://en.wikipedia.org/wiki/SRV_record - name: Add a SRV record with multiple fields for a service on port 22222 community.aws.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"
# Note that TXT and SPF records must be surrounded # by quotes when sent to Route 53: - name: Add a TXT record. community.aws.route53: state: present zone: foo.com record: localhost.foo.com type: TXT ttl: 7200 value: '"bar"'
- name: Add an alias record that points to an Amazon ELB community.aws.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 }}"
- name: Retrieve the details for elb.foo.com community.aws.route53: state: get zone: foo.com record: elb.foo.com type: A register: rec
- name: Delete an alias record using the results from the get command community.aws.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 }}"
- name: Add an alias record that points to an Amazon ELB and evaluates it health community.aws.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
- name: Add an AAAA record with Hosted Zone ID community.aws.route53: state: present zone: foo.com hosted_zone_id: Z2AABBCCDDEEFF record: localhost.foo.com type: AAAA ttl: 7200 value: "::1"
- name: Use a routing policy to distribute traffic community.aws.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"
- name: Add a CAA record (RFC 6844) community.aws.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"
- name: Create a record with geo_location - country_code community.aws.route53: state: present zone: '{{ zone_one }}' record: 'geo-test.{{ zone_one }}' identifier: "geohost@www" type: A value: 1.1.1.1 ttl: 30 geo_location: country_code: US
- name: Create a record with geo_location - subdivision code community.aws.route53: state: present zone: '{{ zone_one }}' record: 'geo-test.{{ zone_one }}' identifier: "geohost@www" type: A value: 1.1.1.1 ttl: 30 geo_location: country_code: US subdivision_code: TX
ttl: default: 3600 description: - The TTL, in second, to give the new record. - Mutually exclusive with I(alias). type: int type: choices: - A - CNAME - MX - AAAA - TXT - PTR - SRV - SPF - CAA - NS - SOA description: - The type of DNS record to create. required: true type: str wait: default: false description: - Wait until the changes have been replicated to all Amazon Route 53 DNS servers. type: bool zone: description: - The DNS zone to modify. - This is a required parameter, if parameter I(hosted_zone_id) is not supplied. type: str alias: description: - Indicates if this is an alias record. - Mutually exclusive with I(ttl). - Defaults to C(false). type: bool state: aliases: - command choices: - present - absent - get - create - delete description: - Specifies the state of the resource record. required: true type: str value: description: - The new value when creating a DNS record. YAML lists or multiple comma-spaced values are allowed for non-alias records. elements: str type: list record: description: - The full DNS record to create or delete. required: true type: str region: 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 - Mutually exclusive with I(weight) and I(failover). type: str vpc_id: 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. type: str weight: 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. - Mutually exclusive with I(region) and I(failover). type: int ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str failover: choices: - SECONDARY - PRIMARY description: - Failover resource record sets only. Whether this is the primary or secondary resource record set. Allowed values are PRIMARY and SECONDARY - Mutually exclusive with I(weight) and I(region). type: str overwrite: description: - Whether an existing record should be overwritten on create if values do not match. type: bool aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(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 U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict identifier: 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. type: str geo_location: description: - Allows to control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. - Two geolocation resource record sets that specify same geographic location cannot be created. - Non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets cannot be created. suboptions: continent_code: description: - The two-letter code for the continent. - Specifying I(continent_code) with either I(country_code) or I(subdivision_code) returns an InvalidInput error. type: str country_code: description: - The two-letter code for a country. - Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2 . type: str subdivision_code: description: - The two-letter code for a state of the United States. - To specify I(subdivision_code), I(country_code) must be set to C(US). type: str type: dict version_added: 3.3.0 version_added_collection: community.aws health_check: description: - Health check to associate with this record type: str private_zone: default: false description: - If set to C(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. type: bool wait_timeout: default: 300 description: - How long to wait for the changes to be replicated, in seconds. type: int aws_ca_bundle: description: - 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.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str hosted_zone_id: description: - The Hosted Zone ID of the DNS zone to modify. - This is a required parameter, if parameter I(zone) is not supplied. type: str retry_interval: default: 500 description: - In the case that Route 53 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 C(500) seconds may be too long. type: int security_token: aliases: - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool alias_hosted_zone_id: description: - The hosted zone identifier. type: str alias_evaluate_target_health: default: false description: - Whether or not to evaluate an alias target health. Useful for aliases to Elastic Load Balancers. type: bool debug_botocore_endpoint_logs: default: 'no' description: - 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. 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: Whether this is the primary or secondary resource record set. returned: always sample: PRIMARY type: str geo_location: description: geograpic location based on which Route53 resonds to DNS queries. returned: when configured sample: continent_code: NA country_code: US subdivision_code: CA type: dict version_added: 3.3.0 version_added_collection: community.aws health_check: description: health_check associated with this record. returned: always type: str identifier: description: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type. returned: always type: str record: description: Domain name for the record set. returned: always sample: new.foo.com. type: str region: description: Which region this should be associated with for latency-based routing. returned: always sample: us-west-2 type: str ttl: description: Resource record cache TTL. returned: always sample: '3600' type: str type: description: Resource record set type. returned: always sample: A type: str value: description: Record value. returned: always sample: 52.43.18.27 type: str values: description: Record Values. returned: always sample: - 52.43.18.27 type: list weight: description: Weight of the record. returned: always sample: '3' type: str zone: description: Zone this record set belongs to. returned: always sample: foo.bar.com. type: str description: Info specific to the resource record. returned: when state is 'get' type: complex