amazon.aws.route53_info 模块 – 使用 AWS 方法检索 Route 53 详情

注意

此模块是 amazon.aws 集合 (版本 9.0.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定： amazon.aws.route53_info。

amazon.aws 5.0.0 中的新增功能

概要

• 获取与 Route 53 区域、记录集或健康检查详情相关的各种详细信息。

• 此模块最初添加到 community.aws 的 1.0.0 版本中。

要求

执行此模块的主机需要以下要求。

• python >= 3.6

• boto3 >= 1.28.0

• botocore >= 1.31.0

参数

参数	注释
access_key 别名：aws_access_key_id，aws_access_key，ec2_access_key 字符串	AWS 访问密钥 ID。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 AWS_ACCESS_KEY_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量，优先级依次递减。 aws_access_key 和 profile 选项互斥。 为了与 AWS botocore SDK 保持一致，aws_access_key_id 别名在 5.1.0 版本中添加。 ec2_access_key 别名已弃用，将在 2024-12-01 后的某个版本中移除。 EC2_ACCESS_KEY 环境变量的支持已弃用，将在 2024-12-01 后的某个版本中移除。
aws_ca_bundle 路径	验证 SSL 证书时要使用的 CA 证书包的位置。 也可以使用 AWS_CA_BUNDLE 环境变量。
aws_config 字典	用于修改 botocore 配置的字典。 参数可在 AWS 文档中找到 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。
change_id 字符串	变更批处理请求的 ID。 您在此处指定的值是在您提交请求时 ChangeResourceRecordSets 在 Id 元素中返回的值。 如果 query=change，则需要此参数。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 日志记录器来解析在任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调函数将输出到 playbook 期间进行的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
delegation_set_id 字符串	DNS 区域委派集 ID。
dns_name 字符串	您希望 list_command 开始列出的域名按字典顺序排列的第一个名称。
endpoint_url 别名：ec2_url，aws_endpoint_url，s3_url 字符串	连接到默认 AWS 端点以外的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次递减。 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 后的某个版本中移除。 EC2_URL 环境变量的支持已弃用，将在 2024-12-01 后的某个版本中移除。
health_check_id 字符串	健康检查的 ID。 如果 query 设置为 health_check 并且 health_check_method 设置为 details 或 status 或 failure_reason，则需要此参数。
health_check_method 字符串	这与 query: health_check 结合使用。它允许列出各种健康检查详细信息的详细信息、计数或标签。 选项 "list" ← (默认) "details" "status" "failure_reason" "count" "tags"
hosted_zone_id 字符串	DNS 区域的托管区域 ID。 如果 query 设置为 hosted_zone 并且 hosted_zone_method 设置为 details，则需要此参数。 如果 query 设置为 record_sets，则需要此参数。
hosted_zone_method 字符串	此参数与 query: hosted_zone 结合使用。它允许列出各种托管区域详细信息的详情、计数或标签。 选项 "details" "list" ← (默认) "list_by_name" "count" "tags"
max_items 整数	针对各种 get/list 请求返回的项目最大数量。
next_marker 字符串	某些请求（例如 list_command: hosted_zones）将返回最大数量的条目 - 例如 100 或 max_items 指定的数量。如果条目数量超过此最大值，可以使用第一个响应中的 NextMarker 条目发送另一个请求以获取下一页结果。
profile 别名：aws_profile 字符串	用于身份验证的命名 AWS 配置文件。 有关命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 AWS_PROFILE 环境变量。 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。
query 字符串 / 必需	指定要执行的查询操作。 选项 "change" "checker_ip_range" "health_check" "hosted_zone" "record_sets" "reusable_delegation_set"
region 别名：aws_region, ec2_region 字符串	要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全球服务，将忽略 region。 也可以使用 AWS_REGION 或 EC2_REGION 环境变量。 有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。 ec2_region 别名已弃用，将在 2024 年 12 月 1 日后的版本中移除。 EC2_REGION 环境变量的支持已弃用，将在 2024 年 12 月 1 日后的版本中移除。
resource_id 别名：resource_ids 列表 / 元素=字符串	指定资源的 ID。 如果 query=health_check 和 health_check_method=tags，则需要此参数。 如果 query=hosted_zone 和 hosted_zone_method=tags，则需要此参数。
secret_key 别名：aws_secret_access_key, aws_secret_key, ec2_secret_key 字符串	AWS 密钥。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 AWS_SECRET_ACCESS_KEY、AWS_SECRET_KEY 或 EC2_SECRET_KEY 环境变量（按优先级递减顺序）。 secret_key 和 profile 选项互斥。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 ec2_secret_key 别名已弃用，将在 2024 年 12 月 1 日后的版本中移除。 EC2_SECRET_KEY 环境变量的支持已弃用，将在 2024 年 12 月 1 日后的版本中移除。
session_token 别名：aws_session_token, security_token, aws_security_token, access_token 字符串	与临时凭据一起使用的 AWS STS 会话令牌。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 AWS_SESSION_TOKEN、AWS_SECURITY_TOKEN 或 EC2_SECURITY_TOKEN 环境变量（按优先级递减顺序）。 security_token 和 profile 选项互斥。 在 3.2.0 版本中添加了 aws_session_token 和 session_token 别名，在 6.0.0 版本中将参数名称从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已弃用，将在 2024 年 12 月 1 日后的版本中移除。 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已弃用，将在 2024 年 12 月 1 日后的版本中移除。
start_record_name 字符串	您希望 list_command: record_sets 开始列出的域名按字典顺序排列的第一个名称。
type 字符串	DNS 记录的类型。 选项 "A" "CNAME" "MX" "AAAA" "TXT" "PTR" "SRV" "SPF" "CAA" "NS" "NAPTR" "SOA" "DS"
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)

