ansible / ansible.builtin / v2.8.19 / module / route53_facts Retrieves route53 details using AWS methods | "added in version" 2.0 of ansible.builtin" Authors: Karen Cheng (@Etherdaemon) preview | supported by communityansible.builtin.route53_facts (v2.8.19) — module
pip
Install with pip install ansible==2.8.19
Gets various details related to Route53 zone, record set or health check details.
# 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 }}"
- 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_facts: type: A query: record_sets hosted_zone_id: "{{ AWSINFO.zone_id }}" start_record_name: "host1.workshop.test.io" register: RECORDS
type: choices: - A - CNAME - MX - AAAA - TXT - PTR - SRV - SPF - CAA - NS description: - The type of DNS record required: false query: choices: - change - checker_ip_range - health_check - hosted_zone - record_sets - reusable_delegation_set description: - specifies the query action to take. required: true region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str 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: - Uses a boto profile. Only works with boto >= 2.24.0. - 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 dns_name: description: - The first name in the lexicographic ordering of domain names that you want the list_command to start listing from. required: false change_id: description: - 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 C(query) is set to C(change). required: false max_items: description: - Maximum number of items to return for various get/list requests. required: false 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 next_marker: description: - '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.' required: false resource_id: aliases: - resource_ids description: - The ID/s of the specified resource/s. - Required if C(query) is set to C(health_check) and C(health_check_method) is to C(tags). - Required if C(query) is set to C(hosted_zone) and C(hosted_zone_method) is to C(tags). required: false aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Only used for boto3 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: - 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. - 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: - 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. - 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. - Required if C(query) is set to C(hosted_zone) and C(hosted_zone_method) is set to C(details). - Required if C(query) is set to C(record_sets). required: false security_token: aliases: - aws_security_token - access_token description: - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or 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 boto versions >= 2.6.0. type: bool health_check_id: description: - The ID of the health check. - Required if C(query) is set to C(health_check) and C(health_check_method) is set to C(details) or C(status) or C(failure_reason). required: false delegation_set_id: description: - The DNS Zone delegation set ID. required: false start_record_name: description: - 'The first name in the lexicographic ordering of domain names that you want the list_command: record_sets to start listing from.' required: false hosted_zone_method: choices: - details - list - list_by_name - count - tags default: list description: - 'This is used in conjunction with query: hosted_zone. It allows for listing details, counts or tags of various hosted zone details.' required: false health_check_method: choices: - list - details - status - failure_reason - count - tags default: list description: - 'This is used in conjunction with query: health_check. It allows for listing details, counts or tags of various health check details.' required: false 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