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	awscc.opensearchserverless.vpc_endpoints

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string	The identifier of the VPC Endpoint
region	string	AWS region.

For more information, see AWS::OpenSearchServerless::VpcEndpoint.

Methods

Name	Resource	Accessible by	Required Params
create_resource	vpc_endpoints	INSERT	Name, VpcId, SubnetIds, region
delete_resource	vpc_endpoints	DELETE	Identifier, region
update_resource	vpc_endpoints	UPDATE	Identifier, PatchDocument, region
list_resources	vpc_endpoints_list_only	SELECT	region
get_resource	vpc_endpoints	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual vpc_endpoint.

SELECT
  region,
  id,
  name,
  security_group_ids,
  subnet_ids,
  vpc_id
FROM awscc.opensearchserverless.vpc_endpoints
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all vpc_endpoints in a region.

SELECT
  region,
  id
FROM awscc.opensearchserverless.vpc_endpoints_list_only
WHERE
  region = '{{ region }}';

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 awscc.opensearchserverless.vpc_endpoints (
  Name,
  SubnetIds,
  VpcId,
  region
)
SELECT
  '{{ name }}',
  '{{ subnet_ids }}',
  '{{ vpc_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.opensearchserverless.vpc_endpoints (
  Name,
  SecurityGroupIds,
  SubnetIds,
  VpcId,
  region
)
SELECT
  '{{ name }}',
  '{{ security_group_ids }}',
  '{{ subnet_ids }}',
  '{{ vpc_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: security_group_ids
      value:
        - '{{ security_group_ids[0] }}'
    - name: subnet_ids
      value:
        - '{{ subnet_ids[0] }}'
    - name: vpc_id
      value: '{{ vpc_id }}'

UPDATE example

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

/*+ update */
UPDATE awscc.opensearchserverless.vpc_endpoints
SET PatchDocument = string('{{ {
    "SecurityGroupIds": security_group_ids,
    "SubnetIds": subnet_ids
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.opensearchserverless.vpc_endpoints
WHERE
  Identifier = '{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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