community.aws.ec2_customer_gateway 模块 – 管理 AWS 客户网关

注意

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

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

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

要在剧本中使用它，请指定：community.aws.ec2_customer_gateway。

community.aws 1.0.0 中的新增功能

概要

  • 管理 AWS 客户网关。

要求

执行此模块的主机需要满足以下要求。

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

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。

bgp_asn

整数

边界网关协议 (BGP) 自治系统编号 (ASN)。

如果未在 state=present 时指定，则默认为 65000。

debug_botocore_endpoint_logs

布尔值

使用 botocore.endpoint 记录器来解析任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调来输出剧本期间制作的总列表。

也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选择

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

ip_address

字符串 / 必填

客户网关的互联网可路由 IP 地址，必须是静态地址。

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

有关访问令牌的更多信息，请参阅 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-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

字符串

创建或终止客户网关。

选择

  • "present" ← (默认)

  • “absent”

validate_certs

布尔值

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

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

选择

  • false

  • true ← (默认)

说明

注意

  • 您不能使用相同的 IP 地址创建多个客户网关。如果多次运行相同的请求，则第一个请求会创建客户网关，后续请求会返回有关现有客户网关的信息。后续请求不会创建新的客户网关资源。

  • 返回值包含 customer_gateway 和 customer_gateways 键，它们是相同的字典。您应该使用 customer_gateway。有关详细信息，请参阅 https://github.com/ansible/ansible-modules-extras/issues/2773。

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

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

示例

- name: Create Customer Gateway
  community.aws.ec2_customer_gateway:
    bgp_asn: 12345
    ip_address: 1.2.3.4
    name: IndianapolisOffice
    region: us-east-1
  register: cgw

- name: Delete Customer Gateway
  community.aws.ec2_customer_gateway:
    ip_address: 1.2.3.4
    name: IndianapolisOffice
    state: absent
    region: us-east-1
  register: cgw

返回值

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

键

描述

gateway.customer_gateways

复杂

有关已创建网关的详细信息。

返回： 成功

bgp_asn

字符串

边界网关自治系统号。

返回： 当存在并且网关可用时。

示例： "65123"

customer_gateway_id

字符串

亚马逊分配的网关 ID。

返回： 当存在并且网关可用时。

示例： "cgw-cb6386a2"

ip_address

字符串

您的网关设备的 IP 地址。

返回： 当存在并且网关可用时。

示例： "1.2.3.4"

state

字符串

网关的状态。

返回： 当网关存在且可用时。

示例： "available"

tags

list / elements=string

网关上的任何标签。

返回： 当网关存在且可用，并且存在标签时。

type

字符串

加密类型。

返回： 当网关存在且可用时。

示例： "ipsec.1"

作者

  • Michael Baydoun (@MichaelBaydoun)