vpc_endpoints_for_domains

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

Overview

Name	vpc_endpoints_for_domains
Type	Resource
Id	aws.opensearch.vpc_endpoints_for_domains

Fields

The following fields are returned by SELECT queries:

list_vpc_endpoints_for_domain

Name	Datatype	Description
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.
vpc_endpoint_summary_list	array	Information about each endpoint associated with the domain.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_vpc_endpoints_for_domain	select	domain_name, region	nextToken	Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

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 domain to list associated VPC endpoints for.
region	string	AWS region (default: us-east-1)
nextToken	string	If your initial ListEndpointsForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListEndpointsForDomain operations, which returns results in the next page.

SELECT examples

list_vpc_endpoints_for_domain

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

SELECT
next_token,
vpc_endpoint_summary_list
FROM aws.opensearch.vpc_endpoints_for_domains
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
;