community.aws.directconnect_gateway 模块 – 管理 AWS Direct Connect 网关

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要

  • 创建 AWS Direct Connect 网关。

  • 删除 AWS Direct Connect 网关。

  • 将虚拟网关附加到 Direct Connect 网关。

  • 将虚拟网关从 Direct Connect 网关分离。

  • 在 5.0.0 版本之前，此模块称为 community.aws.aws_direct_connect_gateway。用法没有改变。

别名：aws_direct_connect_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 后的某个版本中删除。

amazon_asn

字符串

亚马逊端的 ASN。

当 state=present 时为必填项。

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

direct_connect_gateway_id

字符串

现有 Direct Connect 网关的 ID。

当 state=absent 时为必填项。

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 后的某个版本中删除。

name

字符串

要创建或删除的 Direct Connect 网关的名称。

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密钥访问密钥。

有关访问令牌的更多信息，请参阅 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之后的发行版中移除。

state

字符串

设置state=present以确保创建资源。

设置state=absent以删除资源。

选项

  • "present" ← (默认)

  • "absent"

validate_certs

布尔值

设置为false时，将不会验证与AWS API通信的SSL证书。

强烈建议不要设置validate_certs=false，作为替代方案，请考虑设置aws_ca_bundle。

选项

  • false

  • true ← (默认)

virtual_gateway_id

字符串

现有虚拟网关的VPN网关ID。

wait_timeout

整数

等待关联被删除的时间长度。

默认值： 320

注释

注意

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

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

示例

- name: Create a new direct connect gateway attached to virtual private gateway
  community.aws.directconnect_gateway:
    state: present
    name: my-dx-gateway
    amazon_asn: 7224
    virtual_gateway_id: vpg-12345
  register: created_dxgw

- name: Create a new unattached dxgw
  community.aws.directconnect_gateway:
    state: present
    name: my-dx-gateway
    amazon_asn: 7224
  register: created_dxgw

返回值

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

键

描述

结果

复杂

直接连接网关的属性

返回： state=present

amazon_side_asn

字符串

亚马逊端的ASN。

返回：成功

direct_connect_gateway_id

字符串

直接连接网关的ID。

返回：成功

direct_connect_gateway_name

字符串

直接连接网关的名称。

返回：成功

direct_connect_gateway_state

字符串

直接连接网关的状态。

返回：成功

owner_account

字符串

直接连接网关所有者的AWS账户ID。

返回：成功

作者

  • Gobin Sougrakpam (@gobins)