vpc_endpoints

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

Overview

Name	vpc_endpoints
Type	Resource
Id	aws.opensearchserverless.vpc_endpoints

Fields

The following fields are returned by SELECT queries:

batch_get_vpc_endpoint

Name	Datatype	Description
vpc_endpoint_details	array	Details about the specified VPC endpoint.
vpc_endpoint_error_details	array	Error information for a failed request.

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. Make the call again using the returned token to retrieve the next page.
vpc_endpoint_summaries	array	Details about each VPC endpoint, including the name and current status.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_vpc_endpoint	select	region		Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
list_vpc_endpoints	select	region		Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
create_vpc_endpoint	insert	region, name, vpcId, subnetIds		Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
update_vpc_endpoint	update	region, id		Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
delete_vpc_endpoint	delete	region		Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface 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)

SELECT examples

batch_get_vpc_endpoint

Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

SELECT
vpc_endpoint_details,
vpc_endpoint_error_details
FROM aws.opensearchserverless.vpc_endpoints
WHERE region = '{{ region }}' -- required
;

list_vpc_endpoints

Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

SELECT
next_token,
vpc_endpoint_summaries
FROM aws.opensearchserverless.vpc_endpoints
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_vpc_endpoint

Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

INSERT INTO aws.opensearchserverless.vpc_endpoints (
name,
vpcId,
subnetIds,
securityGroupIds,
clientToken,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ vpcId }}' /* required */,
'{{ subnetIds }}' /* required */,
'{{ securityGroupIds }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
create_vpc_endpoint_detail
;

Manifest

# Description fields are for documentation purposes
- name: vpc_endpoints
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpc_endpoints resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the interface endpoint.
  - name: vpcId
    value: "{{ vpcId }}"
    description: |
      The ID of the VPC from which you'll access OpenSearch Serverless.
  - name: subnetIds
    value:
      - "{{ subnetIds }}"
    description: |
      The ID of one or more subnets from which you'll access OpenSearch Serverless.
  - name: securityGroupIds
    value:
      - "{{ securityGroupIds }}"
    description: |
      The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Unique, case-sensitive identifier to ensure idempotency of the request.

UPDATE examples

update_vpc_endpoint

Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

UPDATE aws.opensearchserverless.vpc_endpoints
SET 
id = '{{ id }}',
addSubnetIds = '{{ addSubnetIds }}',
removeSubnetIds = '{{ removeSubnetIds }}',
addSecurityGroupIds = '{{ addSecurityGroupIds }}',
removeSecurityGroupIds = '{{ removeSecurityGroupIds }}',
clientToken = '{{ clientToken }}'
WHERE 
region = '{{ region }}' --required
AND id = '{{ id }}' --required
RETURNING
update_vpc_endpoint_detail;

DELETE examples

delete_vpc_endpoint

Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

DELETE FROM aws.opensearchserverless.vpc_endpoints
WHERE region = '{{ region }}' --required
;