community.aws.api_gateway 模块 – 管理 AWS API Gateway API

注意

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

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

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

要在 playbook 中使用它，请指定： community.aws.api_gateway。

community.aws 1.0.0 中的新增功能

概要

• 允许管理 API Gateway API。

• 通常情况下，您应该提供 api_id，因为 API 没有其他稳定的、有保证的唯一标识符。如果您不提供 api_id，则每次运行此操作时都会创建一个新的 API。

• swagger_file 和 swagger_text 直接透明地传递给 AWS，而 swagger_dict 是一个 Ansible 字典，在 API 定义上传之前将其转换为 JSON。

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

别名：aws_api_gateway

要求

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

• 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 之后的一个版本中删除。
api_id 字符串	要管理的 API 的 ID。
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。
cache_enabled 布尔值	启用 API 网关对后端响应的缓存。 选项 false ← (默认) true
cache_size 字符串	API 网关缓存的大小（以 GB 为单位），在 cache_enabled 为 true 时生效。 选项 "0.5" ← (默认) "1.6" "6.1" "13.5" "28.4" "58.2" "118" "237"
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析在任务期间发出的唯一（而不是总计）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间发出的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
deploy_desc 字符串	部署描述。 记录在 AWS 控制台中并可见。 默认值： "Automatic deployment by Ansible."
endpoint_type 字符串	端点配置类型。 对于边缘优化的 API 端点，使用 EDGE；对于区域部署，使用 REGIONAL；对于私有 API，使用 PRIVATE。 此标志仅在创建新的 API Gateway 设置时使用，不适用于更新。 选项 "EDGE" ← (默认) "REGIONAL" "PRIVATE"
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 之后的一个版本中删除。
lookup 字符串 在 community.aws 6.2.0 中添加	通过 tags（如果提供了 name，则也通过 name）或 api_id 来查找 API Gateway。 如果 lookup=tag 且未指定 tags，则不执行对现有 API Gateway 的查找，并将创建一个新的 API Gateway。 使用 lookup=tag 时，如果找到多个匹配项，则会失败，并且不会进行任何更改。 要更改 API Gateway 的标签，请使用 lookup=id。 选项 "tag" ← (默认) "id"
name 字符串 在 community.aws 6.2.0 中添加	RestApi 的名称。
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 等全局服务，忽略 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 之后的一个版本中删除。
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 之后的一个版本中删除。
stage 字符串	应将 API 部署到的阶段的名称。
stage_canary_settings 字典	阶段部署的金丝雀设置。 包含以下设置的字典 percentTraffic：转移到金丝雀部署的流量百分比 (0-100)。 deploymentId：金丝雀部署的 ID。 stageVariableOverrides：为金丝雀发布部署覆盖的阶段变量。 useStageCache：一个布尔标志，指示金丝雀部署是否使用阶段缓存。 请参阅文档 https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/apigateway.html#APIGateway.Client.create_stage 默认值： {}
stage_variables 字典	阶段的环境变量。定义键值对变量的字典。 默认值： {}
state 字符串	创建或删除 API Gateway。 选项 "present" ← (默认) "absent"
swagger_dict json	Swagger 定义 API ansible 字典，将转换为 JSON 并上传。
swagger_file 别名：src, api_file 路径	包含 API Swagger 定义的 JSON 或 YAML 文件。必须存在 swagger_file、swagger_text 或 swagger_dict 中的一个。
swagger_text 字符串	作为字符串的 API Swagger 定义（JSON 或 YAML），直接来自 playbook。
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置 tags 参数，则不会修改标签。
tracing_enabled 布尔值	指定是否为 API GW 阶段启用与 X-ray 的主动跟踪。 选项 false ← (默认) true
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方法，请考虑改为设置 aws_ca_bundle。 选项 false true ← (默认)

备注

注意

• 如果未提供api_id，则使用标签来唯一标识 API 网关。version_added=6.2.0

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

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

示例

- name: Setup AWS API Gateway setup on AWS and deploy API definition
  community.aws.api_gateway:
    swagger_file: my_api.yml
    stage: production
    cache_enabled: true
    cache_size: '1.6'
    tracing_enabled: true
    endpoint_type: EDGE
    state: present

- name: Update API definition to deploy new version
  community.aws.api_gateway:
    api_id: 'abc123321cba'
    swagger_file: my_api.yml
    deploy_desc: Make auth fix available.
    cache_enabled: true
    cache_size: '1.6'
    endpoint_type: EDGE
    state: present

- name: Update API definitions and settings and deploy as canary
  community.aws.api_gateway:
    api_id: 'abc123321cba'
    swagger_file: my_api.yml
    cache_enabled: true
    cache_size: '6.1'
    canary_settings:
      percentTraffic: 50.0
      deploymentId: '123'
      useStageCache: true
    state: present

- name: Delete API gateway
  amazon.aws.api_gateway:
    name: ansible-rest-api
    tags:
      automation: ansible
    lookup: tags
    state: absent

返回值

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

键	描述
api_id 字符串	已创建的 API 端点的 API ID 返回：成功 示例："0ln4zq7p86"
configure_response 字典	来自 API 配置调用的 AWS 响应 返回：成功 示例：{"api_key_source": "HEADER", "created_at": "2020-01-01T11:37:59+00:00", "id": "0ln4zq7p86"}
deploy_response 字典	来自 API 部署调用的 AWS 响应 返回：成功 示例：{"created_date": "2020-01-01T11:36:59+00:00", "description": "Automatic deployment by Ansible.", "id": "rptv4b"}
resource_actions 列表 / 元素=字符串	针对 AWS API 执行的操作 返回：始终 示例：["apigateway:CreateRestApi", "apigateway:CreateDeployment", "apigateway:PutRestApi"]

作者

• Michael De La Rue (@mikedlr)

集合链接

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