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_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。
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 字符串	连接到非默认 AWS 端点的 URL。虽然这可以用于连接到其他兼容 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 等全球服务，将忽略区域。 还可以使用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 密钥访问密钥。 有关访问令牌的更多信息，请参阅 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 之后的一个版本中移除。
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选项是互斥的。 在 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参数，则不会修改标签。
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

备注

注意

• 对tags和purge_tags的支持是在 1.5.0 版本中添加的。

• 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。 返回：始终

作者

• 程凯伦 (@Etherdaemon)

相关链接

• 问题追踪器
• 代码仓库
• 通信