Marketplace
BrowsePublish
Marketplace
You are viewing an outdated version of provider-gcp.Go to Latest
upbound/provider-gcp@v1.0.2
Cluster
alloydb.gcp.upbound.io
Cluster
upbound/provider-gcp@v1.0.2alloydb.gcp.upbound.io

Cluster is the Schema for the Clusters API. A managed alloydb cluster.

Type

CRD

Group

alloydb.gcp.upbound.io

Version

v1beta1

apiVersion: alloydb.gcp.upbound.io/v1beta1

kind: Cluster

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

ClusterSpec defines the desired state of Cluster

forProvider
requiredobject
requiredobject

No description provided.

array

The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.

enabled
boolean
array

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

labels
object
location
string
array

Quantity-based Backup retention policy to retain recent backups. Conflicts with 'time_based_retention', both can't be set together. Structure is documented below.

count
number
array

Time-based Backup retention policy. Conflicts with 'quantity_based_retention', both can't be set together. Structure is documented below.

array

Weekly schedule for the Backup. Structure is documented below.

array

The days of the week to perform a backup. At least one day of the week must be provided. Each value may be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

array

The times during the day to start a backup. At least one start time must be provided. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). Structure is documented below.

hours
number
minutes
number
nanos
number
seconds
number
array

The continuous backup config for this cluster. If no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days. Structure is documented below.

enabled
boolean
array

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

array

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

etag
string
array

Initial user to setup during cluster creation. Structure is documented below.

passwordSecretRef
requiredobject
requiredobject

The initial password for the user. Note: This property is sensitive and will not be displayed in the plan.

key
requiredstring
name
requiredstring
namespace
requiredstring
user
string
labels
object
location
requiredstring
network
string
array

Metadata related to network configuration. Structure is documented below.

object

Reference to a Network in compute to populate network.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Network in compute to populate network.

policy
object
object

Policies for selection.

resolve
string
project
string
array

The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. Structure is documented below.

object

Reference to a Backup in alloydb to populate backupName.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Backup in alloydb to populate backupName.

policy
object
object

Policies for selection.

resolve
string
array

The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. Structure is documented below.

cluster
string
object

Reference to a Cluster in alloydb to populate cluster.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Cluster in alloydb to populate cluster.

policy
object
object

Policies for selection.

resolve
string
array

Configuration of the secondary cluster for Cross Region Replication. This should be set if and only if the cluster is of type SECONDARY. Structure is documented below.

object

Reference to a Cluster in alloydb to populate primaryClusterName.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Cluster in alloydb to populate primaryClusterName.

policy
object
object

Policies for selection.

resolve
string
object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

array

The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.

enabled
boolean
array

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

labels
object
array

Quantity-based Backup retention policy to retain recent backups. Conflicts with 'time_based_retention', both can't be set together. Structure is documented below.

count
number
array

Time-based Backup retention policy. Conflicts with 'quantity_based_retention', both can't be set together. Structure is documented below.

array

Weekly schedule for the Backup. Structure is documented below.

array

The days of the week to perform a backup. At least one day of the week must be provided. Each value may be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

array

The times during the day to start a backup. At least one start time must be provided. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). Structure is documented below.

hours
number
minutes
number
nanos
number
seconds
number
array

The continuous backup config for this cluster. If no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days. Structure is documented below.

enabled
boolean
array

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

array

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

etag
string
array

Initial user to setup during cluster creation. Structure is documented below.

user
string
labels
object
network
string
array

Metadata related to network configuration. Structure is documented below.

object

Reference to a Network in compute to populate network.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Network in compute to populate network.

policy
object
object

Policies for selection.

resolve
string
project
string
array

The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. Structure is documented below.

object

Reference to a Backup in alloydb to populate backupName.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Backup in alloydb to populate backupName.

policy
object
object

Policies for selection.

resolve
string
array

The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. Structure is documented below.

cluster
string
object

Reference to a Cluster in alloydb to populate cluster.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Cluster in alloydb to populate cluster.

policy
object
object

Policies for selection.

resolve
string
array

Configuration of the secondary cluster for Cross Region Replication. This should be set if and only if the cluster is of type SECONDARY. Structure is documented below.

object

Reference to a Cluster in alloydb to populate primaryClusterName.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Cluster in alloydb to populate primaryClusterName.

policy
object
object

Policies for selection.

resolve
string
array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

ClusterStatus defines the observed state of Cluster.

object

No description provided.

array

The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.

enabled
boolean
array

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

labels
object
location
string
array

Quantity-based Backup retention policy to retain recent backups. Conflicts with 'time_based_retention', both can't be set together. Structure is documented below.

count
number
array

Time-based Backup retention policy. Conflicts with 'quantity_based_retention', both can't be set together. Structure is documented below.

array

Weekly schedule for the Backup. Structure is documented below.

array

The days of the week to perform a backup. At least one day of the week must be provided. Each value may be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

array

The times during the day to start a backup. At least one start time must be provided. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). Structure is documented below.

hours
number
minutes
number
nanos
number
seconds
number
array

Cluster created from backup. Structure is documented below.

array

The continuous backup config for this cluster. If no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days. Structure is documented below.

enabled
boolean
array

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

array

ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.

array

(Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.

array

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

array

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

array

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

array

EncryptionInfo describes the encryption information of a cluster or a backup. Structure is documented below.

array

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

etag
string
id
string
array

Initial user to setup during cluster creation. Structure is documented below.

user
string
labels
object
location
string
array

Cluster created via DMS migration. Structure is documented below.

name
string
network
string
array

Metadata related to network configuration. Structure is documented below.

project
string
array

The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. Structure is documented below.

array

The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. Structure is documented below.

cluster
string
array

Configuration of the secondary cluster for Cross Region Replication. This should be set if and only if the cluster is of type SECONDARY. Structure is documented below.

state
string
uid
string
array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Marketplace

Discover the building blocks for your internal cloud platform.

© 2022 Upbound, Inc.

SolutionsProvidersConfigurations
LearnDocumentationTry for Free
MorePrivacy PolicyTerms & Conditions
Marketplace

© 2022 Upbound, Inc.

Marketplace

Discover the building blocksfor your internal cloud platform.