action digitalocean_databases_get_cluster {
  label: "Retrieve an Existing Database Cluster"
  description: "To show information about an existing database cluster, send a GET request to `/v2/databases/$DATABASE_ID`.\nThe response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes.\nThe embedded connection and private_connection objects will contain the information needed to access the database cluster.\nThe embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster."
  provider: digitalocean
  method: GET
  path: "/v2/databases/{database_cluster_uuid}"
  encoding: json
  input: {
    type: "object"
    properties: {
      database_cluster_uuid: {
        type: "string"
        format: "uuid"
      }
    }
    required: ["database_cluster_uuid"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["database"]
    properties: {
      database: {
        type: "object"
        required: ["engine", "name", "num_nodes", "region", "size"]
        properties: {
          connection: {
            type: "object"
          }
          created_at: {
            type: "string"
            format: "date-time"
            description: "A time value given in ISO8601 combined date and time format that represents when the database cluster was created."
          }
          db_names: {
            type: "array"
            description: "An array of strings containing the names of databases created in the database cluster."
            items: {
              type: "string"
            }
          }
          engine: {
            type: "string"
            description: "A slug representing the database engine used for the cluster. The possible values are: \"pg\" for PostgreSQL, \"mysql\" for MySQL, \"redis\" for Redis, and \"mongodb\" for MongoDB."
            enum: ["pg", "mysql", "redis", "mongodb"]
          }
          id: {
            type: "string"
            format: "uuid"
            description: "A unique ID that can be used to identify and reference a database cluster."
          }
          maintenance_window: {
            type: "object"
          }
          name: {
            type: "string"
            description: "A unique, human-readable name referring to a database cluster."
          }
          num_nodes: {
            type: "integer"
            description: "The number of nodes in the database cluster."
          }
          private_connection: {
            type: "object"
          }
          private_network_uuid: {
            type: "string"
            description: "A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account's default VPC for the region."
          }
          project_id: {
            type: "string"
            format: "uuid"
            description: "The ID of the project that the database cluster is assigned to. If excluded when creating a new database cluster, it will be assigned to your default project."
          }
          region: {
            type: "string"
            description: "The slug identifier for the region where the database cluster is located."
          }
          rules: {
            type: "array"
            items: {
              type: "object"
              required: ["type", "value"]
              properties: {
                cluster_uuid: {
                  type: "string"
                  description: "A unique ID for the database cluster to which the rule is applied."
                }
                created_at: {
                  type: "string"
                  format: "date-time"
                  description: "A time value given in ISO8601 combined date and time format that represents when the firewall rule was created."
                }
                type: {
                  type: "string"
                  description: "The type of resource that the firewall rule allows to access the database cluster."
                  enum: ["droplet", "k8s", "ip_addr", "tag", "app"]
                }
                uuid: {
                  type: "string"
                  description: "A unique ID for the firewall rule itself."
                }
                value: {
                  type: "string"
                  description: "The ID of the specific resource, the name of a tag applied to a group of resources, or the IP address that the firewall rule allows to access the database cluster."
                }
              }
            }
          }
          size: {
            type: "string"
            description: "The slug identifier representing the size of the nodes in the database cluster."
          }
          status: {
            type: "string"
            description: "A string representing the current status of the database cluster."
            enum: ["creating", "online", "resizing", "migrating", "forking"]
          }
          tags: {
            type: "array"
            description: "An array of tags that have been applied to the database cluster."
            items: {
              type: "string"
            }
          }
          users: {
            type: "array"
            items: {
              type: "object"
              required: ["name"]
              properties: {
                mysql_settings: {
                  type: "object"
                  required: ["auth_plugin"]
                  properties: {
                    auth_plugin: {
                      type: "string"
                      description: "A string specifying the authentication method to be used for connections\nto the MySQL user account. The valid values are `mysql_native_password`\nor `caching_sha2_password`. If excluded when creating a new user, the\ndefault for the version of MySQL in use will be used. As of MySQL 8.0, the\ndefault is `caching_sha2_password`.\n"
                      enum: ["mysql_native_password", "caching_sha2_password"]
                    }
                  }
                }
                name: {
                  type: "string"
                  description: "The name of a database user."
                }
                password: {
                  type: "string"
                  description: "A randomly generated password for the database user."
                }
                role: {
                  type: "string"
                  description: "A string representing the database user's role. The value will be either\n\"primary\" or \"normal\".\n"
                  enum: ["primary", "normal"]
                }
              }
            }
          }
          version: {
            type: "string"
            description: "A string representing the version of the database engine in use for the cluster."
          }
          version_end_of_availability: {
            type: "string"
            description: "A timestamp referring to the date when the particular version will no longer be available for creating new clusters. If null, the version does not have an end of availability timeline."
          }
          version_end_of_life: {
            type: "string"
            description: "A timestamp referring to the date when the particular version will no longer be supported. If null, the version does not have an end of life timeline."
          }
        }
      }
    }
  }
}