Graph Database

Resource Overview

A Graph Database represents an Amazon Neptune graph database. Amazon Neptune is a fully-managed graph database service that allows serverless applications to interact with highly connected datasets.

Common applications that benefit from graph databases:

Social networking
Recommendation engines
Fraud detection
Knowledge graphs

Configurable Properties

`Logical ID`

The unique identifier used to reference this resource in the stack template. Defining a custom Logical ID is recommended, as it allows you to quickly identify a resource and any associated sub-resources when working with your stack in AWS, or anywhere outside of the Stackery Dashboard. As a project grows, it becomes useful in quickly spotting this resource in template.yaml or while viewing a stack in Template View mode.

The Logical ID of all sub-resources associated with this Graph Database will be prefixed with this value.

The identifier you provide must only contain alphanumeric characters (A-Za-z0-9) and be unique within the stack.

Default Logical ID Example: GraphDatabase2

IMPORTANT : AWS uses the Logical ID of each resource to coordinate and apply updates to the stack when deployed. On any update of a resource's logical ID (or any modification that results in one), CloudFormation will delete the currently deployed resource and create a new one in its place when the updated stack is deployed.

`Instance Type`

The database instance class for your Graph Database

Instance types:

db.r5.large
db.r5.xlarge
db.r5.2xlarge
db.r5.4xlarge
db.r5.12xlarge

`Backup Retention Period`

The number of days to keep automatic backups. Backups older than this period are automatically deleted. The retention period for the database backup can be set between 1 and 35 days.

`Use Existing Neptune Database`

When enabled, this feature provides you with a field to specify the Amazon Resource Name (ARN) of an existing Graph Database cluster to reference in your application.

You may reference an environment parameter in order to conditionally reference existing infrastructure based on environment.

IAM Permissions

When connected by a service discovery wire (dashed wire), a Function or Docker Task will add the following IAM policy to its role and gain permission to access this resource.

Statement:
  - Effect: Allow
    Action:
      - neptune-db:connect
    Resource: !Sub arn:aws:neptune-db:${AWS::Region}:${AWS::AccountId}:${Graphdb.ClusterResourceId}/*

Environment Variables

When connected by a service discovery wire (dashed wire), a Function or Docker Task will automatically populate and reference the following environment variables in order to interact with this resource.

`DB_ID`

The Physical ID of the Graph Database cluster.

Example: cluster-OIDDHAEVGPVL6SUTI6QDAE

`DB_ADDRESS`

The Graph Database resource endpoint.

Cluster Example: graphdb-jsuyqfnnvws6.cluster-cj8gofoto4ih.us-west-2.neptune.amazonaws.com

`DB_PORT`

The port to access the Graph Database resource.

Example: 8182

`DB_ARN`

The Amazon Resource Name of the Graph Database cluster.

Example: arn:aws:rds:us-west-2:189519246275:cluster:graphdb-jsuyqfnnvws6

Metrics & Logs

Double clicking a resource while viewing your stack's current deployment gives you access to your pre-configured resource properties, and the following metrics and logs:

CPU Utilization
Available Memory
Available Storage
Network IO Throughput
Gremlin Requests Per Second
SPARQL Requests Per Second

Stackery Documentation

4.5.2

Quickstart

Cloudlocal Development