AlloyDBCluster

automatedBackupPolicy

Optional

object

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.

automatedBackupPolicy.backupWindow

Optional

string

The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.

automatedBackupPolicy.enabled

Optional

boolean

Whether automated automated backups are enabled. If not set, defaults to true.

automatedBackupPolicy.encryptionConfig

Optional

object

Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config.

automatedBackupPolicy.encryptionConfig.kmsKeyNameRef

Optional

object

The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]

automatedBackupPolicy.encryptionConfig.kmsKeyNameRef.external

Optional

string

A reference to an externally managed KMSCryptoKey. Should be in the format `projects/[kms_project_id]/locations/[region]/keyRings/[key_ring_id]/cryptoKeys/[key]`.

automatedBackupPolicy.encryptionConfig.kmsKeyNameRef.name

Optional

string

The `name` of a `KMSCryptoKey` resource.

automatedBackupPolicy.encryptionConfig.kmsKeyNameRef.namespace

Optional

string

The `namespace` of a `KMSCryptoKey` resource.

automatedBackupPolicy.labels

Optional

map (key: string, value: string)

Labels to apply to backups created using this configuration.

automatedBackupPolicy.location

Optional

string

The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.

automatedBackupPolicy.quantityBasedRetention

Optional

object

Quantity-based Backup retention policy to retain recent backups.

automatedBackupPolicy.quantityBasedRetention.count

Optional

integer

The number of backups to retain.

automatedBackupPolicy.timeBasedRetention

Optional

object

Time-based Backup retention policy.

automatedBackupPolicy.timeBasedRetention.retentionPeriod

Optional

string

The retention period.

automatedBackupPolicy.weeklySchedule

Optional

object

Weekly schedule for the Backup.

automatedBackupPolicy.weeklySchedule.daysOfWeek

Optional

list (string)

The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.

automatedBackupPolicy.weeklySchedule.daysOfWeek[]

Optional

string

automatedBackupPolicy.weeklySchedule.startTimes

Required*

list (object)

The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.

automatedBackupPolicy.weeklySchedule.startTimes[]

Required*

object

automatedBackupPolicy.weeklySchedule.startTimes[].hours

Optional

integer

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

automatedBackupPolicy.weeklySchedule.startTimes[].minutes

Optional

integer

Minutes of hour of day. Must be from 0 to 59.

automatedBackupPolicy.weeklySchedule.startTimes[].nanos

Optional

integer

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

automatedBackupPolicy.weeklySchedule.startTimes[].seconds

Optional

integer

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

clusterType

Optional

string

The type of cluster. If not set, defaults to PRIMARY. Default value: "PRIMARY" Possible values: ["PRIMARY", "SECONDARY"].

continuousBackupConfig

Optional

object

Optional. Continuous backup configuration for this cluster.

continuousBackupConfig.enabled

Optional

boolean

Whether ContinuousBackup is enabled.

continuousBackupConfig.encryptionConfig

Optional

object

The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config.

continuousBackupConfig.encryptionConfig.kmsKeyNameRef

Optional

object

The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]

continuousBackupConfig.encryptionConfig.kmsKeyNameRef.external

Optional

string

A reference to an externally managed KMSCryptoKey. Should be in the format `projects/[kms_project_id]/locations/[region]/keyRings/[key_ring_id]/cryptoKeys/[key]`.

continuousBackupConfig.encryptionConfig.kmsKeyNameRef.name

Optional

string

The `name` of a `KMSCryptoKey` resource.

continuousBackupConfig.encryptionConfig.kmsKeyNameRef.namespace

Optional

string

The `namespace` of a `KMSCryptoKey` resource.

continuousBackupConfig.recoveryWindowDays

Optional

integer

The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.

deletionPolicy

Optional

string

Policy to determine if the cluster should be deleted forcefully. Deleting a cluster forcefully, deletes the cluster and all its associated instances within the cluster. Deleting a Secondary cluster with a secondary instance REQUIRES setting deletion_policy = "FORCE" otherwise an error is returned. This is needed as there is no support to delete just the secondary instance, and the only way to delete secondary instance is to delete the associated secondary cluster forcefully which also deletes the secondary instance.

displayName

Optional

string

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

encryptionConfig

Optional

object

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.

encryptionConfig.kmsKeyNameRef

Optional

object

The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]

encryptionConfig.kmsKeyNameRef.external

Optional

string

A reference to an externally managed KMSCryptoKey. Should be in the format `projects/[kms_project_id]/locations/[region]/keyRings/[key_ring_id]/cryptoKeys/[key]`.

encryptionConfig.kmsKeyNameRef.name

Optional

string

The `name` of a `KMSCryptoKey` resource.

encryptionConfig.kmsKeyNameRef.namespace

Optional

string

The `namespace` of a `KMSCryptoKey` resource.

initialUser

Optional

object

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

initialUser.password

Required*

object

The initial password for the user.

initialUser.password.value

Optional

string

Value of the field. Cannot be used if 'valueFrom' is specified.

initialUser.password.valueFrom

Optional

object

Source for the field's value. Cannot be used if 'value' is specified.

initialUser.password.valueFrom.secretKeyRef

Optional

object

Reference to a value with the given key in the given Secret in the resource's namespace.

initialUser.password.valueFrom.secretKeyRef.key

Required*

string

Key that identifies the value to be extracted.

initialUser.password.valueFrom.secretKeyRef.name

Required*

string

Name of the Secret to extract a value from.

initialUser.user

Optional

string

The database username.

location

Required

string

Immutable. The location where the alloydb cluster should reside.

maintenanceUpdatePolicy

Optional

object

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

maintenanceUpdatePolicy.maintenanceWindows

Optional

list (object)

