ansible / ansible.builtin / v2.9.13 / module / route53_info Retrieves route53 details using AWS methods | "added in version" 2.0 of ansible.builtin" Authors: Karen Cheng (@Etherdaemon) preview | supported by communityansible.builtin.route53_info (v2.9.13) — module
pip
Install with pip install ansible==2.9.13
Gets various details related to Route53 zone, record set or health check details.
This module was called C(route53_facts) before Ansible 2.9. The usage did not change.
# 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
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. - For global services such as IAM, Route53 and CloudFront, I(region) is ignored. - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used. - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region). - The C(ec2_region) alias has been deprecated and will be removed in a release after 2024-12-01 - Support for the C(EC2_REGION) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str profile: aliases: - aws_profile description: - A named AWS profile to use for authentication. - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). - The C(AWS_PROFILE) environment variable may also be used. - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. 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 access_key: aliases: - aws_access_key_id - aws_access_key - ec2_access_key description: - AWS access key ID. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables may also be used in decreasing order of preference. - The I(aws_access_key) and I(profile) options are mutually exclusive. - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_access_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict secret_key: aliases: - aws_secret_access_key - aws_secret_key - ec2_secret_key description: - AWS secret access key. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variables may also be used in decreasing order of preference. - The I(secret_key) and I(profile) options are mutually exclusive. - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_secret_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str 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 endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. - The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing order of preference. - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_URL) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - The C(AWS_CA_BUNDLE) environment variable may also be used. type: path session_token: aliases: - aws_session_token - security_token - aws_security_token - access_token description: - AWS STS session token for use with temporary credentials. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variables may also be used in decreasing order of preference. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with the parameter being renamed from I(security_token) to I(session_token) in release 6.0.0. - The I(security_token), I(aws_security_token), and I(access_token) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables has been deprecated and will be removed in a release after 2024-12-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 validate_certs: default: true description: - When set to C(false), SSL certificates will not be validated for communication with the AWS APIs. - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider setting I(aws_ca_bundle) instead. 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: false description: - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action") API calls made during a task, outputing the set to the resource_actions key in the task results. Use the C(aws_resource_action) callback to output to total list made during a playbook. - The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used. type: bool