vpc_endpoint_access

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

Overview

Name	vpc_endpoint_access
Type	Resource
Id	aws.opensearch.vpc_endpoint_access

Fields

The following fields are returned by SELECT queries:

list_vpc_endpoint_access

Name	Datatype	Description
authorized_principal_list	array	A list of IAM principals that can currently access the domain.
next_token	string	When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

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 Amazon Web Services 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		Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
revoke_vpc_endpoint_access	exec	domain_name, region		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	If your initial ListVpcEndpointAccess operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpointAccess operations, which returns results in the next page.

SELECT examples

list_vpc_endpoint_access

Retrieves information about each Amazon Web Services 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.opensearch.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.opensearch.vpc_endpoint_access
SET 
Account = '{{ Account }}',
Service = '{{ Service }}',
ServiceOptions = '{{ ServiceOptions }}'
WHERE 
domain_name = '{{ domain_name }}' --required
AND region = '{{ region }}' --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.opensearch.vpc_endpoint_access.revoke_vpc_endpoint_access 
@domain_name='{{ domain_name }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Account": "{{ Account }}", 
"Service": "{{ Service }}", 
"ServiceOptions": "{{ ServiceOptions }}"
}'
;