amazon.aws.route53_zone 模块 – 添加或删除 Route 53 区域

注意

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

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

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

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

amazon.aws 5.0.0 中的新增功能

概要

• 创建和删除 Route 53 私有和公共区域。

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

要求

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

• 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。
comment 字符串	与区域关联的注释。 默认值： ""
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 日志记录器来解析任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间进行的总列表。 还可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认值) true
delegation_set_id 字符串	要与区域关联的可重用委派集 ID。 请注意，您不能将可重用委派集与私有托管区域关联。
endpoint_url 别名：ec2_url、aws_endpoint_url、s3_url 字符串	连接到的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 还可以按优先级递减的顺序使用 AWS_URL 或 EC2_URL 环境变量。 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的一个版本中删除。 EC2_URL 环境变量的支持已弃用，将在 2024-12-01 之后的一个版本中删除。
hosted_zone_id 字符串	要删除的唯一区域标识符，如果有多个具有相同域名名称的区域，则为“all”。 如果有多个使用上述选项标识的区域，则为必填项。
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 选项互斥。
purge_tags 布尔值	如果 purge_tags=true 并且设置了 tags，则将从资源中清除现有标签以完全匹配 tags 参数定义的内容。 如果未设置 tags 参数，则即使 purge_tags=True，也不会修改标签。 以aws:开头的标签键由 Amazon 保留，无法修改。因此，在purge_tags参数中将忽略这些键。更多信息请参见 Amazon 文档https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions。 选项 false true ← (默认)
区域 (region) 别名：aws_region, ec2_region 字符串	要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全球服务，将忽略区域。 也可以使用AWS_REGION或EC2_REGION环境变量。 更多信息请参见 Amazon AWS 文档http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。 ec2_region别名已弃用，将在 2024-12-01 后发布的版本中移除。 对EC2_REGION环境变量的支持已弃用，将在 2024-12-01 后发布的版本中移除。
密钥 (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-01 后发布的版本中移除。 对EC2_SECRET_KEY环境变量的支持已弃用，将在 2024-12-01 后发布的版本中移除。
会话令牌 (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-01 后发布的版本中移除。 对EC2_SECRET_KEY和AWS_SECURITY_TOKEN环境变量的支持已弃用，将在 2024-12-01 后发布的版本中移除。
状态 (state) 字符串	区域是否存在。 选项 "present" ← (默认) "absent"
标签 (tags) 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置tags参数，则不会修改标签。
验证证书 (validate_certs) 布尔值	设置为false时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置validate_certs=false，作为替代方案，请考虑设置aws_ca_bundle。 选项 false true ← (默认)
VPC ID (vpc_id) 字符串	区域应属于的 VPC ID（如果这是一个私有区域）。
VPC 区域 (vpc_region) 字符串	区域应属于的 VPC 区域（如果这是一个私有区域）。
VPCs (vpcs) 列表 / 元素=字典 amazon.aws 5.3.0 中添加	区域应属于的 VPC（如果这是一个私有区域）。
ID (id) 字符串 / 必需	VPC 的 ID。
区域 (region) 字符串 / 必需	VPC 的区域。
区域 (zone) 字符串 / 必需	DNS 区域记录（例如：foo.com.）

注释

注意

• 在 2.1.0 版本中添加了对tags和purge_tags的支持。

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

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

示例

- name: create a public zone
  amazon.aws.route53_zone:
    zone: example.com
    comment: this is an example

- name: delete a public zone
  amazon.aws.route53_zone:
    zone: example.com
    state: absent

- name: create a private zone
  amazon.aws.route53_zone:
    zone: devel.example.com
    vpc_id: '{{ myvpc_id }}'
    vpc_region: us-west-2
    comment: developer domain

- name: create a private zone with multiple associated VPCs
  amazon.aws.route53_zone:
    zone: crossdevel.example.com
    vpcs:
      - id: vpc-123456
        region: us-west-2
      - id: vpc-000001
        region: us-west-2
    comment: developer cross-vpc domain

- name: create a public zone associated with a specific reusable delegation set
  amazon.aws.route53_zone:
    zone: example.com
    comment: reusable delegation set example
    delegation_set_id: A1BCDEF2GHIJKL

- name: create a public zone with tags
  amazon.aws.route53_zone:
    zone: example.com
    comment: this is an example
    tags:
      Owner: Ansible Team

- name: modify a public zone, removing all previous tags and adding a new one
  amazon.aws.route53_zone:
    zone: example.com
    comment: this is an example
    tags:
      Support: Ansible Community
    purge_tags: true

返回值

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

键 (Key)	描述
comment 字符串	可选的托管区域注释。 返回：托管区域存在时 示例："Private zone"
delegation_set_id 字符串	关联的可重用委派集的 ID。 返回：对于公共托管区域，如果它们已与可重用委派集关联 示例："A1BCDEF2GHIJKL"
名称 (name) 字符串	托管区域名称。 返回：托管区域存在时 示例："private.local."
私有区域 (private_zone) 布尔值	托管区域是私有的还是公共的。 返回：托管区域存在时 示例：true
标签 (tags) 字典	与区域关联的标签。 返回：定义标签时
VPC ID (vpc_id) 字符串	附加到私有托管区域的第一个 VPC 的 ID（使用 vpcs 来关联多个）。 返回：对于私有托管区域 示例："vpc-1d36c84f"
VPC 区域 (vpc_region) 字符串	附加到私有托管区域的第一个 VPC 的区域（使用 vpcs 来关联多个）。 返回：对于私有托管区域 示例："eu-west-1"
VPCs (vpcs) 列表 / 元素=字典 amazon.aws 5.3.0 中添加	附加到私有托管区域的 VPC 列表。 返回：对于私有托管区域 示例："[{'id': 'vpc-123456', 'region': 'us-west-2'}]"
ID (id) 字符串	VPC 的 ID。 返回：对于私有托管区域 示例："vpc-123456"
区域 (region) 字符串	VPC 的区域。 返回：对于私有托管区域 示例："eu-west-2"
区域 ID (zone_id) 字符串	托管区域 ID。 返回：托管区域存在时 示例："Z6JQG9820BEFMW"

作者

• Christopher Troup (@minichate)

集合链接

• 问题追踪器
• 代码库 (源代码)
• 沟通