Amazon Neptune · JSON Structure

Management Create Db Cluster Request Structure

CreateDBClusterRequest schema from Neptune

Type: object Properties: 13 Required: 2

DatabaseGraph DatabaseGremlinNeptuneProperty GraphRDFSPARQL

CreateDBClusterRequest is a JSON Structure definition published by Amazon Neptune, describing 13 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

DBClusterIdentifier Engine EngineVersion Port DBSubnetGroupName VpcSecurityGroupIds StorageEncrypted KmsKeyId PreferredBackupWindow PreferredMaintenanceWindow BackupRetentionPeriod DeletionProtection IAMDatabaseAuthenticationEnabled

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-neptune/refs/heads/main/json-structure/management-create-db-cluster-request-structure.json",
  "name": "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": "int32",
      "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": "int32",
      "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"
  ]
}