Class Cluster (0.3.2)

Cluster(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
`backup_source`	`google.cloud.alloydb_v1beta.types.BackupSource` Output only. Cluster created from backup. This field is a member of `oneof`_ `source`.
`migration_source`	`google.cloud.alloydb_v1beta.types.MigrationSource` Output only. Cluster created via DMS migration. This field is a member of `oneof`_ `source`.
`name`	`str` Output only. The name of the cluster resource with the format: - projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: - projects/{project}/locations/{region}
`display_name`	`str` User-settable and human-readable display name for the Cluster.
`uid`	`str` Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
`create_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. Create time stamp
`update_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. Update time stamp
`delete_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. Delete time stamp
`labels`	`MutableMapping[str, str]` Labels as key value pairs
`state`	`google.cloud.alloydb_v1beta.types.Cluster.State` Output only. The current serving state of the cluster.
`cluster_type`	`google.cloud.alloydb_v1beta.types.Cluster.ClusterType` Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
`database_version`	`google.cloud.alloydb_v1beta.types.DatabaseVersion` Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
`network`	`str` Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project}/global/networks/{network_id}". This is required to create a cluster. Deprecated, use network_config.network instead.
`etag`	`str` For Resource freshness validation (https://google.aip.dev/154)
`annotations`	`MutableMapping[str, str]` Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
`reconciling`	`bool` Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
`initial_user`	`google.cloud.alloydb_v1beta.types.UserPassword` Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored.
`automated_backup_policy`	`google.cloud.alloydb_v1beta.types.AutomatedBackupPolicy` The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
`ssl_config`	`google.cloud.alloydb_v1beta.types.SslConfig` SSL configuration for this AlloyDB cluster.
`encryption_config`	`google.cloud.alloydb_v1beta.types.EncryptionConfig` Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
`encryption_info`	`google.cloud.alloydb_v1beta.types.EncryptionInfo` Output only. The encryption information for the cluster.
`continuous_backup_config`	`google.cloud.alloydb_v1beta.types.ContinuousBackupConfig` Optional. Continuous backup configuration for this cluster.
`continuous_backup_info`	`google.cloud.alloydb_v1beta.types.ContinuousBackupInfo` Output only. Continuous backup properties for this cluster.
`secondary_config`	`google.cloud.alloydb_v1beta.types.Cluster.SecondaryConfig` Cross Region replication config specific to SECONDARY cluster.
`primary_config`	`google.cloud.alloydb_v1beta.types.Cluster.PrimaryConfig` Output only. Cross Region replication config specific to PRIMARY cluster.

Classes

AnnotationsEntry

AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.

ClusterType

ClusterType(value)

Type of Cluster

Values: CLUSTER_TYPE_UNSPECIFIED (0): The type of the cluster is unknown. PRIMARY (1): Primary cluster that support read and write operations. SECONDARY (2): Secondary cluster that is replicating from another region. This only supports read.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.

NetworkConfig

NetworkConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Metadata related to network configuration.

PrimaryConfig

PrimaryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY.

SecondaryConfig

SecondaryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.

State

State(value)

Cluster State

Values: STATE_UNSPECIFIED (0): The state of the cluster is unknown. READY (1): The cluster is active and running. STOPPED (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 (3): The cluster is empty and has no associated resources. All instances, associated storage and backups have been deleted. CREATING (4): The cluster is being created. DELETING (5): The cluster is being deleted. FAILED (6): The creation of the cluster failed. BOOTSTRAPPING (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 (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. PROMOTING (9): The cluster is being promoted.