vpc_endpoints

Creates, updates, deletes or gets a vpc_endpoint resource or lists vpc_endpoints in a region

Overview

Name	vpc_endpoints
Type	Resource
Description	Amazon OpenSearchServerless vpc endpoint resource
Id	aws.opensearchserverless.vpc_endpoints

Fields

Name	Datatype	Description
id	string	The identifier of the VPC Endpoint
name	string	The name of the VPC Endpoint
security_group_ids	array	The ID of one or more security groups to associate with the endpoint network interface
subnet_ids	array	The ID of one or more subnets in which to create an endpoint network interface
vpc_id	string	The ID of the VPC in which the endpoint will be used.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, VpcId, SubnetIds, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all vpc_endpoints in a region.

SELECT
region,
id,
name,
security_group_ids,
subnet_ids,
vpc_id
FROM aws.opensearchserverless.vpc_endpoints
WHERE region = 'us-east-1';

Gets all properties from an individual vpc_endpoint.

SELECT
region,
id,
name,
security_group_ids,
subnet_ids,
vpc_id
FROM aws.opensearchserverless.vpc_endpoints
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new vpc_endpoint resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.opensearchserverless.vpc_endpoints (
 Name,
 SubnetIds,
 VpcId,
 region
)
SELECT 
'{{ Name }}',
 '{{ SubnetIds }}',
 '{{ VpcId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.opensearchserverless.vpc_endpoints (
 Name,
 SecurityGroupIds,
 SubnetIds,
 VpcId,
 region
)
SELECT 
 '{{ Name }}',
 '{{ SecurityGroupIds }}',
 '{{ SubnetIds }}',
 '{{ VpcId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: vpc_endpoint
    props:
      - name: Name
        value: '{{ Name }}'
      - name: SecurityGroupIds
        value:
          - '{{ SecurityGroupIds[0] }}'
      - name: SubnetIds
        value:
          - '{{ SubnetIds[0] }}'
      - name: VpcId
        value: '{{ VpcId }}'

DELETE example

/*+ delete */
DELETE FROM aws.opensearchserverless.vpc_endpoints
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

To operate on the vpc_endpoints resource, the following permissions are required:

Create

aoss:BatchGetVpcEndpoint,
aoss:CreateVpcEndpoint,
ec2:CreateVpcEndpoint,
ec2:DeleteVpcEndPoints,
ec2:DescribeVpcEndpoints,
ec2:ModifyVpcEndPoint,
ec2:DescribeVpcs,
ec2:DescribeSubnets,
ec2:DescribeSecurityGroups,
ec2:CreateTags,
route53:ChangeResourceRecordSets,
route53:GetChange,
route53:GetHostedZone,
route53:ListResourceRecordSets,
route53:ListHostedZonesByName,
route53:CreateHostedZone,
route53:ListHostedZonesByVPC,
route53:AssociateVPCWithHostedZone

Read

aoss:BatchGetVpcEndpoint,
ec2:DescribeVpcEndpoints

Update

aoss:BatchGetVpcEndpoint,
aoss:UpdateVpcEndpoint,
ec2:CreateVpcEndpoint,
ec2:DeleteVpcEndPoints,
ec2:DescribeVpcEndpoints,
ec2:ModifyVpcEndPoint,
ec2:DescribeVpcs,
ec2:DescribeSubnets,
ec2:DescribeSecurityGroups,
ec2:CreateTags,
route53:ChangeResourceRecordSets,
route53:GetChange,
route53:GetHostedZone,
route53:ListResourceRecordSets,
route53:ListHostedZonesByName,
route53:CreateHostedZone,
route53:ListHostedZonesByVPC,
route53:AssociateVPCWithHostedZone

Delete

aoss:BatchGetVpcEndpoint,
aoss:DeleteVpcEndpoint,
ec2:DeleteVpcEndPoints,
ec2:DescribeVpcEndpoints,
ec2:ModifyVpcEndPoint,
ec2:DescribeVpcs,
ec2:DescribeSubnets,
ec2:DescribeSecurityGroups,
ec2:CreateTags,
route53:ChangeResourceRecordSets,
route53:DeleteHostedZone,
route53:GetChange,
route53:GetHostedZone,
route53:ListResourceRecordSets,
route53:ListHostedZonesByName,
route53:ListHostedZonesByVPC,
route53:AssociateVPCWithHostedZone

List

aoss:ListVpcEndpoints,
ec2:DescribeVpcEndpoints