ClusterState class

Input properties used for looking up and filtering Cluster resources.

Constructors

ClusterState({Input<Map<String, String>?>? annotations, Input<ClusterAutomatedBackupPolicy?>? automatedBackupPolicy, Input<List<ClusterBackupSource>?>? backupSources, Input<List<ClusterBackupdrBackupSource>?>? backupdrBackupSources, Input<String?>? clusterId, Input<String?>? clusterType, Input<ClusterContinuousBackupConfig?>? continuousBackupConfig, Input<List<ClusterContinuousBackupInfo>?>? continuousBackupInfos, Input<String?>? databaseVersion, Input<ClusterDataplexConfig?>? dataplexConfig, Input<String?>? deletionPolicy, Input<bool?>? deletionProtection, Input<String?>? displayName, Input<Map<String, String>?>? effectiveAnnotations, Input<Map<String, String>?>? effectiveLabels, Input<ClusterEncryptionConfig?>? encryptionConfig, Input<List<ClusterEncryptionInfo>?>? encryptionInfos, Input<String?>? etag, Input<ClusterInitialUser?>? initialUser, Input<Map<String, String>?>? labels, Input<String?>? location, Input<ClusterMaintenanceUpdatePolicy?>? maintenanceUpdatePolicy, Input<List<ClusterMigrationSource>?>? migrationSources, Input<String?>? name, Input<ClusterNetworkConfig?>? networkConfig, Input<String?>? project, Input<ClusterPscConfig?>? pscConfig, Input<Map<String, String>?>? pulumiLabels, Input<bool?>? reconciling, Input<ClusterRestoreBackupSource?>? restoreBackupSource, Input<ClusterRestoreBackupdrBackupSource?>? restoreBackupdrBackupSource, Input<ClusterRestoreBackupdrPitrSource?>? restoreBackupdrPitrSource, Input<ClusterRestoreContinuousBackupSource?>? restoreContinuousBackupSource, Input<ClusterSecondaryConfig?>? secondaryConfig, Input<bool?>? skipAwaitMajorVersionUpgrade, Input<String?>? state, Input<String?>? subscriptionType, Input<List<ClusterTrialMetadata>?>? trialMetadatas, Input<String?>? uid})
Creates a new ClusterState. annotations Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 automatedBackupPolicy The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. backupSources Cluster created from backup. backupdrBackupSources Cluster created from a BackupDR backup. clusterId The ID of the alloydb cluster. clusterType The type of cluster. If not set, defaults to PRIMARY. continuousBackupConfig The continuous backup config for this cluster. continuousBackupInfos ContinuousBackupInfo describes the continuous backup properties of a cluster. databaseVersion The database engine major version. This is an optional field and it's populated at the Cluster creation time. dataplexConfig Configuration for Dataplex integration. This is an optional field. If not set, Dataplex integration will be enabled by default. deletionPolicy Policy to determine if the cluster should be deleted forcefully. deletionProtection Whether Terraform will be prevented from destroying the cluster. displayName User-settable and human-readable display name for the Cluster. effectiveAnnotations All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. encryptionConfig EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). encryptionInfos (Output) etag For Resource freshness validation (https://google.aip.dev/154) initialUser Initial user to setup during cluster creation. If unset for new Clusters, a postgres role with null password is created. You will need to create additional users or set the password in order to log in. labels User-defined labels for the alloydb cluster. location The location where the alloydb cluster should reside. maintenanceUpdatePolicy MaintenanceUpdatePolicy defines the policy for system updates. migrationSources Cluster created via DMS migration. name The name of the cluster resource. networkConfig Metadata related to network configuration. project The ID of the project in which the resource belongs. pscConfig Configuration for Private Service Connect (PSC) for the cluster. pulumiLabels The combination of labels configured directly on the resource reconciling Output only. Reconciling (https://google.aip.dev/128#reconciliation). restoreBackupSource The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', 'restore_backupdr_backup_source' and 'restore_backupdr_pitr_source', they can't be set together. restoreBackupdrBackupSource The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', 'restore_backup_source' and 'restore_backupdr_pitr_source', they can't be set together. restoreBackupdrPitrSource The BackupDR source used for point in time recovery. Conflicts with 'restore_backupdr_backup_source', 'restore_continuous_backup_source' and 'restore_backupdr_backup_source', they can't be set togeter. restoreContinuousBackupSource The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', 'restore_backupdr_backup_source' and 'restore_backupdr_pitr_source', they can't be set together. secondaryConfig Configuration of the secondary cluster for Cross Region Replication. This should be set if and only if the cluster is of type SECONDARY. skipAwaitMajorVersionUpgrade Set to true to skip awaiting on the major version upgrade of the cluster. state Output only. The current serving state of the cluster. subscriptionType The subscrition type of cluster. trialMetadatas Contains information and all metadata related to TRIAL clusters. uid The system-generated UID of the resource.
const
ClusterState.fromMap(Map<String, dynamic> map)
factory

