Class Cluster (0.4.1) 

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.
cloudsql_backup_run_source google.cloud.alloydb_v1beta.types.CloudSQLBackupRunSource
Output only. Cluster created from CloudSQL snapshot. 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.
satisfies_pzs bool
Output only. Reserved for future use.
psc_config google.cloud.alloydb_v1beta.types.Cluster.PscConfig
Optional. The configuration for Private Service Connect (PSC) for the cluster.
maintenance_update_policy google.cloud.alloydb_v1beta.types.MaintenanceUpdatePolicy
Optional. The maintenance update policy determines when to allow or deny updates.
maintenance_schedule google.cloud.alloydb_v1beta.types.MaintenanceSchedule
Output only. The maintenance schedule for the cluster, generated for a specific rollout if a maintenance window is set.
gemini_config google.cloud.alloydb_v1beta.types.GeminiClusterConfig
Optional. Configuration parameters related to the Gemini in Databases add-on.
subscription_type google.cloud.alloydb_v1beta.types.SubscriptionType
Optional. Subscription type of the cluster.
trial_metadata google.cloud.alloydb_v1beta.types.Cluster.TrialMetadata
Output only. Metadata for free trial clusters
tags MutableMapping[str, str]
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: :: "123/environment": "production", "123/costCenter": "marketing".

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

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.

PscConfig

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

PscConfig contains PSC related configuration at a cluster level.

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

TagsEntry

TagsEntry(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.

TrialMetadata

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

Contains information and all metadata related to TRIAL clusters.