Skip to main content

graphs

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

Overview​

Namegraphs
TypeResource
DescriptionThe AWS::NeptuneGraph::Graph resource creates an Amazon NeptuneGraph Graph.
Idawscc.neptunegraph.graphs

Fields​

NameDatatypeDescription
deletion_protectionboolean
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_namestring
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_memoryintegerMemory for the Graph.
public_connectivityboolean
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_countinteger
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.
▶tagsarrayThe tags associated with this graph.
▶vector_search_configurationobjectVector Search Configuration
endpointstringThe connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
graph_arnstringGraph resource ARN
graph_idstringThe auto-generated id assigned by the service.
regionstringAWS region.

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

Methods​

NameResourceAccessible byRequired Params
create_resourcegraphsINSERTProvisionedMemory, region
delete_resourcegraphsDELETEIdentifier, region
update_resourcegraphsUPDATEIdentifier, PatchDocument, region
list_resourcesgraphs_list_onlySELECTregion
get_resourcegraphsSELECTIdentifier, region

SELECT examples​

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

INSERT example​

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

/*+ create */
INSERT INTO awscc.neptunegraph.graphs (
  ProvisionedMemory,
  region
)
SELECT
  '{{ provisioned_memory }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

UPDATE example​

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

/*+ update */
UPDATE awscc.neptunegraph.graphs
SET PatchDocument = string('{{ {
    "DeletionProtection": deletion_protection,
    "ProvisionedMemory": provisioned_memory,
    "PublicConnectivity": public_connectivity,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ graph_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example​

/*+ delete */
DELETE FROM awscc.neptunegraph.graphs
WHERE
  Identifier = '{{ graph_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:

ParameterDescription
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 graphs resource, the following permissions are required:

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