Amazon Neptune DB Cluster

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/api-search/amazon-neptune/json-schema/amazon-neptune-db-cluster-schema.json",
  "title": "Amazon Neptune DB Cluster",
  "description": "Represents an Amazon Neptune DB cluster, which is a managed graph database cluster with one writer instance and up to 15 read replica instances sharing a distributed storage volume.",
  "type": "object",
  "required": [
    "DBClusterIdentifier",
    "Engine"
  ],
  "properties": {
    "DBClusterIdentifier": {
      "type": "string",
      "description": "The user-supplied unique identifier for the DB cluster. Must contain 1-63 alphanumeric characters or hyphens, start with a letter, and not end with a hyphen.",
      "minLength": 1,
      "maxLength": 63,
      "pattern": "^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$"
    },
    "DBClusterArn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) for the DB cluster.",
      "pattern": "^arn:aws[a-z-]*:rds:[a-z0-9-]+:[0-9]+:cluster:"
    },
    "Status": {
      "type": "string",
      "description": "The current state of the DB cluster.",
      "enum": [
        "available",
        "backing-up",
        "creating",
        "deleting",
        "failing-over",
        "inaccessible-encryption-credentials",
        "maintenance",
        "migrating",
        "modifying",
        "promoting",
        "renaming",
        "resetting-master-credentials",
        "starting",
        "stopped",
        "stopping",
        "upgrading"
      ]
    },
    "Engine": {
      "type": "string",
      "description": "The name of the database engine (always 'neptune').",
      "const": "neptune"
    },
    "EngineVersion": {
      "type": "string",
      "description": "The version of the Neptune database engine.",
      "examples": [
        "1.2.1.0",
        "1.3.0.0",
        "1.3.1.0"
      ]
    },
    "Endpoint": {
      "type": "string",
      "description": "The DNS address of the primary instance of the DB cluster. This is the read/write cluster endpoint."
    },
    "ReaderEndpoint": {
      "type": "string",
      "description": "The reader endpoint for the DB cluster. Used to distribute read-only connections across read replicas."
    },
    "Port": {
      "type": "integer",
      "description": "The port that the DB cluster listens on.",
      "default": 8182
    },
    "DBClusterParameterGroup": {
      "type": "string",
      "description": "The name of the DB cluster parameter group associated with the cluster."
    },
    "DBSubnetGroup": {
      "type": "string",
      "description": "The name of the DB subnet group associated with the cluster."
    },
    "AllocatedStorage": {
      "type": "integer",
      "description": "The allocated storage size in gibibytes (GiB)."
    },
    "ClusterCreateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The time when the DB cluster was created, in UTC."
    },
    "PreferredBackupWindow": {
      "type": "string",
      "description": "The daily time range during which automated backups are created (UTC), in the format hh24:mi-hh24:mi.",
      "pattern": "^[0-2][0-9]:[0-5][0-9]-[0-2][0-9]:[0-5][0-9]$"
    },
    "PreferredMaintenanceWindow": {
      "type": "string",
      "description": "The weekly time range during which system maintenance can occur (UTC), in the format ddd:hh24:mi-ddd:hh24:mi."
    },
    "BackupRetentionPeriod": {
      "type": "integer",
      "description": "The number of days for which automated backups are retained.",
      "minimum": 1,
      "maximum": 35
    },
    "MultiAZ": {
      "type": "boolean",
      "description": "Whether the DB cluster has instances in multiple Availability Zones."
    },
    "StorageEncrypted": {
      "type": "boolean",
      "description": "Whether the DB cluster storage is encrypted at rest."
    },
    "KmsKeyId": {
      "type": "string",
      "description": "The AWS KMS key identifier used for encrypting the cluster storage."
    },
    "DeletionProtection": {
      "type": "boolean",
      "description": "Whether deletion protection is enabled. When enabled, the cluster cannot be deleted.",
      "default": false
    },
    "IAMDatabaseAuthenticationEnabled": {
      "type": "boolean",
      "description": "Whether AWS Identity and Access Management (IAM) database authentication is enabled."
    },
    "DBClusterMembers": {
      "type": "array",
      "description": "The list of DB instances that are members of this cluster.",
      "items": {
        "$ref": "#/$defs/DBClusterMember"
      }
    },
    "VpcSecurityGroups": {
      "type": "array",
      "description": "The VPC security groups associated with the cluster.",
      "items": {
        "type": "object",
        "properties": {
          "VpcSecurityGroupId": {
            "type": "string"
          },
          "Status": {
            "type": "string"
          }
        }
      }
    },
    "AssociatedRoles": {
      "type": "array",
      "description": "IAM roles that are associated with the DB cluster for accessing other AWS services.",
      "items": {
        "$ref": "#/$defs/DBClusterRole"
      }
    },
    "AvailabilityZones": {
      "type": "array",
      "description": "The Availability Zones in which instances in the cluster can be created.",
      "items": {
        "type": "string"
      }
    },
    "CopyTagsToSnapshot": {
      "type": "boolean",
      "description": "Whether tags are copied to snapshots of the DB cluster."
    },
    "CrossAccountClone": {
      "type": "boolean",
      "description": "Whether the cluster can be cloned across accounts."
    },
    "ServerlessV2ScalingConfiguration": {
      "type": "object",
      "description": "The scaling configuration for Neptune Serverless.",
      "properties": {
        "MinCapacity": {
          "type": "number",
          "description": "The minimum number of Neptune capacity units (NCUs)."
        },
        "MaxCapacity": {
          "type": "number",
          "description": "The maximum number of Neptune capacity units (NCUs)."
        }
      }
    }
  },
  "$defs": {
    "DBClusterMember": {
      "type": "object",
      "description": "A DB instance that is a member of a Neptune DB cluster.",
      "properties": {
        "DBInstanceIdentifier": {
          "type": "string",
          "description": "The instance identifier for this member."
        },
        "IsClusterWriter": {
          "type": "boolean",
          "description": "Whether this instance is the primary (writer) instance of the cluster."
        },
        "DBClusterParameterGroupStatus": {
          "type": "string",
          "description": "The status of the DB cluster parameter group for this member."
        },
        "PromotionTier": {
          "type": "integer",
          "description": "The failover priority order. Lower values have higher priority.",
          "minimum": 0,
          "maximum": 15
        }
      }
    },
    "DBClusterRole": {
      "type": "object",
      "description": "An IAM role associated with a Neptune DB cluster.",
      "properties": {
        "RoleArn": {
          "type": "string",
          "description": "The ARN of the IAM role."
        },
        "Status": {
          "type": "string",
          "description": "The status of the association between the IAM role and the cluster.",
          "enum": [
            "active",
            "pending",
            "error"
          ]
        },
        "FeatureName": {
          "type": "string",
          "description": "The name of the feature associated with the role."
        }
      }
    }
  }
}