community.aws.api_gateway_domain 模块 – 管理 AWS API Gateway 自定义域名

注意

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

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

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

要在剧本中使用它，请指定： community.aws.api_gateway_domain。

community.aws 3.3.0 中的新增功能

摘要

• 管理 API 网关 REST API 的 API 网关自定义域名。

• AWS API 网关自定义域名设置在幕后使用 CloudFront。因此，您将获得一个 CloudFront 分布作为结果，配置为与您的域名关联。

• 在 5.0.0 版本之前，此模块称为 community.aws.aws_api_gateway_domain。用法没有改变。

别名：aws_api_gateway_domain

要求

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

• 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 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 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。
certificate_arn 字符串 / 必需	AWS 证书管理器 (ACM) TLS 证书 ARN。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 日志记录器来解析在任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到在剧本期间进行的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
domain_mappings 列表 / 元素=字典 / 必需	将您的域名基路径映射到您之前创建的 API 网关 REST API。使用提供的 API 设置 ID 和发布阶段。 domain_mappings 应为包含三个键的字典列表：base_path、rest_api_id 和 stage。 示例：[{ base_path: v1, rest_api_id: abc123, stage: production }] 如果您希望基路径仅为 /，则完全省略参数或将其设置为空字符串。
domain_name 字符串 / 必需	您希望用于 API 网关部署的域名。
endpoint_type 字符串	域的 API 端点配置。对于边缘优化的端点，使用 EDGE；或者使用 REGIONAL 或 PRIVATE。 选项 "EDGE" ← (默认) "REGIONAL" "PRIVATE"
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 后的某个版本中删除。
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 选项互斥。
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-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 后的某个版本中删除。
security_policy 字符串	通过 AWS 定义的策略设置允许的 TLS 版本。目前仅提供 TLS_1_0 和 TLS_1_2。 选项 "TLS_1_0" "TLS_1_2" ← (默认)
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"
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑改用 aws_ca_bundle。 选项 false true ← (默认)

备注

注意

• 不会在 Route53 上创建 DNS 条目，为此，请使用 community.aws.route53 模块。

• 仅支持来自 AWS ACM 的 TLS 证书，这些证书可以通过 ARN 引用，而 AWS API 仍然提供（已弃用）选项来添加自己的证书。

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

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

示例

- name: Setup endpoint for a custom domain for your API Gateway HTTP API
  community.aws.api_gateway_domain:
    domain_name: myapi.foobar.com
    certificate_arn: 'arn:aws:acm:us-east-1:1231123123:certificate/8bd89412-abc123-xxxxx'
    security_policy: TLS_1_2
    endpoint_type: EDGE
    domain_mappings:
      - rest_api_id: abc123
        stage: production
    state: present
  register: api_gw_domain_result

- name: Create a DNS record for your custom domain on route 53 (using route53 module)
  community.aws.route53:
    record: myapi.foobar.com
    value: "{{ api_gw_domain_result.response.domain.distribution_domain_name }}"
    type: A
    alias: true
    zone: foobar.com
    alias_hosted_zone_id: "{{ api_gw_domain_result.response.domain.distribution_hosted_zone_id }}"
    command: create

返回值

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

键

描述

response 字典

boto3 的 create_domain_name（或 update 和 delete）和 create_base_path_mapping 方法返回的数据。 返回：成功 示例： {"domain": {"certificate_arn": "arn:aws:acm:xxxxxx", "distribution_domain_name": "xxxx.cloudfront.net", "distribution_hosted_zone_id": "ABC123123", "domain_name": "mydomain.com", "domain_name_status": "AVAILABLE", "endpoint_configuration": {"types": ["EDGE"]}, "security_policy": "TLS_1_2", "tags": {}}, "path_mappings": [{"base_path": "(empty)", "rest_api_id": "abcd123", "stage": "production"}]}

作者

• Stefan Horning (@stefanhorning)

收藏链接

• 问题追踪器
• 代码库（源码）
• 沟通