community.aws.ec2_carrier_gateway 模块 – 管理 AWS VPC 载波网关

注意

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

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

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

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

community.aws 6.0.0 中的新增功能

概要

• 管理 AWS VPC 载波网关。

要求

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

• 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。
carrier_gateway_id 字符串	用于管理载波网关的载波网关 ID。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 日志记录器来解析在任务期间进行的唯一（而不是全部）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间进行的全部列表。 还可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
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 之后的一个版本中移除。
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 保持一致，别名 aws_secret_access_key 在 5.1.0 版本中添加。 别名 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选项互斥。 别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，参数名称在 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 的 VPC ID。

注释

注意

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

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

示例

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Ensure that the VPC has an Carrier Gateway.
# The Carrier Gateway ID can be accessed via {{cagw.carrier_gateway_id}} for use in setting up Route tables etc.
- name: Create Carrier gateway
  community.aws.ec2_carrier_gateway:
    vpc_id: vpc-abcdefgh
    state: present
  register: cagw

- name: Create Carrier gateway with tags
  community.aws.ec2_carrier_gateway:
    vpc_id: vpc-abcdefgh
    state: present
    tags:
      Tag1: tag1
      Tag2: tag2
  register: cagw

- name: Delete Carrier gateway
  community.aws.ec2_carrier_gateway:
    vpc_id: vpc-abcdefgh
    carrier_gateway_id: "cagw-123"
    state: absent
  register: vpc_cagw_delete

返回值

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

键 (Key)	描述
carrier_gateway_id 字符串	载体网关的唯一标识符。 返回：state=present 示例："{'carrier_gateway_id': 'cagw-XXXXXXXX'}"
已更改 (changed) 布尔值	如果对载体网关进行了任何更改。 返回：始终 示例：{"changed": false}
标签 (tags) 字典	与载体网关关联的标签。 返回：state=present 示例：{"tags": {"Ansible": "Test"}}
VPC ID (vpc_id) 字符串	与载体网关关联的 VPC ID。 返回：state=present 示例："{'vpc_id': 'vpc-XXXXXXXX'}"

作者

• Marco Braga (@mtulio)

收藏链接

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