amazon.aws.ec2_vpc_vgw 模块 – 创建和删除 AWS VPN 虚拟网关

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要

• 创建 AWS VPN 虚拟网关。

• 删除 AWS VPN 虚拟网关。

• 将虚拟网关附加到 VPC。

• 将虚拟网关从 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 之后的一个版本中删除。
asn 整数	Amazon 端的 BGP ASN。
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 之后的一个版本中删除。
name 字符串	要创建或删除的 VGW 的名称。
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 月 1 日之后的版本中删除。 对 EC2_REGION 环境变量的支持已弃用，并将在 2024 年 12 月 1 日之后的版本中删除。
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 月 1 日之后的版本中删除。 对 EC2_SECRET_KEY 环境变量的支持已弃用，并将在 2024 年 12 月 1 日之后的版本中删除。
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 月 1 日之后的版本中删除。 对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已弃用，并将在 2024 年 12 月 1 日之后的版本中删除。
state 字符串	present 用于确保资源已创建。 absent 用于删除资源。 选项 "present" ← (默认) "absent"
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置 tags 参数，则不会修改标签。
type 字符串	要创建的虚拟网关的类型。 选项 "ipsec.1" ← (默认)
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)
vpc_id 字符串	要附加或分离到 VGW 的 VPC 的 ID。
vpn_gateway_id 字符串	现有虚拟网关的 VPN 网关 ID。
wait_timeout 整数	在 VPC 附加和分离期间等待状态的秒数。 默认值： 320

注释

注意

• 对 purge_tags 的支持已在 4.0.0 版本中添加。

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

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

示例

- name: Create a new VGW attached to a specific VPC
  amazon.aws.ec2_vpc_vgw:
    state: present
    region: ap-southeast-2
    profile: personal
    vpc_id: vpc-12345678
    name: personal-testing
    type: ipsec.1

- name: Create a new unattached VGW
  amazon.aws.ec2_vpc_vgw:
    state: present
    region: ap-southeast-2
    profile: personal
    name: personal-testing
    type: ipsec.1
    tags:
      environment: production
      owner: ABC

- name: Remove a new VGW using the name
  amazon.aws.ec2_vpc_vgw:
    state: absent
    region: ap-southeast-2
    profile: personal
    name: personal-testing
    type: ipsec.1

- name: Remove a new VGW using the vpn_gateway_id
  amazon.aws.ec2_vpc_vgw:
    state: absent
    region: ap-southeast-2
    profile: personal
    vpn_gateway_id: vgw-3a9aa123

- name: Detach vpn gateway from VPC
  amazon.aws.ec2_vpc_vgw:
    state: present
    name: "{{ vgw_name }}"
    register: vgw

- name: Delete vpn gateway
  amazon.aws.ec2_vpc_vgw:
    state: absent
    vpn_gateway_id: '{{ vgw.vgw.id | default(vgw_id) }}'
    ignore_errors: true

返回值

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

键	描述
vgw 字典	有关虚拟专用网关的信息。 返回：成功
id 字符串	虚拟专用网关的 ID。 返回：成功 示例： "vgw-0123456789abcdef0"
state 字符串	虚拟专用网关的当前状态。 返回：成功 示例： "available"
tags 字典	表示附加到虚拟专用网关的标签的字典。 返回：成功 示例： {"Env": "Dev_Test_001", "Name": "ansible-test-ec2-vpc-vgw"}
type 字符串	虚拟专用网关支持的 VPN 连接类型。 返回：成功 示例： "ipsec.1"
vpc_id 字符串	VPC 的 ID。 返回：成功 示例： "vpc-123456789abcdef01"

作者

• Nick Aslanidis (@naslanidis)

集合链接

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