amazon.aws.ec2_transit_gateway_vpc_attachment 模块 – 创建和删除 AWS Transit Gateway VPC 连接

注意

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

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

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

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

community.aws 4.0.0 中的新增功能

概要

• 创建、删除和更新 AWS Transit Gateway 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_access_key_id 别名是在 5.1.0 版本中添加的，以与 AWS botocore SDK 保持一致。 ec2_access_key 别名已弃用，并将在 2024-12-01 之后的一个版本中删除。 EC2_ACCESS_KEY 环境变量的支持已弃用，并将在 2024-12-01 之后的一个版本中删除。
appliance_mode_support 布尔值	连接是否配置为设备模式。 启用设备模式后，Transit Gateway 将使用 IP 数据包的 4 元组，在设备 VPC 中为流的整个生命周期选择单个 Transit Gateway ENI 来发送流量。 选项 false true
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。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 日志记录器来解析在任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间进行的总列表。 还可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
dns_support 布尔值	是否启用 DNS 支持。 选项 false true
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 后发布的版本中移除。
id 别名：attachment_id 字符串	Transit Gateway 附加的 ID。 当未设置 id 时，将使用 transit_gateway 和 name 执行搜索。如果返回多个结果，模块将失败。 必须至少提供 name、transit_gateway 和 id 中的一个。
ipv6_support 布尔值	是否启用 IPv6 支持。 选项 false true
name 字符串	Transit Gateway 附加的 Name 标签。 同时提供 id 和 name 将在匹配 id 的现有附加中设置 Name 标签。 在 tags 中设置 Name 标签也将导致 Name 标签被更新。 必须至少提供 name、transit_gateway 和 id 中的一个。
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_subnets 布尔值	如果 purge_subnets=true，则将根据需要从附加中移除现有子网，以完全匹配 subnets 定义的内容。 选项 false true ← (默认)
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 后发布的版本中移除。
state 字符串	创建或移除 Transit Gateway 附加。 选项 "present" ← (默认) "absent"
subnets 列表 / 元素=字符串	要在其中创建 Transit Gateway VPC 附加的子网的 ID。 创建新的附加时必填。
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置 tags 参数，则不会修改标签。
transit_gateway 别名：transit_gateway_id 字符串	附加所属的 Transit Gateway 的 ID。 创建新的附加时，必须提供 transit_gateway。 必须至少提供 name、transit_gateway 和 id 中的一个。 transit_gateway 是一个不可变的设置，无法在现有附加上更新。
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑改为设置 aws_ca_bundle。 选项 false true ← (默认)
wait 布尔值	模块返回之前是否等待 Transit Gateway 附加达到 Available 或 Deleted 状态。 选项 false true ← (默认)
wait_timeout 整数	等待 Transit Gateway 附加达到预期状态的最大时间（秒）。 默认为 600 秒。 默认： 600

注释

注意

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

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

示例

- name: Create a Transit Gateway attachment
  amazon.aws.ec2_transit_gateway_vpc_attachment:
    state: "present"
    transit_gateway: "tgw-123456789abcdef01"
    name: "AnsibleTest-1"
    subnets:
      - "subnet-00000000000000000"
      - "subnet-11111111111111111"
      - "subnet-22222222222222222"
    ipv6_support: true
    purge_subnets: true
    dns_support: true
    appliance_mode_support: true
    tags:
      TestTag: "changed data in Test Tag"

- name: Set sub options on a Transit Gateway attachment
  amazon.aws.ec2_transit_gateway_vpc_attachment:
    state: "present"
    id: "tgw-attach-0c0c5fd0b0f01d1c9"
    name: "AnsibleTest-1"
    ipv6_support: true
    purge_subnets: false
    dns_support: false
    appliance_mode_support: true

- name: Delete the transit gateway
  amazon.aws.ec2_transit_gateway_vpc_attachment:
    state: "absent"
    id: "tgw-attach-0c0c5fd0b0f01d1c9"

返回值

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

键	描述
attachments 列表 / 元素=字典	Transit Gateway 连接的属性。 返回：成功
creation_time 字符串	连接创建时间的 ISO 8601 日期时间戳。 返回：成功 示例： "2022-03-10T16:40:26+00:00"
options 字典	附加的 VPC 连接选项。 返回：成功
appliance_mode_support 字符串	指示是否启用了设备模式支持。 返回：成功 示例： "enable"
dns_support 字符串	指示是否启用了 DNS 支持。 返回：成功 示例： "disable"
ipv6_support 字符串	指示是否禁用了 IPv6 支持。 返回：成功 示例： "disable"
security_group_referencing_support 字符串	指示是否禁用了安全组引用支持。 返回：成功 示例： "enable"
state 字符串	连接的状态。 返回：成功 示例： "deleting"
subnet_ids 列表 / 元素=字符串	连接使用的子网 ID。 返回：成功 示例： ["subnet-0123456789abcdef0", "subnet-11111111111111111"]
tags 字典	表示资源标签的字典。 返回：成功
transit_gateway_attachment_id 字符串	连接的 ID。 返回：成功 示例： "tgw-attach-0c0c5fd0b0f01d1c9"
transit_gateway_id 字符串	连接到的 Transit Gateway 的 ID。 返回：成功 示例： "tgw-0123456789abcdef0"
vpc_id 字符串	连接到的 VPC 的 ID。 返回：成功 示例： "vpc-0123456789abcdef0"
vpc_owner_id 字符串	VPC 所属账户的 ID。 返回：成功 示例： "1234567890122"

作者

• Mark Chappell (@tremble)

• Alina Buzachis (@alinabuzachis)

收集链接

• 问题跟踪器
• 代码库（源代码）
• 通信