Class Cluster

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.

Inheritance

object

Cluster

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudAlloyDBAdmin.v1.Data

Assembly: Google.Apis.CloudAlloyDBAdmin.v1.dll

Syntax

public class Cluster : IDirectResponseSchema

Properties

Annotations

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

Declaration

[JsonProperty("annotations")]
public virtual IDictionary<string, string> Annotations { get; set; }

Property Value

Type	Description
IDictionary<string, string>

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.

Declaration

[JsonProperty("automatedBackupPolicy")]
public virtual AutomatedBackupPolicy AutomatedBackupPolicy { get; set; }

Property Value

Type	Description
AutomatedBackupPolicy

BackupSource

Output only. Cluster created from backup.

Declaration

[JsonProperty("backupSource")]
public virtual BackupSource BackupSource { get; set; }

Property Value

Type	Description
BackupSource

CloudsqlBackupRunSource

Output only. Cluster created from CloudSQL snapshot.

Declaration

[JsonProperty("cloudsqlBackupRunSource")]
public virtual CloudSQLBackupRunSource CloudsqlBackupRunSource { get; set; }

Property Value

Type	Description
CloudSQLBackupRunSource

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

Declaration

[JsonProperty("clusterType")]
public virtual string ClusterType { get; set; }

Property Value

Type	Description
string

ContinuousBackupConfig

Optional. Continuous backup configuration for this cluster.

Declaration

[JsonProperty("continuousBackupConfig")]
public virtual ContinuousBackupConfig ContinuousBackupConfig { get; set; }

Property Value

Type	Description
ContinuousBackupConfig

ContinuousBackupInfo

Output only. Continuous backup properties for this cluster.

Declaration

[JsonProperty("continuousBackupInfo")]
public virtual ContinuousBackupInfo ContinuousBackupInfo { get; set; }

Property Value

Type	Description
ContinuousBackupInfo

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. Create time stamp

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

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.

Declaration

[JsonProperty("databaseVersion")]
public virtual string DatabaseVersion { get; set; }

Property Value

Type	Description
string

DeleteTime

object representation of DeleteTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use DeleteTimeDateTimeOffset instead.")]
public virtual object DeleteTime { get; set; }

Property Value

Type	Description
object

DeleteTimeDateTimeOffset

DateTimeOffset representation of DeleteTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? DeleteTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

DeleteTimeRaw

Output only. Delete time stamp

Declaration

[JsonProperty("deleteTime")]
public virtual string DeleteTimeRaw { get; set; }

Property Value

Type	Description
string

DisplayName

User-settable and human-readable display name for the Cluster.

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }

Property Value

Type	Description
string

ETag

For Resource freshness validation (https://google.aip.dev/154)

Declaration

[JsonProperty("etag")]
public virtual string ETag { get; set; }

Property Value

Type	Description
string

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.

Declaration

[JsonProperty("encryptionConfig")]
public virtual EncryptionConfig EncryptionConfig { get; set; }

Property Value

Type	Description
EncryptionConfig

EncryptionInfo

Output only. The encryption information for the cluster.

Declaration

[JsonProperty("encryptionInfo")]
public virtual EncryptionInfo EncryptionInfo { get; set; }

Property Value

Type	Description
EncryptionInfo

InitialUser

Input only. Initial user to setup during cluster creation. Required. If used in RestoreCluster this is ignored.

Declaration

[JsonProperty("initialUser")]
public virtual UserPassword InitialUser { get; set; }

Property Value

Type	Description
UserPassword

Labels

Labels as key value pairs

Declaration

[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

MaintenanceSchedule

Output only. The maintenance schedule for the cluster, generated for a specific rollout if a maintenance window is set.

Declaration

[JsonProperty("maintenanceSchedule")]
public virtual MaintenanceSchedule MaintenanceSchedule { get; set; }

Property Value

Type	Description
MaintenanceSchedule

MaintenanceUpdatePolicy

Optional. The maintenance update policy determines when to allow or deny updates.

Declaration

[JsonProperty("maintenanceUpdatePolicy")]
public virtual MaintenanceUpdatePolicy MaintenanceUpdatePolicy { get; set; }

Property Value

Type	Description
MaintenanceUpdatePolicy

MigrationSource

Output only. Cluster created via DMS migration.

Declaration

[JsonProperty("migrationSource")]
public virtual MigrationSource MigrationSource { get; set; }

Property Value

Type	Description
MigrationSource

Name

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}

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

Network

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.

Declaration

[JsonProperty("network")]
public virtual string Network { get; set; }

Property Value

Type	Description
string

NetworkConfig

Declaration

[JsonProperty("networkConfig")]
public virtual NetworkConfig NetworkConfig { get; set; }

Property Value

Type	Description
NetworkConfig

PrimaryConfig

Output only. Cross Region replication config specific to PRIMARY cluster.

Declaration

[JsonProperty("primaryConfig")]
public virtual PrimaryConfig PrimaryConfig { get; set; }

Property Value

Type	Description
PrimaryConfig

PscConfig

Optional. The configuration for Private Service Connect (PSC) for the cluster.

Declaration

[JsonProperty("pscConfig")]
public virtual PscConfig PscConfig { get; set; }

Property Value

Type	Description
PscConfig

Reconciling

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.

Declaration

[JsonProperty("reconciling")]
public virtual bool? Reconciling { get; set; }

Property Value

Type	Description
bool?

SatisfiesPzs

Output only. Reserved for future use.

Declaration

[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }

Property Value

Type	Description
bool?

SecondaryConfig

Cross Region replication config specific to SECONDARY cluster.

Declaration

[JsonProperty("secondaryConfig")]
public virtual SecondaryConfig SecondaryConfig { get; set; }

Property Value

Type	Description
SecondaryConfig

SslConfig

SSL configuration for this AlloyDB cluster.

Declaration

[JsonProperty("sslConfig")]
public virtual SslConfig SslConfig { get; set; }

Property Value

Type	Description
SslConfig

State

Output only. The current serving state of the cluster.

Declaration

[JsonProperty("state")]
public virtual string State { get; set; }

Property Value

Type	Description
string

SubscriptionType

Optional. Subscription type of the cluster.

Declaration

[JsonProperty("subscriptionType")]
public virtual string SubscriptionType { get; set; }

Property Value

Type	Description
string

Tags

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example:

"123/environment": "production", "123/costCenter": "marketing"

Declaration

[JsonProperty("tags")]
public virtual IDictionary<string, string> Tags { get; set; }

Property Value

Type	Description
IDictionary<string, string>

TrialMetadata

Output only. Metadata for free trial clusters

Declaration

[JsonProperty("trialMetadata")]
public virtual TrialMetadata TrialMetadata { get; set; }

Property Value

Type	Description
TrialMetadata

Uid

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.

Declaration

[JsonProperty("uid")]
public virtual string Uid { get; set; }

Property Value

Type	Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

Output only. Update time stamp

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema