vpc_endpoints

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

Overview

Name	vpc_endpoints
Type	Resource
Id	aws.opensearch.vpc_endpoints

Fields

The following fields are returned by SELECT queries:

describe_vpc_endpoints

Name	Datatype	Description
vpc_endpoint_errors	array	Any errors associated with the request.
vpc_endpoints	array	Information about each requested VPC endpoint.

list_vpc_endpoints

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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_vpc_endpoints	select	region		Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
list_vpc_endpoints	select	region	nextToken	Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
create_vpc_endpoint	insert	region, DomainArn, VpcOptions		Creates an Amazon OpenSearch Service-managed VPC endpoint.
update_vpc_endpoint	update	region, VpcEndpointId, VpcOptions		Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
delete_vpc_endpoint	delete	vpc_endpoint_id, region		Deletes an Amazon OpenSearch Service-managed 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
region	string	AWS region (default: us-east-1)
vpc_endpoint_id	string	The unique identifier of the endpoint.
nextToken	string	If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.

SELECT examples

describe_vpc_endpoints

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

SELECT
vpc_endpoint_errors,
vpc_endpoints
FROM aws.opensearch.vpc_endpoints
WHERE region = '{{ region }}' -- required
;

list_vpc_endpoints

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.

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

INSERT examples

create_vpc_endpoint

Creates an Amazon OpenSearch Service-managed VPC endpoint.

INSERT INTO aws.opensearch.vpc_endpoints (
DomainArn,
VpcOptions,
ClientToken,
region
)
SELECT 
'{{ DomainArn }}' /* required */,
'{{ VpcOptions }}' /* required */,
'{{ ClientToken }}',
'{{ region }}'
RETURNING
vpc_endpoint
;

Manifest

# Description fields are for documentation purposes
- name: vpc_endpoints
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpc_endpoints resource.
  - name: DomainArn
    value: "{{ DomainArn }}"
  - name: VpcOptions
    description: |
      Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
    value:
      SubnetIds:
        - "{{ SubnetIds }}"
      SecurityGroupIds:
        - "{{ SecurityGroupIds }}"
      EgressEnabled: {{ EgressEnabled }}
  - name: ClientToken
    value: "{{ ClientToken }}"

UPDATE examples

update_vpc_endpoint

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

UPDATE aws.opensearch.vpc_endpoints
SET 
VpcEndpointId = '{{ VpcEndpointId }}',
VpcOptions = '{{ VpcOptions }}'
WHERE 
region = '{{ region }}' --required
AND VpcEndpointId = '{{ VpcEndpointId }}' --required
AND VpcOptions = '{{ VpcOptions }}' --required
RETURNING
vpc_endpoint;

DELETE examples

delete_vpc_endpoint

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

DELETE FROM aws.opensearch.vpc_endpoints
WHERE vpc_endpoint_id = '{{ vpc_endpoint_id }}' --required
AND region = '{{ region }}' --required
;