private_graph_endpoints

Creates, updates, deletes or gets a private_graph_endpoint resource or lists private_graph_endpoints in a region

Overview

Name	private_graph_endpoints
Type	Resource
Description	The AWS::NeptuneGraph::PrivateGraphEndpoint resource creates an Amazon NeptuneGraph PrivateGraphEndpoint.
Id	aws.neptunegraph.private_graph_endpoints

Fields

Name	Datatype	Description
graph_identifier	string	The auto-generated Graph Id assigned by the service.
security_group_ids	array	The security group Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.
subnet_ids	array	The subnet Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.
vpc_id	string	The VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.
private_graph_endpoint_identifier	string	PrivateGraphEndpoint resource identifier generated by concatenating the associated GraphIdentifier and VpcId with an underscore separator. For example, if GraphIdentifier is `g-12a3bcdef4` and VpcId is `vpc-0a12bc34567de8f90`, the generated PrivateGraphEndpointIdentifier will be `g-12a3bcdef4_vpc-0a12bc34567de8f90`
vpc_endpoint_id	string	VPC endpoint that provides a private connection between the Graph and specified VPC.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	GraphIdentifier, VpcId, 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 private_graph_endpoints in a region.

SELECT
region,
graph_identifier,
security_group_ids,
subnet_ids,
vpc_id,
private_graph_endpoint_identifier,
vpc_endpoint_id
FROM aws.neptunegraph.private_graph_endpoints
WHERE region = 'us-east-1';

Gets all properties from an individual private_graph_endpoint.

SELECT
region,
graph_identifier,
security_group_ids,
subnet_ids,
vpc_id,
private_graph_endpoint_identifier,
vpc_endpoint_id
FROM aws.neptunegraph.private_graph_endpoints
WHERE region = 'us-east-1' AND data__Identifier = '<PrivateGraphEndpointIdentifier>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.neptunegraph.private_graph_endpoints (
 GraphIdentifier,
 VpcId,
 region
)
SELECT 
'{{ GraphIdentifier }}',
 '{{ VpcId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.neptunegraph.private_graph_endpoints (
 GraphIdentifier,
 SecurityGroupIds,
 SubnetIds,
 VpcId,
 region
)
SELECT 
 '{{ GraphIdentifier }}',
 '{{ SecurityGroupIds }}',
 '{{ SubnetIds }}',
 '{{ VpcId }}',
 '{{ region }}';

Manifest

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

DELETE example

/*+ delete */
DELETE FROM aws.neptunegraph.private_graph_endpoints
WHERE data__Identifier = '<PrivateGraphEndpointIdentifier>'
AND region = 'us-east-1';

Permissions

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

Create

ec2:CreateVpcEndpoint,
ec2:DescribeVpcEndpoints,
ec2:DescribeSecurityGroups,
ec2:DescribeSubnets,
ec2:DescribeVpcs,
ec2:DescribeVpcAttribute,
ec2:DescribeAvailabilityZones,
ec2:ModifyVpcEndpoint,
route53:AssociateVPCWithHostedZone,
iam:PassRole,
neptune-graph:CreatePrivateGraphEndpoint,
neptune-graph:GetPrivateGraphEndpoint,
iam:CreateServiceLinkedRole

Read

neptune-graph:GetPrivateGraphEndpoint

Update

iam:PassRole,
neptune-graph:GetPrivateGraphEndpoint

Delete

ec2:DeleteVpcEndpoints,
ec2:DescribeVpcEndpoints,
ec2:DescribeSecurityGroups,
ec2:DescribeSubnets,
ec2:DescribeVpcs,
ec2:DescribeVpcAttribute,
ec2:DescribeAvailabilityZones,
ec2:ModifyVpcEndpoint,
route53:DisassociateVPCFromHostedZone,
neptune-graph:DeletePrivateGraphEndpoint,
neptune-graph:GetPrivateGraphEndpoint

List

neptune-graph:GetPrivateGraphEndpoint,
neptune-graph:ListPrivateGraphEndpoints