ansible / ansible.builtin / v2.6.20 / module / ec2_vpc_endpoint_facts Retrieves AWS VPC endpoints details using AWS methods. | "added in version" 2.4 of ansible.builtin" Authors: Karen Cheng(@Etherdaemon) preview | supported by communityansible.builtin.ec2_vpc_endpoint_facts (v2.6.20) — module
pip
Install with pip install ansible==2.6.20
Gets various details related to AWS VPC Endpoints
# Simple example of listing all support AWS services for VPC endpoints - name: List supported AWS endpoint services ec2_vpc_endpoint_facts: query: services region: ap-southeast-2 register: supported_endpoint_services
- name: Get all endpoints in ap-southeast-2 region ec2_vpc_endpoint_facts: query: endpoints region: ap-southeast-2 register: existing_endpoints
- name: Get all endpoints with specific filters ec2_vpc_endpoint_facts: 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 ec2_vpc_endpoint_facts: query: endpoints region: ap-southeast-2 vpc_endpoint_ids: - vpce-12345678 register: endpoint_details
query: choices: - services - endpoints description: - Specifies the query action to take. Services returns the supported AWS services that can be specified when creating an endpoint. required: true region: aliases: - aws_region - ec2_region description: - The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str filters: description: - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcEndpoints.html) for possible filters. profile: aliases: - aws_profile description: - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. type: str aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - The I(aws_access_key) and I(profile) options are mutually exclusive. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - The I(aws_secret_key) and I(profile) options are mutually exclusive. type: str security_token: aliases: - aws_session_token - session_token - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool vpc_endpoint_ids: description: - Get details of specific endpoint IDs - Provide this value as a list debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool
service_names: description: AWS VPC endpoint service names returned: I(query) is C(services) sample: service_names: - com.amazonaws.ap-southeast-2.s3 type: list vpc_endpoints: description: - 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: I(query) is C(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:::*"]}]}" ' route_table_ids: - rtb-abcd1234 service_name: com.amazonaws.ap-southeast-2.s3 state: available vpc_endpoint_id: vpce-abbad0d0 vpc_id: vpc-1111ffff type: list