Amazon Neptune · Schema

Amazon Neptune DB Cluster

Represents an Amazon Neptune DB cluster, which is a managed graph database cluster with one writer instance and up to 15 read replica instances sharing a distributed storage volume.

AWSDatabaseGraph DatabaseGremlinNeptuneProperty GraphRDFSPARQL

Properties

Name Type Description
DBClusterIdentifier string The user-supplied unique identifier for the DB cluster. Must contain 1-63 alphanumeric characters or hyphens, start with a letter, and not end with a hyphen.
DBClusterArn string The Amazon Resource Name (ARN) for the DB cluster.
Status string The current state of the DB cluster.
Engine string The name of the database engine (always 'neptune').
EngineVersion string The version of the Neptune database engine.
Endpoint string The DNS address of the primary instance of the DB cluster. This is the read/write cluster endpoint.
ReaderEndpoint string The reader endpoint for the DB cluster. Used to distribute read-only connections across read replicas.
Port integer The port that the DB cluster listens on.
DBClusterParameterGroup string The name of the DB cluster parameter group associated with the cluster.
DBSubnetGroup string The name of the DB subnet group associated with the cluster.
AllocatedStorage integer The allocated storage size in gibibytes (GiB).
ClusterCreateTime string The time when the DB cluster was created, in UTC.
PreferredBackupWindow string The daily time range during which automated backups are created (UTC), in the format hh24:mi-hh24:mi.
PreferredMaintenanceWindow string The weekly time range during which system maintenance can occur (UTC), in the format ddd:hh24:mi-ddd:hh24:mi.
BackupRetentionPeriod integer The number of days for which automated backups are retained.
MultiAZ boolean Whether the DB cluster has instances in multiple Availability Zones.
StorageEncrypted boolean Whether the DB cluster storage is encrypted at rest.
KmsKeyId string The AWS KMS key identifier used for encrypting the cluster storage.
DeletionProtection boolean Whether deletion protection is enabled. When enabled, the cluster cannot be deleted.
IAMDatabaseAuthenticationEnabled boolean Whether AWS Identity and Access Management (IAM) database authentication is enabled.
DBClusterMembers array The list of DB instances that are members of this cluster.
VpcSecurityGroups array The VPC security groups associated with the cluster.
AssociatedRoles array IAM roles that are associated with the DB cluster for accessing other AWS services.
AvailabilityZones array The Availability Zones in which instances in the cluster can be created.
CopyTagsToSnapshot boolean Whether tags are copied to snapshots of the DB cluster.
CrossAccountClone boolean Whether the cluster can be cloned across accounts.
ServerlessV2ScalingConfiguration object The scaling configuration for Neptune Serverless.
View JSON Schema on GitHub