route53_facts
before Ansible 2.9. The usage did not change.Aliases: route53_facts
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
aws_access_key string | 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 string | 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. Required if query is set to change . | |
debug_botocore_endpoint_logs boolean added in 2.8 |
| 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. |
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 string | 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. Required if query is set to health_check and health_check_method is set to details or status or failure_reason . | |
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. Required if query is set to hosted_zone and hosted_zone_method is set to details .Required if query is set to record_sets . | |
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 string | Uses a boto profile. Only works with boto >= 2.24.0. | |
query - / required |
| specifies the query action to take. |
region string | 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. Required if query is set to health_check and health_check_method is to tags .Required if query is set to hosted_zone and hosted_zone_method is to tags .aliases: resource_ids | |
security_token string | 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 boolean |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
Note
AWS_URL
or EC2_URL
, AWS_ACCESS_KEY_ID
or AWS_ACCESS_KEY
or EC2_ACCESS_KEY
, AWS_SECRET_ACCESS_KEY
or AWS_SECRET_KEY
or EC2_SECRET_KEY
, AWS_SECURITY_TOKEN
or EC2_SECURITY_TOKEN
, AWS_REGION
or EC2_REGION
AWS_REGION
or EC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file# Simple example of listing all hosted zones - name: List all hosted zones route53_info: query: hosted_zone register: hosted_zones # Getting a count of hosted zones - name: Return a count of all hosted zones route53_info: 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_info: profile: account_name query: record_sets hosted_zone_id: ZZZ1111112222 max_items: 20 register: record_sets - name: List first 20 health checks route53_info: query: health_check health_check_method: list max_items: 20 register: health_checks - name: Get health check last failure_reason route53_info: 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_info: query: reusable_delegation_set delegation_set_id: delegation id register: delegation_sets - name: setup of example for using next_marker route53_info: query: hosted_zone max_items: 1 register: first_info - name: example for using next_marker route53_info: query: hosted_zone next_marker: "{{ first_info.NextMarker }}" max_items: 1 when: "{{ 'NextMarker' in first_info }}" - name: retrieve host entries starting with host1.workshop.test.io block: - name: grab zone id route53_zone: zone: "test.io" register: AWSINFO - name: grab Route53 record information route53_info: type: A query: record_sets hosted_zone_id: "{{ AWSINFO.zone_id }}" start_record_name: "host1.workshop.test.io" register: RECORDS
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.9/modules/route53_info_module.html