vpc_endpoint_associations

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

Overview

Name	vpc_endpoint_associations
Type	Resource
Id	aws.ec2.vpc_endpoint_associations

Fields

The following fields are returned by SELECT queries:

describe_vpc_endpoint_associations

Name	Datatype	Description
associated_resource_accessibility	string	The connectivity status of the resources associated to a VPC endpoint. The resource is accessible if the associated resource configuration is AVAILABLE, otherwise the resource is inaccessible.
associated_resource_arn	string	The Amazon Resource Name (ARN) of the associated resource.
dns_entry	string	The DNS entry of the VPC endpoint association.
failure_code	string	An error code related to why an VPC endpoint association failed.
failure_reason	string	A message related to why an VPC endpoint association failed.
id	string	The ID of the VPC endpoint association.
private_dns_entry	string	The private DNS entry of the VPC endpoint association.
resource_configuration_group_arn	string	The Amazon Resource Name (ARN) of the resource configuration group.
service_network_arn	string	The Amazon Resource Name (ARN) of the service network.
service_network_name	string	The name of the service network.
tags	string	The tags to apply to the VPC endpoint association.
vpc_endpoint_id	string	The ID of the VPC endpoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_vpc_endpoint_associations	select	region	DryRun, VpcEndpointId, Filter, MaxResults, NextToken	Describes the VPC resources, VPC endpoint services, Amazon Lattice services, or service networks associated with the VPC endpoint.

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
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. vpc-endpoint-id - The ID of the VPC endpoint. associated-resource-accessibility - The association state. When the state is accessible, it returns AVAILABLE. When the state is inaccessible, it returns PENDING or FAILED. association-id - The ID of the VPC endpoint association. associated-resource-id - The ID of the associated resource configuration. service-network-arn - The Amazon Resource Name (ARN) of the associated service network. Only VPC endpoints of type service network will be returned. resource-configuration-group-arn - The Amazon Resource Name (ARN) of the resource configuration of type GROUP.
MaxResults	integer	The maximum page size.
NextToken	string	The pagination token.
VpcEndpointId	array	The IDs of the VPC endpoints.

SELECT examples

describe_vpc_endpoint_associations

Describes the VPC resources, VPC endpoint services, Amazon Lattice services, or service networks associated with the VPC endpoint.

SELECT
associated_resource_accessibility,
associated_resource_arn,
dns_entry,
failure_code,
failure_reason,
id,
private_dns_entry,
resource_configuration_group_arn,
service_network_arn,
service_network_name,
tags,
vpc_endpoint_id
FROM aws.ec2.vpc_endpoint_associations
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND VpcEndpointId = '{{ VpcEndpointId }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;