RestoreDBClusterFromSnapshotMessage

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-neptune/json-schema/amazon-neptune-restore-dbcluster-from-snapshot-message-schema.json",
  "title": "RestoreDBClusterFromSnapshotMessage",
  "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/RestoreDBClusterFromSnapshotMessage",
  "type": "object",
  "properties": {
    "AvailabilityZones": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in."
    },
    "DBClusterIdentifier": {
      "type": "string",
      "description": "The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive. 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-snapshot-id"
    },
    "SnapshotIdentifier": {
      "type": "string",
      "description": "The identifier for the DB snapshot or DB cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. Constraints: Must match the identifier of an existing Snapshot."
    },
    "Engine": {
      "type": "string",
      "description": "The database engine to use for the new DB cluster. Default: The same as source Constraint: Must be compatible with the engine of the source"
    },
    "EngineVersion": {
      "type": "string",
      "description": "The version of the database engine to use for the new DB cluster."
    },
    "Port": {
      "type": "integer",
      "description": "The port number on which the new DB cluster accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB cluster."
    },
    "DBSubnetGroupName": {
      "type": "string",
      "description": "The name of the DB subnet group to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup"
    },
    "DatabaseName": {
      "type": "string",
      "description": "Not supported."
    },
    "OptionGroupName": {
      "type": "string",
      "description": "(Not supported by Neptune)"
    },
    "VpcSecurityGroupIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of VPC security groups that the new DB cluster will belong to."
    },
    "Tags": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Tag"
      },
      "description": "The tags to be assigned to the restored DB cluster."
    },
    "KmsKeyId": {
      "type": "string",
      "description": "The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring 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 you do not specify a value for the KmsKeyId parameter, then the following will occur: If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restor"
    },
    "EnableIAMDatabaseAuthentication": {
      "type": "boolean",
      "description": "True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false"
    },
    "EnableCloudwatchLogsExports": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs."
    },
    "DBClusterParameterGroupName": {
      "type": "string",
      "description": "The name of the DB cluster parameter group to associate with the new DB cluster. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup."
    },
    "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 disabled."
    },
    "CopyTagsToSnapshot": {
      "type": "boolean",
      "description": "If set to true, tags are copied to any snapshot of the restored DB cluster that is created."
    },
    "ServerlessV2ScalingConfiguration": {
      "$ref": "#/$defs/ServerlessV2ScalingConfiguration"
    },
    "StorageType": {
      "type": "string",
      "description": "Specifies the storage type to be associated with the DB cluster. Valid values: standard, iopt1 Default: standard"
    },
    "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",
    "SnapshotIdentifier",
    "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}_.:/=+\\\\-]*)$\")."
        }
      }
    }
  }
}