Properties

annotations → Input<Map<String, String>?>?
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
final
automatedBackupPolicy → Input<ClusterAutomatedBackupPolicy?>?
The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.
final
backupdrBackupSources → Input<List<ClusterBackupdrBackupSource>?>?
Cluster created from a BackupDR backup. Structure is documented below.
final
backupSources → Input<List<ClusterBackupSource>?>?
Cluster created from backup. Structure is documented below.
final
clusterId → Input<String?>?
The ID of the alloydb cluster.
final
clusterType → Input<String?>?
The type of cluster. If not set, defaults to PRIMARY. Default value is PRIMARY. Possible values are: PRIMARY, SECONDARY.
final
continuousBackupConfig → Input<ClusterContinuousBackupConfig?>?
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.
final
continuousBackupInfos → Input<List<ClusterContinuousBackupInfo>?>?
ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
final
databaseVersion → Input<String?>?
The database engine major version. This is an optional field and it's populated at the Cluster creation time. Note: Changing this field to a higer version results in upgrading the AlloyDB cluster which is an irreversible change.
final
dataplexConfig → Input<ClusterDataplexConfig?>?
Configuration for Dataplex integration. This is an optional field. If not set, Dataplex integration will be enabled by default. Structure is documented below.
final
deletionPolicy → Input<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 deletionPolicy = "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.
final
deletionProtection → Input<bool?>?
Whether Terraform will be prevented from destroying the cluster. When the field is set to true or unset in Terraform state, a pulumi up or terraform destroy that would delete the cluster will fail. When the field is set to false, deleting the cluster is allowed.
final
displayName → Input<String?>?
User-settable and human-readable display name for the Cluster.
final
effectiveAnnotations → Input<Map<String, String>?>?
All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
final
effectiveLabels → Input<Map<String, String>?>?
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
final
encryptionConfig → Input<ClusterEncryptionConfig?>?
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.
final
encryptionInfos → Input<List<ClusterEncryptionInfo>?>?
(Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
final
etag → Input<String?>?
For Resource freshness validation (https://google.aip.dev/154)
final
hashCode → int
The hash code for this object.
no setterinherited
initialUser → Input<ClusterInitialUser?>?
Initial user to setup during cluster creation. If unset for new Clusters, a postgres role with null password is created. You will need to create additional users or set the password in order to log in. Structure is documented below.
final
labels → Input<Map<String, String>?>?
User-defined labels for the alloydb cluster. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
final
location → Input<String?>?
The location where the alloydb cluster should reside.
final
maintenanceUpdatePolicy → Input<ClusterMaintenanceUpdatePolicy?>?
MaintenanceUpdatePolicy defines the policy for system updates. Structure is documented below.
final
migrationSources → Input<List<ClusterMigrationSource>?>?
Cluster created via DMS migration. Structure is documented below.
final
name → Input<String?>?
The name of the cluster resource.
final
networkConfig → Input<ClusterNetworkConfig?>?
Metadata related to network configuration. Structure is documented below.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
pscConfig → Input<ClusterPscConfig?>?
Configuration for Private Service Connect (PSC) for the cluster. Structure is documented below.
final
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
reconciling → Input<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.
final
restoreBackupdrBackupSource → Input<ClusterRestoreBackupdrBackupSource?>?
The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', 'restore_backup_source' and 'restore_backupdr_pitr_source', they can't be set together. Structure is documented below.
final
restoreBackupdrPitrSource → Input<ClusterRestoreBackupdrPitrSource?>?
The BackupDR source used for point in time recovery. Conflicts with 'restore_backupdr_backup_source', 'restore_continuous_backup_source' and 'restore_backupdr_backup_source', they can't be set togeter. Structure is documented below.
final
restoreBackupSource → Input<ClusterRestoreBackupSource?>?
The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', 'restore_backupdr_backup_source' and 'restore_backupdr_pitr_source', they can't be set together. Structure is documented below.
final
restoreContinuousBackupSource → Input<ClusterRestoreContinuousBackupSource?>?
The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', 'restore_backupdr_backup_source' and 'restore_backupdr_pitr_source', they can't be set together. Structure is documented below.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secondaryConfig → Input<ClusterSecondaryConfig?>?
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.
final
skipAwaitMajorVersionUpgrade → Input<bool?>?
Set to true to skip awaiting on the major version upgrade of the cluster. Possible values: true, false Default value: "true"
final
state → Input<String?>?
Output only. The current serving state of the cluster.
final
subscriptionType → Input<String?>?
The subscrition type of cluster. Possible values are: TRIAL, STANDARD.
final
trialMetadatas → Input<List<ClusterTrialMetadata>?>?
Contains information and all metadata related to TRIAL clusters. Structure is documented below.
final
uid → Input<String?>?
The system-generated UID of the resource.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited