graphs

Creates, updates, deletes or gets a graph resource or lists graphs in a region

Overview

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

Fields

Name	Datatype	Description
deletion_protection	boolean	Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled. _Default_: If not specified, the default value is true.
graph_name	string	Contains a user-supplied name for the Graph. If you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters. _Important_: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
provisioned_memory	integer	Memory for the Graph.
public_connectivity	boolean	Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication. When the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet. When the Graph isn't publicly reachable, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC. _Default_: If not specified, the default value is false.
replica_count	integer	Specifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones. Replica Count should always be less than or equal to 2. _Default_: If not specified, the default value is 1.
tags	array	The tags associated with this graph.
vector_search_configuration	object	Vector Search Configuration
endpoint	string	The connection endpoint for the graph. For example: `g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com`
graph_arn	string	Graph resource ARN
graph_id	string	The auto-generated id assigned by the service.
region	string	AWS region.

Methods

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

SELECT
region,
deletion_protection,
graph_name,
provisioned_memory,
public_connectivity,
replica_count,
tags,
vector_search_configuration,
endpoint,
graph_arn,
graph_id
FROM aws.neptunegraph.graphs
WHERE region = 'us-east-1';

Gets all properties from an individual graph.

SELECT
region,
deletion_protection,
graph_name,
provisioned_memory,
public_connectivity,
replica_count,
tags,
vector_search_configuration,
endpoint,
graph_arn,
graph_id
FROM aws.neptunegraph.graphs
WHERE region = 'us-east-1' AND data__Identifier = '<GraphId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.neptunegraph.graphs (
 ProvisionedMemory,
 region
)
SELECT 
'{{ ProvisionedMemory }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.neptunegraph.graphs (
 DeletionProtection,
 GraphName,
 ProvisionedMemory,
 PublicConnectivity,
 ReplicaCount,
 Tags,
 VectorSearchConfiguration,
 region
)
SELECT 
 '{{ DeletionProtection }}',
 '{{ GraphName }}',
 '{{ ProvisionedMemory }}',
 '{{ PublicConnectivity }}',
 '{{ ReplicaCount }}',
 '{{ Tags }}',
 '{{ VectorSearchConfiguration }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: graph
    props:
      - name: DeletionProtection
        value: '{{ DeletionProtection }}'
      - name: GraphName
        value: '{{ GraphName }}'
      - name: ProvisionedMemory
        value: '{{ ProvisionedMemory }}'
      - name: PublicConnectivity
        value: '{{ PublicConnectivity }}'
      - name: ReplicaCount
        value: '{{ ReplicaCount }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: VectorSearchConfiguration
        value:
          VectorSearchDimension: '{{ VectorSearchDimension }}'

DELETE example

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

Permissions

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

Create

iam:PassRole,
neptune-graph:CreateGraph,
neptune-graph:GetGraph,
neptune-graph:ListTagsForResource,
neptune-graph:TagResource,
kms:DescribeKey,
kms:CreateGrant,
kms:Decrypt,
iam:CreateServiceLinkedRole

Read

neptune-graph:GetGraph,
neptune-graph:ListTagsForResource,
kms:DescribeKey,
kms:CreateGrant,
kms:Decrypt

Update

iam:PassRole,
neptune-graph:GetGraph,
neptune-graph:ListTagsForResource,
neptune-graph:TagResource,
neptune-graph:UntagResource,
neptune-graph:UpdateGraph,
kms:DescribeKey,
kms:CreateGrant,
kms:Decrypt

Delete

neptune-graph:DeleteGraph,
neptune-graph:GetGraph,
kms:DescribeKey,
kms:CreateGrant,
kms:Decrypt

List

neptune-graph:GetGraph,
neptune-graph:ListGraphs,
kms:DescribeKey,
kms:CreateGrant,
kms:Decrypt