备注

注意

• 注意：对于模块，环境变量和配置文件是从 Ansible 的“主机”上下文而不是“控制器”上下文读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible 的“控制器”上下文而不是“主机”上下文读取的。

• Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible “主机”上下文中的配置文件（通常为 ~/.aws/credentials）读取凭据和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

# Simple example of listing all hosted zones
- name: List all hosted zones
  amazon.aws.route53_info:
    query: hosted_zone
  register: hosted_zones

# Getting a count of hosted zones
- name: Return a count of all hosted zones
  amazon.aws.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
  amazon.aws.route53_info:
    profile: account_name
    query: record_sets
    hosted_zone_id: ZZZ1111112222
    max_items: 20
  register: record_sets

- name: List first 20 health checks
  amazon.aws.route53_info:
    query: health_check
    health_check_method: list
    max_items: 20
  register: health_checks

- name: Get health check last failure_reason
  amazon.aws.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
  amazon.aws.route53_info:
    query: reusable_delegation_set
    delegation_set_id: delegation id
  register: delegation_sets

- name: setup of example for using next_marker
  amazon.aws.route53_info:
    query: hosted_zone
    max_items: 1
  register: first_info

- name: example for using next_marker
  amazon.aws.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
      amazon.aws.route53_zone:
        zone: "test.io"
      register: AWSINFO

    - name: grab Route53 record information
      amazon.aws.route53_info:
        type: A
        query: record_sets
        hosted_zone_id: "{{ AWSINFO.zone_id }}"
        start_record_name: "host1.workshop.test.io"
      register: RECORDS

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键	描述
checker_ip_ranges 列表 / 元素=字符串 在 community.aws 4.1.0 中添加	Amazon Route 53 健康检查程序的 CIDR 格式 IP 范围列表。 返回：当 query=checker_ip_range
CheckerIpRanges 列表 / 元素=字符串	Amazon Route 53 健康检查程序的已弃用的驼峰式大小写 IP 范围列表。此列表包含与其上面提到的蛇形大小写版本相同的元素/参数。此字段已弃用，将在 6.0.0 版本中移除。 返回：当 query=checker_ip_range
delegation_sets 列表 / 元素=字典 在 community.aws 4.1.0 中添加	包含有关可重用委派集信息的字典列表。 返回：当 query=reusable_delegation_set
DelegationSets 列表 / 元素=字典	已弃用的驼峰式大小写字典列表，其中包含有关可重用委派集的信息。此列表包含与其上面提到的蛇形大小写版本相同的元素/参数。此字段已弃用，将在 6.0.0 版本中移除。 返回：当 query=reusable_delegation_set
health_check 字典 在 community.aws 4.1.0 中添加	boto3 中 get_health_check 返回的 Route53 健康检查详细信息字典。 返回：当 query=health_check 和 health_check_method=details
caller_reference 字符串	创建健康检查时指定的唯一字符串。 返回：成功 示例： "01d0db12-x0x9-12a3-1234-0z000z00zz0z"
health_check_config 字典	包含有关一个健康检查的详细信息的字典。 返回：成功
disabled 布尔值	Route53 是否应停止对端点执行健康检查。 返回：成功 示例： false
enable_sni 布尔值	Route53 是否应在 TLS 协商期间将 FullyQualifiedDomainName 的值发送到 client_hello 消息中的端点。 返回：成功 示例： true
failure_threshold 整数	端点必须连续通过/失败的健康检查次数，Route53 才能更改端点的当前状态。 返回：成功 示例： 3
fully_qualified_domain_name 字符串	Route53 执行健康检查的端点的完全限定 DNS 名称。 返回：成功 示例： "hello"
inverted 布尔值	Route53 是否应反转健康检查的状态。 返回：成功 示例： false
ip_address 字符串	Route53 应在其上执行健康检查的端点的 IPv4/IPv6 IP 地址。 返回：成功 示例： "192.0.2.44"
measure_latency 布尔值	Route53 是否应测量多个 AWS 区域中的健康检查程序与端点之间的延迟。 返回：成功 示例： false
port 整数	Route53 应在其上执行健康检查的端点的端口。 返回：成功 示例： 80
request_interval 整数	Route53 从端点获取响应与下一个健康检查请求之间的时间间隔（以秒为单位）。 返回：成功 示例： 30
resource_path 字符串	Route53 执行健康检查时请求的路径。 返回：成功 示例： "/welcome.html"
search_string 字符串	Route53 用于在指定资源的响应正文中搜索的字符串。 返回：成功 示例： "test-string-to-match"
type 字符串	健康检查的类型。 返回：成功 示例： "HTTPS"
health_check_version 字符串	健康检查的版本。 返回：成功 示例： "1"
id 字符串	Amazon Route 53 在创建时分配给健康检查的标识符。 返回：成功 示例： "12345cdc-2cc4-1234-bed2-123456abc1a2"
health_check_observations 列表 / 元素=字典 新增于 amazon.aws 5.4.0	boto3 中 get_health_check_status 和 get_health_check_last_failure_reason 返回的 Route53 健康检查详情字典。 返回值：当 query=health_check 和 health_check_method=status 或 health_check_method=failure_reason 时
ip_address 字符串	在 StatusReport 中提供故障原因的 Amazon Route 53 健康检查器的 IP 地址。 返回：成功 示例： "12.345.67.89"
region 字符串	在 StatusReport 中提供状态的 Amazon Route 53 健康检查器的区域。 返回：成功 示例： "us-west-1"
status_report 字典	包含上次故障原因和故障健康检查时间的复杂类型。 返回：成功
checked_time 字符串	健康检查器执行健康检查的日期和时间，采用 ISO 8601 格式和协调世界时 (UTC)。 返回：成功 示例： "2023-03-08T23:10:08.452000+00:00"
status 字符串	由 Amazon Route 53 健康检查器之一报告的健康检查端点的状态描述。 返回：成功 示例： "Failure: Resolved IP: 12.345.67.89. The connection was closed by the endpoint."
health_checks 列表 / 元素=字典 新增于 community.aws 4.0.0	boto3 中 list_health_checks 返回的 Route 53 健康检查列表。 返回值：当 query=health_check 时
caller_reference 字符串	创建健康检查时指定的唯一字符串。 返回：成功 示例： "01d0db12-x0x9-12a3-1234-0z000z00zz0z"
health_check_config 字典	包含有关一个健康检查的详细信息的字典。 返回：成功
disabled 布尔值	Route53 是否应停止对端点执行健康检查。 返回：成功 示例： false
enable_sni 布尔值	Route53 是否应在 TLS 协商期间将 FullyQualifiedDomainName 的值发送到 client_hello 消息中的端点。 返回：成功 示例： true
failure_threshold 整数	端点必须连续通过/失败的健康检查次数，Route 53 才更改端点的当前状态。 返回：成功 示例： 3
fully_qualified_domain_name 字符串	Route53 执行健康检查的端点的完全限定 DNS 名称。 返回：成功 示例： "hello"
inverted 布尔值	Route53 是否应反转健康检查的状态。 返回：成功 示例： false
ip_address 字符串	Route53 应在其上执行健康检查的端点的 IPv4/IPv6 IP 地址。 返回：成功 示例： "192.0.2.44"
measure_latency 布尔值	Route53 是否应测量多个 AWS 区域中的健康检查程序与端点之间的延迟。 返回：成功 示例： false
port 整数	Route53 应在其上执行健康检查的端点的端口。 返回：成功 示例： 80
request_interval 整数	Route53 从端点获取响应与下一个健康检查请求之间的时间间隔（以秒为单位）。 返回：成功 示例： 30
resource_path 字符串	Route53 执行健康检查时请求的路径。 返回：成功 示例： "/welcome.html"
search_string 字符串	Route 53 用于在指定资源的响应正文中搜索的字符串。 返回：成功 示例： "test-string-to-match"
type 字符串	健康检查的类型。 返回：成功 示例： "HTTPS"
health_check_version 字符串	健康检查的版本。 返回：成功 示例： "1"
id 字符串	Amazon Route53 在创建时分配给健康检查的标识符。 返回：成功 示例： "12345cdc-2cc4-1234-bed2-123456abc1a2"
HealthCheck 字典	boto3 中 get_health_check 返回的已弃用的驼峰式命名 Route53 健康检查详情字典。此字典包含与其上面提到的蛇形命名版本相同的元素/参数。此字段已弃用，将在 6.0.0 版本中移除。 返回：当 query=health_check 和 health_check_method=details
HealthChecks 列表 / 元素=字典	boto3 中 list_health_checks 返回的已弃用的驼峰式命名 Route53 健康检查列表。此列表包含与其上面提到的蛇形命名版本相同的元素/参数。此字段已弃用，将在 6.0.0 版本中移除。 返回值：当 query=health_check 时
hosted_zones 列表 / 元素=字典 新增于 community.aws 4.0.0	boto3 中 list_hosted_zones 返回的托管区域列表。 返回值：当 query=hosted_zone 时
caller_reference 字符串	在创建托管区域时为 CallerReference 指定的值。 返回：成功 示例： "01d0db12-x0x9-12a3-1234-0z000z00zz0z"
config 字典	包含 Comment 和 PrivateZone 元素的字典。 返回：成功
comment 字符串	关于托管区域的任何注释。 返回：成功 示例： "HostedZone created by Route53 Registrar"
private_zone 布尔值	指示这是否是私有托管区域的值。 返回：成功 示例： false
id 字符串	Amazon Route53 在创建时分配给托管区域的托管区域 ID。 返回：成功 示例： "/hostedzone/Z01234567AB1234567890"
name 字符串	域的名称。 返回：成功 示例： "example.io"
resource_record_set_count 整数	托管区域中资源记录集的数量。 返回：成功 示例： 3
HostedZones 列表 / 元素=字典	boto3 中 list_hosted_zones 返回的已弃用的驼峰式命名托管区域列表。此列表包含与其上面提到的蛇形命名版本相同的元素/参数。此字段已弃用，将在 6.0.0 版本中移除。 返回值：当 query=hosted_zone 时
resource_record_sets 列表 / 元素=字典 新增于 community.aws 4.0.0	boto3 中 list_resource_record_sets 返回的资源记录集列表。 返回值：当 query=record_sets 时
geo_location 字典	Route53 根据位置响应的指定地理位置。 返回：成功
continent_code 字符串	大陆的两位字母代码。 返回：成功 示例： "NA"
country_code 字符串	国家的两位字母代码。 返回：成功 示例： "US"
subdivision_code 字符串	美国的州的两位字母代码 返回：成功 示例： "NY"
name 字符串	指定托管区域中记录的名称。 返回：成功 示例： "www.example.com"
resource_records 列表 / 元素=字典	关于资源记录的信息。 返回：成功
value 字符串	当前或新的 DNS 记录值。 返回：成功 示例： "ns-12.awsdns-34.com."
set_identifier 字符串	区分具有相同名称和类型组合的多个资源记录集的标识符。 返回：成功 示例： "abcd"
ttl 整数	资源记录缓存生存时间 (TTL)，以秒为单位。 返回：成功 示例： 60
type 字符串	DNS 记录类型。 返回：成功 示例： "A"
ResourceRecordSets 列表 / 元素=字典	boto3 中 list_resource_record_sets 返回的已弃用的驼峰式命名资源记录集列表。此列表包含与其上面提到的蛇形命名版本相同的元素/参数。此字段已弃用，将在 6.0.0 版本中移除。 返回值：当 query=record_sets 时

作者

• Karen Cheng (@Etherdaemon)

资源链接

• 问题追踪器
• 代码仓库
• 沟通