amazon.aws.ec2_transit_gateway 模块 – 创建和删除 AWS Transit Gateway

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要

• 创建 AWS Transit Gateway。

• 删除 AWS Transit Gateway。

• 更新现有 Transit 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 之后的一个版本中删除。
asn 整数	Amazon 端 BGP 会话的专用自治系统编号 (ASN)。 对于 16 位 ASN，范围是 64512 到 65534；对于 32 位 ASN，范围是 4200000000 到 4294967294。
auto_associate 布尔值	启用或禁用与默认关联路由表自动关联。 选项 false true ← (默认)
auto_attach 布尔值	启用或禁用自动接受附件请求。 选项 false ← (默认) true
auto_propagate 布尔值	启用或禁用将路由自动传播到默认传播路由表。 选项 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
description 字符串	Transit Gateway 的描述。
dns_support 布尔值	是否启用 AWS DNS 支持。 选项 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 之后的一个版本中删除。
multicast_support 布尔值 amazon.aws 8.1.0 中新增	是否启用 AWS 多播支持。仅在创建 Transit Gateway 时有效。 选项 false true
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 之后的发行版中删除。
state 字符串	present 用于确保创建资源。 absent 用于删除资源。 选项 "present" ← (默认) "absent"
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置 tags 参数，则标签不会被修改。
transit_gateway_id 字符串	Transit Gateway 的 ID。
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑改为设置 aws_ca_bundle。 选项 false true ← (默认)
vpn_ecmp_support 布尔值	启用或禁用等成本多路径协议支持。 选项 false true ← (默认)
wait 布尔值	是否等待状态。 选项 false true ← (默认)
wait_timeout 整数	等待状态的秒数。 默认值： 300

注释

注意

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

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

示例

- name: Create a new transit gateway using defaults
  amazon.aws.ec2_transit_gateway:
    state: present
    region: us-east-1
    description: personal-testing
  register: created_tgw

- name: Create a new transit gateway with options
  amazon.aws.ec2_transit_gateway:
    asn: 64514
    auto_associate: false
    auto_propagate: false
    multicast_support: true
    dns_support: true
    description: "nonprod transit gateway"
    purge_tags: false
    state: present
    region: us-east-1
    tags:
      Name: nonprod transit gateway
      status: testing

- name: Remove a transit gateway by description
  amazon.aws.ec2_transit_gateway:
    state: absent
    region: us-east-1
    description: personal-testing

- name: Remove a transit gateway by id
  amazon.aws.ec2_transit_gateway:
    state: absent
    region: ap-southeast-2
    transit_gateway_id: tgw-3a9aa123
  register: deleted_tgw

返回值

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

键	描述
transit_gateway 字典	Transit Gateway 的属性。 返回： state=present
creation_time 字符串	Transit Gateway 的创建时间。 返回： 始终返回 示例： "2019-03-06T17:13:51+00:00"
description 字符串	Transit Gateway 的描述。 返回： 始终返回 示例： "my test tgw"
options 字典	Transit Gateway 的 options 属性。 返回： 始终返回
amazon_side_asn 字符串	BGP 会话 Amazon 端的专用自治系统编号 (ASN)。对于 16 位 ASN，范围是 64512 到 65534；对于 32 位 ASN，范围是 4200000000 到 4294967294。 返回： 始终返回 示例： "64512"
association_default_route_table_id 字符串	默认关联路由表的 ID。 返回：存在时返回 示例： "tgw-rtb-abc123444"
auto_accept_shared_attachements 字符串	指示是否自动接受附件请求。 返回： 始终返回 示例： "disable"
default_route_table_association 字符串	指示资源附件是否自动与默认关联路由表关联。 返回： 始终返回 示例： "enable"
default_route_table_propagation 字符串	指示资源附件是否自动将路由传播到默认传播路由表。 返回： 始终返回 示例： "disable"
dns_support 字符串	指示是否启用了 DNS 支持。 返回： 始终返回 示例： "enable"
multicast_support 字符串 在 amazon.aws 7.3.0 中添加	指示是否启用了多播支持。 返回： 始终返回 示例： "enable"
propagation_default_route_table_id 字符串	默认传播路由表的 ID。 返回：存在时返回 示例： "tgw-rtb-def456777"
vpn_ecmp_support 字符串	指示是否启用了等成本多路径协议支持。 返回： 始终返回 示例： "enable"
owner_id 字符串	拥有 Transit Gateway 的帐户。 返回： 始终返回 示例： "123456789012"
state 字符串	Transit Gateway 的状态。 返回： 始终返回 示例： "pending"
tags 字典	资源标签的字典。 返回： 始终返回 示例： {"tags": {"Name": "nonprod_tgw"}}
transit_gateway_arn 字符串	Transit Gateway 的 ID。 返回： 始终返回 示例： "tgw-3a9aa123"
transit_gateway_id 字符串	Transit Gateway 的 ID。 返回： 始终返回 示例： "tgw-3a9aa123"

作者

• Bob Boldin (@BobBoldin)

集合链接

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