Cluster

import type { Cluster } from "https://googleapis.deno.dev/v1/alloydb:v1.ts";

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.

interface Cluster {

annotations?: {

[key: string]: string;

};

automatedBackupPolicy?: AutomatedBackupPolicy;

readonly backupSource?: BackupSource;

readonly clusterType?: "CLUSTER_TYPE_UNSPECIFIED" | "PRIMARY" | "SECONDARY";

continuousBackupConfig?: ContinuousBackupConfig;

readonly continuousBackupInfo?: ContinuousBackupInfo;

readonly createTime?: Date;

databaseVersion?:

| "DATABASE_VERSION_UNSPECIFIED"

| "POSTGRES_13"

| "POSTGRES_14"

| "POSTGRES_15";

readonly deleteTime?: Date;

displayName?: string;

encryptionConfig?: EncryptionConfig;

readonly encryptionInfo?: EncryptionInfo;

etag?: string;

initialUser?: UserPassword;

labels?: {

[key: string]: string;

};

readonly maintenanceSchedule?: MaintenanceSchedule;

maintenanceUpdatePolicy?: MaintenanceUpdatePolicy;

readonly migrationSource?: MigrationSource;

readonly name?: string;

network?: string;

networkConfig?: NetworkConfig;

readonly primaryConfig?: PrimaryConfig;

pscConfig?: PscConfig;

readonly reconciling?: boolean;

readonly satisfiesPzs?: boolean;

secondaryConfig?: SecondaryConfig;

sslConfig?: SslConfig;

readonly state?:

| "STATE_UNSPECIFIED"

| "READY"

| "STOPPED"

| "EMPTY"

| "CREATING"

| "DELETING"

| "FAILED"

| "BOOTSTRAPPING"

| "MAINTENANCE"

| "PROMOTING";

readonly uid?: string;

readonly updateTime?: Date;

}

§Properties

annotations?: {

[key: string]: string;

}

[src]

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

automatedBackupPolicy?: AutomatedBackupPolicy

[src]

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.

readonly backupSource?: BackupSource

[src]

Output only. Cluster created from backup.

readonly clusterType?: "CLUSTER_TYPE_UNSPECIFIED" | "PRIMARY" | "SECONDARY"

[src]

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

continuousBackupConfig?: ContinuousBackupConfig

[src]

Optional. Continuous backup configuration for this cluster.

readonly continuousBackupInfo?: ContinuousBackupInfo

[src]

Output only. Continuous backup properties for this cluster.

readonly createTime?: Date

[src]

Output only. Create time stamp

databaseVersion?: "DATABASE_VERSION_UNSPECIFIED" | "POSTGRES_13" | "POSTGRES_14" | "POSTGRES_15"

[src]

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.

readonly deleteTime?: Date

[src]

Output only. Delete time stamp

displayName?: string

[src]

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

encryptionConfig?: EncryptionConfig

[src]

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.

readonly encryptionInfo?: EncryptionInfo

[src]

Output only. The encryption information for the cluster.

etag?: string

[src]

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

initialUser?: UserPassword

[src]

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

labels?: {

[key: string]: string;

}

[src]

Labels as key value pairs

readonly maintenanceSchedule?: MaintenanceSchedule

[src]

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

maintenanceUpdatePolicy?: MaintenanceUpdatePolicy

[src]

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

readonly migrationSource?: MigrationSource

[src]

Output only. Cluster created via DMS migration.

readonly name?: string

[src]

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}

network?: string

[src]

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.

networkConfig?: NetworkConfig

[src]

readonly primaryConfig?: PrimaryConfig

[src]

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

pscConfig?: PscConfig

[src]

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

readonly reconciling?: boolean

[src]

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.

readonly satisfiesPzs?: boolean

[src]

Output only. Reserved for future use.

secondaryConfig?: SecondaryConfig

[src]

Cross Region replication config specific to SECONDARY cluster.

sslConfig?: SslConfig

[src]

SSL configuration for this AlloyDB cluster.

[src]

Output only. The current serving state of the cluster.

readonly uid?: string

[src]

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.

readonly updateTime?: Date

[src]

Output only. Update time stamp