vpc_endpoint_access

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

Overview

Name	vpc_endpoint_access
Type	Resource
Id	aws.es.vpc_endpoint_access

Fields

The following fields are returned by SELECT queries:

list_vpc_endpoint_access

Name	Datatype	Description
authorized_principal_list	array	List of AuthorizedPrincipal describing the details of the permissions to manage VPC endpoints against the specified domain.
next_token	string	Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_vpc_endpoint_access	select	domain_name, region	nextToken	Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
authorize_vpc_endpoint_access	update	domain_name, region, Account		Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
revoke_vpc_endpoint_access	exec	domain_name, region, Account		Revokes access to an Amazon OpenSearch Service domain that was provided through an interface 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
domain_name	string	The name of the OpenSearch Service domain.
region	string	AWS region (default: us-east-1)
nextToken	string	Provides an identifier to allow retrieval of paginated results.

SELECT examples

list_vpc_endpoint_access

Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

SELECT
authorized_principal_list,
next_token
FROM aws.es.vpc_endpoint_access
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

authorize_vpc_endpoint_access

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

UPDATE aws.es.vpc_endpoint_access
SET 
Account = '{{ Account }}'
WHERE 
domain_name = '{{ domain_name }}' --required
AND region = '{{ region }}' --required
AND Account = '{{ Account }}' --required
RETURNING
authorized_principal;

Lifecycle Methods

revoke_vpc_endpoint_access

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

EXEC aws.es.vpc_endpoint_access.revoke_vpc_endpoint_access 
@domain_name='{{ domain_name }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Account": "{{ Account }}"
}'
;