Preferred windows to perform maintenance. Currently limited to 1.

maintenanceUpdatePolicy.maintenanceWindows[]

Optional

object

maintenanceUpdatePolicy.maintenanceWindows[].day

Required*

string

Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.

maintenanceUpdatePolicy.maintenanceWindows[].startTime

Required*

object

Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time.

maintenanceUpdatePolicy.maintenanceWindows[].startTime.hours

Optional

integer

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

maintenanceUpdatePolicy.maintenanceWindows[].startTime.minutes

Optional

integer

Minutes of hour of day. Must be from 0 to 59.

maintenanceUpdatePolicy.maintenanceWindows[].startTime.nanos

Optional

integer

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

maintenanceUpdatePolicy.maintenanceWindows[].startTime.seconds

Optional

integer

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

networkConfig

Optional

object

networkConfig.allocatedIpRange

Optional

string

Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL.

networkConfig.networkRef

Optional

object

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_number}/global/networks/{network_id}`. This is required to create a cluster.

networkConfig.networkRef.external

Optional

string

A reference to an externally managed Compute Network resource. Should be in the format `projects/{{projectID}}/global/networks/{{network}}`.

networkConfig.networkRef.name

Optional

string

The `name` field of a `ComputeNetwork` resource.

networkConfig.networkRef.namespace

Optional

string

The `namespace` field of a `ComputeNetwork` resource.

networkRef

Optional

object

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.

networkRef.external

Optional

string

A reference to an externally managed Compute Network resource. Should be in the format `projects/{{projectID}}/global/networks/{{network}}`.

networkRef.name

Optional

string

The `name` field of a `ComputeNetwork` resource.

networkRef.namespace

Optional

string

The `namespace` field of a `ComputeNetwork` resource.

projectRef

Required

object

The project that this resource belongs to.

projectRef.external

Optional

string

The `projectID` field of a project, when not managed by Config Connector.

projectRef.kind

Optional

string

The kind of the Project resource; optional but must be `Project` if provided.

projectRef.name

Optional

string

The `name` field of a `Project` resource.

projectRef.namespace

Optional

string

The `namespace` field of a `Project` resource.

resourceID

Optional

string

The AlloyDBCluster name. If not given, the metadata.name will be used.

restoreBackupSource

Optional

object

Immutable. The source when restoring from a backup. Conflicts with 'restoreContinuousBackupSource', both can't be set together.

restoreBackupSource.backupNameRef

Required*

object

Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}

restoreBackupSource.backupNameRef.external

Optional

string

If provided must be in the format `projects/[projectId]/locations/[location]/backups/[backupId]`.

restoreBackupSource.backupNameRef.name

Optional

string

The `metadata.name` field of a `AlloyDBBackup` resource.

restoreBackupSource.backupNameRef.namespace

Optional

string

The `metadata.namespace` field of a `AlloyDBBackup` resource.

restoreContinuousBackupSource

Optional

object

Immutable. The source when restoring via point in time recovery (PITR). Conflicts with 'restoreBackupSource', both can't be set together.

restoreContinuousBackupSource.clusterRef

Required*

object

(Required) The name of the source cluster that this cluster is restored from.

restoreContinuousBackupSource.clusterRef.external

Optional

string

A reference to an externally managed AlloyDBCluster resource. Should be in the format "projects/{{projectID}}/locations/{{location}}/clusters/{{clusterID}}".

restoreContinuousBackupSource.clusterRef.name

Optional

string

The name of a AlloyDBCluster resource.

restoreContinuousBackupSource.clusterRef.namespace

Optional

string

The namespace of a AlloyDBCluster resource.

restoreContinuousBackupSource.pointInTime

Required*

string

Immutable. The point in time that this cluster is restored to, in RFC 3339 format.

secondaryConfig

Optional

object

Cross Region replication config specific to SECONDARY cluster.

secondaryConfig.primaryClusterNameRef

Required*

object

The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}

secondaryConfig.primaryClusterNameRef.external

Optional

string

A reference to an externally managed AlloyDBCluster resource. Should be in the format "projects/{{projectID}}/locations/{{location}}/clusters/{{clusterID}}".

secondaryConfig.primaryClusterNameRef.name

Optional

string

The name of a AlloyDBCluster resource.

secondaryConfig.primaryClusterNameRef.namespace

Optional

string

The namespace of a AlloyDBCluster resource.

list (object)

Output only. Cluster created from backup.

object

string

The name of the backup resource.

list (object)

Conditions represent the latest available observations of the object's current state.

object

string

Last time the condition transitioned from one status to another.

string

Human-readable message indicating details about last transition.

string

Unique, one-word, CamelCase reason for the condition's last transition.

string

Status is the status of the condition. Can be True, False, Unknown.

string

Type is the type of the condition.

list (object)

Output only. Continuous backup properties for this cluster.

object

string

Output only. The earliest restorable time that can be restored to. Output only field.

string

Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.

list (object)

Output only. The encryption information for the WALs and backups required for ContinuousBackup.

object

string

Output only. Type of encryption.

list (string)

Output only. Cloud KMS key versions that are being used to protect the database or the backup.

string

list (string)

Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.

string

string

The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

list (object)

Output only. The encryption information for the cluster.

object

string

Output only. Type of encryption.

list (string)

Output only. Cloud KMS key versions that are being used to protect the database or the backup.

string

string

A unique specifier for the AlloyDBCluster resource in GCP.

list (object)

Output only. Cluster created via DMS migration.

object

string

Output only. The host and port of the on-premises instance in host:port format

string

Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.

string

Output only. Type of migration source.

string

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}

integer

ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.

object

ObservedState is the state of the resource as most recently observed in GCP.

string

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`

string

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.