amazon.aws.ec2_vpc_endpoint 模块 – 创建和删除 AWS VPC 终端节点

注意

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

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

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

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

amazon.aws 1.0.0 中的新功能

概要

• 创建 AWS VPC 终端节点。

• 删除 AWS 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。
client_token 字符串	可选的客户端令牌，以确保幂等性。
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 字符串	要连接的 URL，而不是默认的 AWS 终端节点。虽然这可以用于连接到其他 AWS 兼容服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 还可以按优先级递减的顺序使用 AWS_URL 或 EC2_URL 环境变量。 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_URL 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
policy json	格式正确的 JSON 策略字符串，请参阅 https://github.com/ansible/ansible/issues/7005#issuecomment-42894813。 创建终端节点时的选项。如果未提供，AWS 将使用默认策略，该策略提供对服务的完全访问权限。
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 之后的版本中删除。
route_table_ids 列表 / 元素=字符串	要附加到终端节点的一个或多个路由表 ID 的列表。 如果提供了终端节点，则将路由添加到路由表，其目的地为该终端节点。 路由表 ID 仅对网关终端节点有效。
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 之后的版本中删除。
service 字符串	AWS 支持的 VPC 终端节点服务。使用 amazon.aws.ec2_vpc_endpoint_info 模块来描述支持的终端节点服务。 创建终端节点时是必需的。
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 以删除资源。 选项 "present" ← (默认) "absent"
tags 别名：resource_tags 字典	一个字典，表示要应用于资源的标签。 如果未设置 tags 参数，则不会修改标签。
validate_certs 布尔值	当设置为 false 时，将不验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 _validate_certs=false_，作为替代方法，请考虑设置 _aws_ca_bundle_。 选项 false true ← (默认)
vpc_endpoint_id 字符串	要从 AWS 账户中删除的一个或多个 VPC 终端节点 ID。 如果 state=absent，则为必需。
vpc_endpoint_security_groups 列表 / 元素=字符串 在 amazon.aws 2.1.0 中添加	要附加到终端节点的安全组的列表。 需要 vpc_endpoint_type=GatewayLoadBalancer 或 vpc_endpoint_type=Interface。
vpc_endpoint_subnets 列表 / 元素=字符串 在 amazon.aws 2.1.0 中添加	要附加到终端节点的子网的列表。 需要 vpc_endpoint_type=GatewayLoadBalancer 或 vpc_endpoint_type=Interface。
vpc_endpoint_type 字符串 在 amazon.aws 1.5.0 中添加	终端节点的类型。 选项 "Interface" "Gateway" ← (默认) "GatewayLoadBalancer"
vpc_id 字符串	创建 VPC 终端节点时是必需的。
wait 布尔值	指定后，将等待状态达到 state=present 的可用状态。 遗憾的是，由于 AWS 的行为差异，此操作在删除操作中会被忽略。 选项 false ←（默认） true
wait_timeout 整数	与 wait 结合使用。 等待状态的秒数。 遗憾的是，由于 AWS 的行为差异，此操作在删除操作中会被忽略。 默认值： 320

注释

注意

• 在 1.5.0 版本中添加了对 tags 和 _purge_tags_ 的支持。

• _policy_file_ 参数在 6.0.0 版本中删除，请改用 policy 选项和 ansible.builtin.file 查找插件。

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

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

示例

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Create new vpc endpoint with a json template for policy
  amazon.aws.ec2_vpc_endpoint:
    state: present
    region: ap-southeast-2
    vpc_id: vpc-12345678
    service: com.amazonaws.ap-southeast-2.s3
    policy: " {{ lookup( 'template', 'endpoint_policy.json.j2') }} "
    route_table_ids:
      - rtb-12345678
      - rtb-87654321
  register: new_vpc_endpoint

- name: Create new vpc endpoint with the default policy
  amazon.aws.ec2_vpc_endpoint:
    state: present
    region: ap-southeast-2
    vpc_id: vpc-12345678
    service: com.amazonaws.ap-southeast-2.s3
    route_table_ids:
      - rtb-12345678
      - rtb-87654321
  register: new_vpc_endpoint

- name: Delete newly created vpc endpoint
  amazon.aws.ec2_vpc_endpoint:
    state: absent
    vpc_endpoint_id: "{{ new_vpc_endpoint.result['VpcEndpointId'] }}"
    region: ap-southeast-2

返回值

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

键	描述
endpoints 列表 / 元素=字典	模块调用产生的终端节点。 已返回: 成功
creation_timestamp 字符串	创建终端节点的日期和时间。 已返回: 始终
dns_entries 列表 / 元素=字典	终端节点的 DNS 条目列表。 已返回: 始终
dns_name 字符串	DNS 名称。 已返回: 始终
hosted_zone_id 字符串	私有托管区域的 ID。 已返回: 成功
groups 列表 / 元素=字典	与网络接口关联的安全组的列表。 已返回: 始终
group_id 字符串	安全组的 ID。 已返回: 始终
group_name 字符串	安全组的名称。 已返回: 始终
ip_address_type 字符串	终端节点的 IP 地址类型。 已返回: 成功
network_interface_ids 列表 / 元素=字符串	终端节点的网络接口列表。 已返回: 始终
owner_id 字符串	拥有终端节点的 AWS 账户的 ID。 已返回: 始终
policy_document 字符串	与终端节点关联的策略文档。 已返回: 始终
private_dns_enabled 布尔值	指示 VPC 是否与私有托管区域关联。 已返回: 始终
requester_managed 布尔值	指示终端节点是否由其服务管理。 已返回: 始终
route_table_ids 列表 / 元素=字符串	与终端节点关联的路由表 ID 的列表。 已返回: 始终
service_name 字符串	终端节点关联到的服务的名称。 已返回: 始终
state 字符串	终端节点的状态。 已返回: 始终
subnet_ids 列表 / 元素=字符串	与终端节点关联的子网的列表。 已返回: 始终
tags 列表 / 元素=字典	与终端节点关联的标签的列表。 已返回: 始终
vpc_endpoint_id 字符串	终端节点的 ID。 已返回: 始终
vpc_endpoint_type 字符串	终端节点的类型。 已返回: 始终
vpc_id 字符串	VPC 的 ID。 已返回: 始终

作者

• Karen Cheng (@Etherdaemon)

集合链接

• 问题跟踪器
• 存储库（源）
• 交流