vpc_endpoint_connections

Creates, updates, deletes, gets or lists a vpc_endpoint_connections resource.

Overview

Name	vpc_endpoint_connections
Type	Resource
Id	aws.ec2.vpc_endpoint_connections

Fields

The following fields are returned by SELECT queries:

describe_vpc_endpoint_connections

Name	Datatype	Description
creation_timestamp	string	The date and time that the VPC endpoint was created.
dns_entries	string	The DNS entries for the VPC endpoint.
gateway_load_balancer_arns	string	The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
ip_address_type	string	The IP address type for the endpoint.
network_load_balancer_arns	string	The Amazon Resource Names (ARNs) of the network load balancers for the service.
payer_responsibilities	string	The payer responsibility settings for the endpoint.
service_id	string	The ID of the service to which the endpoint is connected.
tags	string	The tags.
vpc_endpoint_connection_id	string	The ID of the VPC endpoint connection.
vpc_endpoint_id	string	The ID of the VPC endpoint.
vpc_endpoint_owner	string	The ID of the Amazon Web Services account that owns the VPC endpoint.
vpc_endpoint_region	string	The Region of the endpoint.
vpc_endpoint_state	string	The state of the VPC endpoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_vpc_endpoint_connections	select	region	DryRun, Filter, MaxResults, NextToken	Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.
accept_vpc_endpoint_connections	exec	ServiceId, VpcEndpointId, region	DryRun	Accepts connection requests to your VPC endpoint service.
reject_vpc_endpoint_connections	exec	ServiceId, VpcEndpointId, region	DryRun	Rejects VPC endpoint connection requests to your VPC endpoint service.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ServiceId	string	The ID of the service.
VpcEndpointId	array	The IDs of the VPC endpoints.
region	string	AWS region (default: us-east-1)
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter	array	The filters. ip-address-type - The IP address type (ipv4 | ipv6). service-id - The ID of the service. vpc-endpoint-owner - The ID of the Amazon Web Services account ID that owns the endpoint. vpc-endpoint-region - The Region of the endpoint or cross-region to find endpoints for other Regions. vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed). vpc-endpoint-id - The ID of the endpoint.
MaxResults	integer	The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.
NextToken	string	The token to retrieve the next page of results.

SELECT examples

describe_vpc_endpoint_connections

Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.

SELECT
creation_timestamp,
dns_entries,
gateway_load_balancer_arns,
ip_address_type,
network_load_balancer_arns,
payer_responsibilities,
service_id,
tags,
vpc_endpoint_connection_id,
vpc_endpoint_id,
vpc_endpoint_owner,
vpc_endpoint_region,
vpc_endpoint_state
FROM aws.ec2.vpc_endpoint_connections
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

Lifecycle Methods

accept_vpc_endpoint_connections

Accepts connection requests to your VPC endpoint service.

EXEC aws.ec2.vpc_endpoint_connections.accept_vpc_endpoint_connections 
@ServiceId='{{ ServiceId }}' --required, 
@VpcEndpointId='{{ VpcEndpointId }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}
;

reject_vpc_endpoint_connections

Rejects VPC endpoint connection requests to your VPC endpoint service.

EXEC aws.ec2.vpc_endpoint_connections.reject_vpc_endpoint_connections 
@ServiceId='{{ ServiceId }}' --required, 
@VpcEndpointId='{{ VpcEndpointId }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}
;