resource_endpoint_associations

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

Overview

Name	resource_endpoint_associations
Type	Resource
Id	aws.vpc_lattice.resource_endpoint_associations

Fields

The following fields are returned by SELECT queries:

list_resource_endpoint_associations

Name	Datatype	Description
id	string	The ID of the VPC endpoint association. (pattern: <code>rea-[0-9a-f]{17}</code>)
arn	string	The Amazon Resource Name (ARN) of the VPC endpoint association. (pattern: <code>arn:[a-z0-9-]+:vpc-lattice:[a-zA-Z0-9-]+:\d{12}:resourceendpointassociation/rea-[0-9a-f]{17}</code>)
created_at	string (date-time)	The date and time that the VPC endpoint association was created, in ISO-8601 format.
created_by	string	The account that created the association. (pattern: <code>[0-9]{12}</code>)
resource_configuration_arn	string	The Amazon Resource Name (ARN) of the resource configuration. (pattern: <code>arn:[a-z0-9f-]+:vpc-lattice:[a-zA-Z0-9-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}</code>)
resource_configuration_id	string	The ID of the resource configuration. (pattern: <code>rcfg-[0-9a-z]{17}</code>)
resource_configuration_name	string	The name of the resource configuration. (pattern: <code>(?!rcfg-)(?![-])(?!.[-]$)(?!.[-]{2})[a-z0-9-]+</code>)
vpc_endpoint_id	string	The ID of the VPC endpoint. (pattern: <code>vpce-[0-9a-f]{17}</code>)
vpc_endpoint_owner	string	The owner of the VPC endpoint. (pattern: <code>\d{12}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_resource_endpoint_associations	select	resourceConfigurationIdentifier, region	resourceEndpointAssociationIdentifier, vpcEndpointId, vpcEndpointOwner, maxResults, nextToken	Lists the associations for the specified VPC endpoint.
delete_resource_endpoint_association	delete	resource_endpoint_association_identifier, region		Disassociates the resource configuration from the resource 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)
resourceConfigurationIdentifier	string	The ID for the resource configuration associated with the VPC endpoint.
resource_endpoint_association_identifier	string	The ID or ARN of the association.
maxResults	integer	The maximum page size.
nextToken	string	A pagination token for the next page of results.
resourceEndpointAssociationIdentifier	string	The ID of the association.
vpcEndpointId	string	The ID of the VPC endpoint in the association.
vpcEndpointOwner	string	The owner of the VPC endpoint in the association.

SELECT examples

list_resource_endpoint_associations

Lists the associations for the specified VPC endpoint.

SELECT
id,
arn,
created_at,
created_by,
resource_configuration_arn,
resource_configuration_id,
resource_configuration_name,
vpc_endpoint_id,
vpc_endpoint_owner
FROM aws.vpc_lattice.resource_endpoint_associations
WHERE resourceConfigurationIdentifier = '{{ resourceConfigurationIdentifier }}' -- required
AND region = '{{ region }}' -- required
AND resourceEndpointAssociationIdentifier = '{{ resourceEndpointAssociationIdentifier }}'
AND vpcEndpointId = '{{ vpcEndpointId }}'
AND vpcEndpointOwner = '{{ vpcEndpointOwner }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

DELETE examples

delete_resource_endpoint_association

Disassociates the resource configuration from the resource VPC endpoint.

DELETE FROM aws.vpc_lattice.resource_endpoint_associations
WHERE resource_endpoint_association_identifier = '{{ resource_endpoint_association_identifier }}' --required
AND region = '{{ region }}' --required
;