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	awscc.neptunegraph.private_graph_endpoints

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
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
region	string	AWS region.

For more information, see AWS::NeptuneGraph::PrivateGraphEndpoint.

Methods

Name	Resource	Accessible by	Required Params
create_resource	private_graph_endpoints	INSERT	GraphIdentifier, VpcId, region
delete_resource	private_graph_endpoints	DELETE	Identifier, region
update_resource	private_graph_endpoints	UPDATE	Identifier, PatchDocument, region
list_resources	private_graph_endpoints_list_only	SELECT	region
get_resource	private_graph_endpoints	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.neptunegraph.private_graph_endpoints
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ private_graph_endpoint_identifier }}';

list (identifiers only)

Lists all private_graph_endpoints in a region.

SELECT
  region,
  private_graph_endpoint_identifier
FROM awscc.neptunegraph.private_graph_endpoints_list_only
WHERE
  region = '{{ region }}';

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 awscc.neptunegraph.private_graph_endpoints (
  GraphIdentifier,
  VpcId,
  region
)
SELECT
  '{{ graph_identifier }}',
  '{{ vpc_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.neptunegraph.private_graph_endpoints (
  GraphIdentifier,
  SecurityGroupIds,
  SubnetIds,
  VpcId,
  region
)
SELECT
  '{{ graph_identifier }}',
  '{{ 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: private_graph_endpoint
  props:
    - name: graph_identifier
      value: '{{ graph_identifier }}'
    - name: security_group_ids
      value:
        - '{{ security_group_ids[0] }}'
    - name: subnet_ids
      value:
        - '{{ subnet_ids[0] }}'
    - name: vpc_id
      value: '{{ vpc_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.neptunegraph.private_graph_endpoints
WHERE
  Identifier = '{{ private_graph_endpoint_identifier }}' 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 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,
neptune-graph:ListGraphs