CreateDBClusterRequest

CreateDBClusterRequest schema from Neptune

DatabaseGraph DatabaseGremlinNeptuneProperty GraphRDFSPARQL

Properties

Name	Type	Description
DBClusterIdentifier	string	The DB cluster identifier.
Engine	string	The database engine to use (neptune).
EngineVersion	string	The version of the Neptune engine.
Port	integer	The port number on which the cluster accepts connections.
DBSubnetGroupName	string	The name of a DB subnet group.
VpcSecurityGroupIds	array	A list of VPC security group IDs.
StorageEncrypted	boolean	Whether the cluster is encrypted.
KmsKeyId	string	The KMS key identifier for an encrypted cluster.
PreferredBackupWindow	string	The daily time range for automated backups (UTC).
PreferredMaintenanceWindow	string	The weekly time range for maintenance (UTC).
BackupRetentionPeriod	integer	The number of days for which automated backups are retained (1-35).
DeletionProtection	boolean	Whether to enable deletion protection.
IAMDatabaseAuthenticationEnabled	boolean	Whether to enable IAM database authentication.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-neptune/refs/heads/main/json-schema/management-create-db-cluster-request-schema.json",
  "title": "CreateDBClusterRequest",
  "description": "CreateDBClusterRequest schema from Neptune",
  "type": "object",
  "properties": {
    "DBClusterIdentifier": {
      "type": "string",
      "description": "The DB cluster identifier."
    },
    "Engine": {
      "type": "string",
      "description": "The database engine to use (neptune).",
      "default": "neptune"
    },
    "EngineVersion": {
      "type": "string",
      "description": "The version of the Neptune engine."
    },
    "Port": {
      "type": "integer",
      "description": "The port number on which the cluster accepts connections.",
      "default": 8182
    },
    "DBSubnetGroupName": {
      "type": "string",
      "description": "The name of a DB subnet group."
    },
    "VpcSecurityGroupIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of VPC security group IDs."
    },
    "StorageEncrypted": {
      "type": "boolean",
      "description": "Whether the cluster is encrypted."
    },
    "KmsKeyId": {
      "type": "string",
      "description": "The KMS key identifier for an encrypted cluster."
    },
    "PreferredBackupWindow": {
      "type": "string",
      "description": "The daily time range for automated backups (UTC)."
    },
    "PreferredMaintenanceWindow": {
      "type": "string",
      "description": "The weekly time range for maintenance (UTC)."
    },
    "BackupRetentionPeriod": {
      "type": "integer",
      "description": "The number of days for which automated backups are retained (1-35)."
    },
    "DeletionProtection": {
      "type": "boolean",
      "description": "Whether to enable deletion protection."
    },
    "IAMDatabaseAuthenticationEnabled": {
      "type": "boolean",
      "description": "Whether to enable IAM database authentication."
    }
  },
  "required": [
    "DBClusterIdentifier",
    "Engine"
  ]
}