amazon.aws.ec2_transit_gateway_vpc_attachment_info 模块 – 描述 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_info。

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 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。
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 之后的版本中删除。
filters 字典	要应用的过滤器字典。每个字典项都包含一个过滤器键和一个过滤器值。 设置 tag:Name 过滤器将覆盖 name 参数。
id 别名: attachment_id 字符串	Transit Gateway 连接的 ID。 与 name 和 filters 互斥。
include_deleted 布尔值	如果 include_deleted=True，则还会返回已删除状态的连接。 设置 state 过滤器将覆盖 include_deleted 参数。 选项 false ←（默认） true
name 字符串	Transit Gateway 连接的 Name 标签。
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 secret access key。 有关访问令牌的更多信息，请参阅 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_secret_access_key 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 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 之后的版本中删除。
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑改为设置 aws_ca_bundle。 选项 false true ← (默认)

Notes

注意

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

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

Examples

- name: Describe a specific Transit Gateway attachment
  amazon.aws.ec2_transit_gateway_vpc_attachment_info:
    id: "tgw-attach-0123456789abcdef0"

- name: Describe all attachments attached to a transit gateway
  amazon.aws.ec2_transit_gateway_vpc_attachment_info:
    filters:
      transit-gateway-id: "tgw-0fedcba9876543210"

- name: Describe all attachments in an account
  amazon.aws.ec2_transit_gateway_vpc_attachment_info:

Return Values

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

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

Authors

• Mark Chappell (@tremble)

• Alina Buzachis (@alinabuzachis)

Collection links

• Issue Tracker
• Repository (Sources)
• 沟通