amazon.aws.ec2_vpc_endpoint_info module – Retrieves AWS VPC endpoints details using AWS methods

Note

This module is part of the amazon.aws collection (version 5.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install amazon.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.aws.ec2_vpc_endpoint_info.

New in amazon.aws 1.0.0

Synopsis

  • Gets various details related to AWS VPC endpoints.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.6

  • boto3 >= 1.18.0

  • botocore >= 1.21.0

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

AWS access key ID.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

The aws_access_key and profile options are mutually exclusive.

The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

boolean

Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook.

The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.

Choices:

  • false ← (default)

  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS.

The AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

filters

dictionary

A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcEndpoints.html for possible filters.

profile

aliases: aws_profile

string

A named AWS profile to use for authentication.

See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

The AWS_PROFILE environment variable may also be used.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

query

string

Defaults to endpoints.

Specifies the query action to take.

query=endpoints returns information about AWS VPC endpoints.

Retrieving information about services using query=services has been deprecated in favour of the amazon.aws.ec2_vpc_endpoint_service_info module.

The query option has been deprecated and will be removed after 2022-12-01.

Choices:

  • "services"

  • "endpoints"

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

AWS secret access key.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

The secret_key and profile options are mutually exclusive.

The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

AWS STS session token for use with temporary credentials.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

The security_token and profile options are mutually exclusive.

Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0.

The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

vpc_endpoint_ids

list / elements=string

The IDs of specific endpoints to retrieve the details of.

Notes

Note

  • Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.

  • The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

Examples

# Simple example of listing all support AWS services for VPC endpoints
- name: List supported AWS endpoint services
  amazon.aws.ec2_vpc_endpoint_info:
    query: services
    region: ap-southeast-2
  register: supported_endpoint_services

- name: Get all endpoints in ap-southeast-2 region
  amazon.aws.ec2_vpc_endpoint_info:
    query: endpoints
    region: ap-southeast-2
  register: existing_endpoints

- name: Get all endpoints with specific filters
  amazon.aws.ec2_vpc_endpoint_info:
    query: endpoints
    region: ap-southeast-2
    filters:
      vpc-id:
        - vpc-12345678
        - vpc-87654321
      vpc-endpoint-state:
        - available
        - pending
  register: existing_endpoints

- name: Get details on specific endpoint
  amazon.aws.ec2_vpc_endpoint_info:
    query: endpoints
    region: ap-southeast-2
    vpc_endpoint_ids:
      - vpce-12345678
  register: endpoint_details

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

service_names

list / elements=string

AWS VPC endpoint service names.

Returned: query is services

Sample: {"service_names": ["com.amazonaws.ap-southeast-2.s3"]}

vpc_endpoints

list / elements=dictionary

A list of endpoints that match the query. Each endpoint has the keys creation_timestamp, policy_document, route_table_ids, service_name, state, vpc_endpoint_id, vpc_id.

Returned: query is endpoints

Sample: {"vpc_endpoints": [{"creation_timestamp": "2017-02-16T11:06:48+00:00", "policy_document": "\"{\\\"Version\\\":\\\"2012-10-17\\\",\\\"Id\\\":\\\"Policy1450910922815\\\", \\\"Statement\\\":[{\\\"Sid\\\":\\\"Stmt1450910920641\\\",\\\"Effect\\\":\\\"Allow\\\", \\\"Principal\\\":\\\"*\\\",\\\"Action\\\":\\\"s3:*\\\",\\\"Resource\\\":[\\\"arn:aws:s3:::*/*\\\",\\\"arn:aws:s3:::*\\\"]}]}\"\n", "route_table_ids": ["rtb-abcd1234"], "service_name": "com.amazonaws.ap-southeast-2.s3", "state": "available", "vpc_endpoint_id": "vpce-abbad0d0", "vpc_id": "vpc-1111ffff"}]}

creation_timestamp

string

The date and time that the endpoint was created.

Returned: always

dns_entries

list / elements=dictionary

List of DNS entires for the endpoint.

Returned: always

dns_name

string

The DNS name.

Returned: always

hosted_zone_id

string

The ID of the private hosted zone.

Returned: always

groups

list / elements=dictionary

List of security groups associated with the network interface.

Returned: always

group_id

string

The ID of the security group.

Returned: always

group_name

string

The name of the security group.

Returned: always

network_interface_ids

list / elements=string

List of network interfaces for the endpoint.

Returned: always

owner_id

string

The ID of the AWS account that owns the endpoint.

Returned: always

policy_document

string

The policy document associated with the endpoint.

Returned: always

private_dns_enabled

boolean

Indicates whether the VPC is associated with a private hosted zone.

Returned: always

requester_managed

boolean

Indicated whether the endpoint is being managed by its service.

Returned: always

route_table_ids

list / elements=string

List of route table IDs associated with the endpoint.

Returned: always

service_name

string

The name of the service to which the endpoint is associated.

Returned: always

state

string

The state of the endpoint.

Returned: always

subnet_ids

string

List of subnets associated with the endpoint.

Returned: always

tags

list / elements=dictionary

List of tags associated with the endpoint.

Returned: always

vpc_endpoint_id

string

The ID of the endpoint.

Returned: always

vpc_endpoint_type

string

The type of endpoint.

Returned: always

vpc_id

string

The ID of the VPC.

Returned: always

Authors

  • Karen Cheng (@Etherdaemon)