Reference documentation and code samples for the AlloyDB V1ALPHA API module Google::Cloud::AlloyDB::V1alpha::Cluster::State.
Cluster State
Constants
STATE_UNSPECIFIED
value: 0 The state of the cluster is unknown.
READY
value: 1 The cluster is active and running.
STOPPED
value: 2 The cluster is stopped. All instances in the cluster are stopped.
Customers can start a stopped cluster at any point and all their
instances will come back to life with same names and IP resources. In
this state, customer pays for storage.
Associated backups could also be present in a stopped cluster.
EMPTY
value: 3 The cluster is empty and has no associated resources.
All instances, associated storage and backups have been deleted.
CREATING
value: 4 The cluster is being created.
DELETING
value: 5 The cluster is being deleted.
FAILED
value: 6 The creation of the cluster failed.
BOOTSTRAPPING
value: 7 The cluster is bootstrapping with data from some other source.
Direct mutations to the cluster (e.g. adding read pool) are not allowed.
MAINTENANCE
value: 8 The cluster is under maintenance. AlloyDB regularly performs maintenance
and upgrades on customer clusters. Updates on the cluster are
not allowed while the cluster is in this state.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# AlloyDB V1ALPHA API - Module Google::Cloud::AlloyDB::V1alpha::Cluster::State (v0.14.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.14.1 (latest)](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/latest/Google-Cloud-AlloyDB-V1alpha-Cluster-State)\n- [0.14.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.14.0/Google-Cloud-AlloyDB-V1alpha-Cluster-State)\n- [0.13.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.13.0/Google-Cloud-AlloyDB-V1alpha-Cluster-State)\n- [0.12.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.12.0/Google-Cloud-AlloyDB-V1alpha-Cluster-State)\n- [0.11.1](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.11.1/Google-Cloud-AlloyDB-V1alpha-Cluster-State)\n- [0.10.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.10.0/Google-Cloud-AlloyDB-V1alpha-Cluster-State)\n- [0.9.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.9.0/Google-Cloud-AlloyDB-V1alpha-Cluster-State)\n- [0.8.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.8.0/Google-Cloud-AlloyDB-V1alpha-Cluster-State)\n- [0.7.2](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.7.2/Google-Cloud-AlloyDB-V1alpha-Cluster-State)\n- [0.6.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.6.0/Google-Cloud-AlloyDB-V1alpha-Cluster-State)\n- [0.5.2](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.5.2/Google-Cloud-AlloyDB-V1alpha-Cluster-State)\n- [0.4.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.4.0/Google-Cloud-AlloyDB-V1alpha-Cluster-State)\n- [0.3.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.3.0/Google-Cloud-AlloyDB-V1alpha-Cluster-State)\n- [0.2.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.2.0/Google-Cloud-AlloyDB-V1alpha-Cluster-State)\n- [0.1.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.1.0/Google-Cloud-AlloyDB-V1alpha-Cluster-State) \nReference documentation and code samples for the AlloyDB V1ALPHA API module Google::Cloud::AlloyDB::V1alpha::Cluster::State.\n\nCluster State\n\nConstants\n---------\n\n### STATE_UNSPECIFIED\n\n**value:** 0 \nThe state of the cluster is unknown.\n\n### READY\n\n**value:** 1 \nThe cluster is active and running.\n\n### STOPPED\n\n**value:** 2 \nThe cluster is stopped. All instances in the cluster are stopped.\nCustomers can start a stopped cluster at any point and all their\ninstances will come back to life with same names and IP resources. In\nthis state, customer pays for storage.\nAssociated backups could also be present in a stopped cluster.\n\n### EMPTY\n\n**value:** 3 \nThe cluster is empty and has no associated resources.\nAll instances, associated storage and backups have been deleted.\n\n### CREATING\n\n**value:** 4 \nThe cluster is being created.\n\n### DELETING\n\n**value:** 5 \nThe cluster is being deleted.\n\n### FAILED\n\n**value:** 6 \nThe creation of the cluster failed.\n\n### BOOTSTRAPPING\n\n**value:** 7 \nThe cluster is bootstrapping with data from some other source.\nDirect mutations to the cluster (e.g. adding read pool) are not allowed.\n\n### MAINTENANCE\n\n**value:** 8 \nThe cluster is under maintenance. AlloyDB regularly performs maintenance\nand upgrades on customer clusters. Updates on the cluster are\nnot allowed while the cluster is in this state.\n\n### PROMOTING\n\n**value:** 9 \nThe cluster is being promoted."]]
