CreateDBClusterMessage

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-neptune/json-schema/amazon-neptune-create-dbcluster-message-schema.json",
  "title": "CreateDBClusterMessage",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-neptune-db-clusters-api-openapi.yml#/components/schemas/CreateDBClusterMessage",
  "type": "object",
  "properties": {
    "AvailabilityZones": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of EC2 Availability Zones that instances in the DB cluster can be created in."
    },
    "BackupRetentionPeriod": {
      "type": "integer",
      "description": "The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to 35"
    },
    "CharacterSetName": {
      "type": "string",
      "description": "(Not supported by Neptune)"
    },
    "CopyTagsToSnapshot": {
      "type": "boolean",
      "description": "If set to true, tags are copied to any snapshot of the DB cluster that is created."
    },
    "DatabaseName": {
      "type": "string",
      "description": "Not supported by Neptune."
    },
    "DBClusterIdentifier": {
      "type": "string",
      "description": "The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster1"
    },
    "DBClusterParameterGroupName": {
      "type": "string",
      "description": "The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup."
    },
    "VpcSecurityGroupIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of EC2 VPC security groups to associate with this DB cluster."
    },
    "DBSubnetGroupName": {
      "type": "string",
      "description": "A DB subnet group to associate with this DB cluster. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup"
    },
    "Engine": {
      "type": "string",
      "description": "The name of the database engine to be used for this DB cluster. Valid Values: neptune"
    },
    "EngineVersion": {
      "type": "string",
      "description": "The version number of the database engine to use for the new DB cluster. Example: 1.2.1.0"
    },
    "Port": {
      "type": "integer",
      "description": "The port number on which the instances in the DB cluster accept connections. Default: 8182"
    },
    "MasterUsername": {
      "type": "string",
      "description": "Not supported by Neptune."
    },
    "MasterUserPassword": {
      "type": "string",
      "description": "Not supported by Neptune."
    },
    "OptionGroupName": {
      "type": "string",
      "description": "(Not supported by Neptune)"
    },
    "PreferredBackupWindow": {
      "type": "string",
      "description": "The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region. To see the time blocks available, see Neptune Maintenance Window in the Amazon Neptune User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes."
    },
    "PreferredMaintenanceWindow": {
      "type": "string",
      "description": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week. To see the time blocks available, see Neptune Maintenance Window in the Amazon Neptune User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window."
    },
    "ReplicationSourceIdentifier": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica."
    },
    "Tags": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Tag"
      },
      "description": "The tags to assign to the new DB cluster."
    },
    "StorageEncrypted": {
      "type": "boolean",
      "description": "Specifies whether the DB cluster is encrypted."
    },
    "KmsKeyId": {
      "type": "string",
      "description": "The Amazon KMS key identifier for an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. If an encryption key is not specified in KmsKeyId: If ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encry"
    },
    "PreSignedUrl": {
      "type": "string",
      "description": "This parameter is not currently supported."
    },
    "EnableIAMDatabaseAuthentication": {
      "type": "boolean",
      "description": "If set to true, enables Amazon Identity and Access Management (IAM) authentication for the entire DB cluster (this cannot be set at an instance level). Default: false."
    },
    "EnableCloudwatchLogsExports": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of the log types that this DB cluster should export to CloudWatch Logs. Valid log types are: audit (to publish audit logs) and slowquery (to publish slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs."
    },
    "DeletionProtection": {
      "type": "boolean",
      "description": "A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is enabled."
    },
    "ServerlessV2ScalingConfiguration": {
      "$ref": "#/$defs/ServerlessV2ScalingConfiguration"
    },
    "GlobalClusterIdentifier": {
      "type": "string",
      "description": "The ID of the Neptune global database to which this new DB cluster should be added."
    },
    "StorageType": {
      "type": "string",
      "description": "The storage type for the new DB cluster. Valid Values: standard – ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage. When set to standard, the storage type is not returned in the response. iopt1 – Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput. Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0."
    },
    "NetworkType": {
      "type": "string",
      "description": "The network type of the DB cluster. Valid Values: IPV4 – ( the default ) The DB cluster uses only IPv4 addresses for communication. DUAL – The DB cluster uses both IPv4 and IPv6 addresses for communication. The DB subnet group associated with the cluster must support IPv6."
    }
  },
  "required": [
    "DBClusterIdentifier",
    "Engine"
  ],
  "$defs": {
    "ServerlessV2ScalingConfiguration": {
      "type": "object",
      "properties": {
        "MinCapacity": {
          "type": "number",
          "description": "The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on."
        },
        "MaxCapacity": {
          "type": "number",
          "description": "The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on."
        }
      }
    },
    "Tag": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string",
          "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\")."
        },
        "Value": {
          "type": "string",
          "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\")."
        }
      }
    }
  }
}