route53_facts - Retrieves route53 details using AWS methods
New in version 2.0.
Synopsis
- Gets various details related to Route53 zone, record set or health check details
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- boto
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
aws_access_key | Default: None | 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 | Default: None | 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 |
change_id | The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets returned in the Id element when you submitted the request. | |
delegation_set_id | The DNS Zone delegation set ID | |
dns_name | The first name in the lexicographic ordering of domain names that you want the list_command to start listing from | |
ec2_url | Default: None | 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. |
health_check_id | The ID of the health check | |
health_check_method |
| This is used in conjunction with query: health_check. It allows for listing details, counts or tags of various health check details. |
hosted_zone_id | The Hosted Zone ID of the DNS zone | |
hosted_zone_method |
| This is used in conjunction with query: hosted_zone. It allows for listing details, counts or tags of various hosted zone details. |
max_items | Maximum number of items to return for various get/list requests | |
next_marker | Some requests such as list_command: hosted_zones will return a maximum number of entries - EG 100 or the number specified by max_items. If the number of entries exceeds this maximum another request can be sent using the NextMarker entry from the first response to get the next page of results | |
profile (added in 1.6) | Default: None | Uses a boto profile. Only works with boto >= 2.24.0. |
query required |
| specifies the query action to take |
region | 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
aliases: aws_region, ec2_region | |
resource_id | The ID/s of the specified resource/s aliases: resource_ids | |
security_token (added in 1.6) | Default: None | 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 |
start_record_name | The first name in the lexicographic ordering of domain names that you want the list_command: record_sets to start listing from | |
type |
| The type of DNS record |
validate_certs (added in 1.5) |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
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_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
- Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGION
orEC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file
Examples
# Simple example of listing all hosted zones - name: List all hosted zones route53_facts: query: hosted_zone register: hosted_zones # Getting a count of hosted zones - name: Return a count of all hosted zones route53_facts: query: hosted_zone hosted_zone_method: count register: hosted_zone_count - name: List the first 20 resource record sets in a given hosted zone route53_facts: profile: account_name query: record_sets hosted_zone_id: ZZZ1111112222 max_items: 20 register: record_sets - name: List first 20 health checks route53_facts: query: health_check health_check_method: list max_items: 20 register: health_checks - name: Get health check last failure_reason route53_facts: query: health_check health_check_method: failure_reason health_check_id: 00000000-1111-2222-3333-12345678abcd register: health_check_failure_reason - name: Retrieve reusable delegation set details route53_facts: query: reusable_delegation_set delegation_set_id: delegation id register: delegation_sets - name: setup of example for using next_marker route53_facts: query: hosted_zone max_items: 1 register: first_facts - name: example for using next_marker route53_facts: query: hosted_zone next_marker: "{{ first_facts.NextMarker }}" max_items: 1 when: "{{ 'NextMarker' in first_facts }}"
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Karen Cheng(@Etherdaemon)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/route53_facts_module.html