graph

Gets an individual graph resource

Overview

Name	graph
Type	Resource
Description	graph
Id	awscc.neptunegraph.graph

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.<br/><br/>_Default_: If not specified, the default value is true.
graph_name	string	Contains a user-supplied name for the Graph. <br/><br/>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.<br/><br/>_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.<br/><br/>When the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet.<br/><br/>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.<br/><br/>_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.<br/><br/>Replica Count should always be less than or equal to 2.<br/><br/>_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

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
deletion_protection,
graph_name,
provisioned_memory,
public_connectivity,
replica_count,
tags,
vector_search_configuration,
endpoint,
graph_arn,
graph_id
FROM awscc.neptunegraph.graph
WHERE data__Identifier = '<GraphId>';

Permissions

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

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