@aws-cdk/neptune

Reference

NeptuneDatabase

class _aws-cdk_neptune.NeptuneDatabase(parent, name, props)

Neptune Graph Database cluster Creates a new Neptune database cluster with a given number of replicas.

Extends:

Construct

Implements:

IConnectable

Parameters:
  • parent (Construct) –
  • name (string) –
  • props (NeptuneDatabaseProps) –
clusterIdentifier

Identifier of the cluster

Type:ClusterIdentifier (readonly)
instanceIdentifiers

Identifiers of the replicas

Type:InstanceIdentifier (readonly)
clusterEndpoint

The endpoint to use for read/write operations

Type:Endpoint (readonly)
readerEndpoint

Endpoint to use for load-balanced read-only operations.

Type:Endpoint (readonly)
instanceEndpoints

Endpoints which address each individual replica.

Type:Endpoint (readonly)
connections
Type:DefaultConnections (readonly)

NeptuneDatabaseProps (interface)

class _aws-cdk_neptune.NeptuneDatabaseProps

Properties for a Neptune Graph Database Cluster

instances

How many replicas/instances to create Has to be at least 1. Default is 2.

Type:number or None
instanceProps

Settings for the individual instances that are launched

Type:InstanceProps
masterUser

Username and password for the administrative user

Type:Login
port

What port to listen on

Type:number or None
clusterIdentifier

An optional identifier for the cluster If not given, a name is generated.

Type:string or None
instanceIdentifierBase

Base identifier for instances Every replica is named by appending the replica number to this string, 1-based. If not given, the clusterIdentifier is used with the word “Instance” appended. If clusterIdentifier is also not given, the identifier is automatically generated.

Type:string or None
defaultDatabaseName

Name of a database which is automatically created inside the cluster If not given, no database is created.

Type:string or None
kmsKeyArn

ARN of KMS key if you want to enable storage encryption

Type:KeyArn or None
preferredMaintenanceWindow

A daily time range in 24-hours UTC format in which backups preferably execute. Must be at least 30 minutes long. Example: ‘01:00-02:00’ If not given, an window is randomly.

Type:string or None