ModifyDBClusterMessage

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-neptune/json-schema/amazon-neptune-modify-dbcluster-message-schema.json",
  "title": "ModifyDBClusterMessage",
  "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/ModifyDBClusterMessage",
  "type": "object",
  "properties": {
    "DBClusterIdentifier": {
      "type": "string",
      "description": "The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing DBCluster."
    },
    "NewDBClusterIdentifier": {
      "type": "string",
      "description": "The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens The first character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: my-cluster2"
    },
    "ApplyImmediately": {
      "type": "boolean",
      "description": "A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window. The ApplyImmediately parameter only affects NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regar"
    },
    "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"
    },
    "DBClusterParameterGroupName": {
      "type": "string",
      "description": "The name of the DB cluster parameter group to use for the DB cluster."
    },
    "VpcSecurityGroupIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of VPC security groups that the DB cluster will belong to."
    },
    "Port": {
      "type": "integer",
      "description": "The port number on which the DB cluster accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB cluster."
    },
    "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. 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. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window."
    },
    "EnableIAMDatabaseAuthentication": {
      "type": "boolean",
      "description": "True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false"
    },
    "CloudwatchLogsExportConfiguration": {
      "$ref": "#/$defs/CloudwatchLogsExportConfiguration"
    },
    "EngineVersion": {
      "type": "string",
      "description": "The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true. For a list of valid engine versions, see Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions."
    },
    "AllowMajorVersionUpgrade": {
      "type": "boolean",
      "description": "A value that indicates whether upgrades between different major versions are allowed. Constraints: You must set the allow-major-version-upgrade flag when providing an EngineVersion parameter that uses a different major version than the DB cluster's current version."
    },
    "DBInstanceParameterGroupName": {
      "type": "string",
      "description": "The name of the DB parameter group to apply to all instances of the DB cluster. When you apply a parameter group using DBInstanceParameterGroupName, parameter changes aren't applied during the next maintenance window but instead are applied immediately. Default: The existing name setting Constraints: The DB parameter group must be in the same DB parameter group family as the target DB cluster version. The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter."
    },
    "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 DB cluster that is created."
    },
    "ServerlessV2ScalingConfiguration": {
      "$ref": "#/$defs/ServerlessV2ScalingConfiguration"
    },
    "StorageType": {
      "type": "string",
      "description": "The storage type to associate with the DB cluster. Valid Values: standard – ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage. 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 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"
  ],
  "$defs": {
    "CloudwatchLogsExportConfiguration": {
      "type": "object",
      "properties": {
        "EnableLogTypes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The list of log types to enable."
        },
        "DisableLogTypes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The list of log types to disable."
        }
      }
    },
    "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."
        }
      }
    }
  }
}