BackupPlanState class

Input properties used for looking up and filtering BackupPlan resources.

Constructors

BackupPlanState({Input<BackupPlanBackupConfig?>? backupConfig, Input<BackupPlanBackupSchedule?>? backupSchedule, Input<String?>? cluster, Input<bool?>? deactivated, Input<String?>? deletionPolicy, Input<String?>? description, Input<Map<String, String>?>? effectiveLabels, Input<String?>? etag, Input<Map<String, String>?>? labels, Input<String?>? location, Input<String?>? name, Input<String?>? project, Input<int?>? protectedNamespaceCount, Input<int?>? protectedPodCount, Input<Map<String, String>?>? pulumiLabels, Input<BackupPlanRetentionPolicy?>? retentionPolicy, Input<String?>? state, Input<String?>? stateReason, Input<String?>? uid})
Creates a new BackupPlanState. backupConfig Defines the configuration of Backups created via this BackupPlan. backupSchedule Defines a schedule for automatic Backup creation via this BackupPlan. cluster The source cluster from which Backups will be created via this BackupPlan. deactivated This flag indicates whether this BackupPlan has been deactivated. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description User specified descriptive string for this BackupPlan. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. etag etag is used for optimistic concurrency control as a way to help prevent simultaneous labels Description: A set of custom labels supplied by the user. location The region of the Backup Plan. name The full name of the BackupPlan Resource. project The ID of the project in which the resource belongs. protectedNamespaceCount The number of Kubernetes Namespaces backed up in the last successful Backup created via this BackupPlan. protectedPodCount The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan. pulumiLabels The combination of labels configured directly on the resource retentionPolicy RetentionPolicy governs lifecycle of Backups created under this plan. state The State of the BackupPlan. stateReason Detailed description of why BackupPlan is in its current state. uid Server generated, unique identifier of UUID format.
const
BackupPlanState.fromMap(Map<String, dynamic> map)
factory

Properties

backupConfig → Input<BackupPlanBackupConfig?>?
Defines the configuration of Backups created via this BackupPlan. Structure is documented below.
final
backupSchedule → Input<BackupPlanBackupSchedule?>?
Defines a schedule for automatic Backup creation via this BackupPlan. Structure is documented below.
final
cluster → Input<String?>?
The source cluster from which Backups will be created via this BackupPlan.
final
deactivated → Input<bool?>?
This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups).
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
description → Input<String?>?
User specified descriptive string for this BackupPlan.
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
etag → Input<String?>?
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An etag is returned in the response to backupPlans.get, and systems are expected to put that etag in the request to backupPlans.patch or backupPlans.delete to ensure that their change will be applied to the same version of the resource.
final
hashCode → int
The hash code for this object.
no setterinherited
labels → Input<Map<String, String>?>?
Description: A set of custom labels supplied by the user. A list of key->value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
final
location → Input<String?>?
The region of the Backup Plan.
final
name → Input<String?>?
The full name of the BackupPlan Resource.
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
protectedNamespaceCount → Input<int?>?
The number of Kubernetes Namespaces backed up in the last successful Backup created via this BackupPlan.
final
protectedPodCount → Input<int?>?
The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
final
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
retentionPolicy → Input<BackupPlanRetentionPolicy?>?
RetentionPolicy governs lifecycle of Backups created under this plan. Structure is documented below.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → Input<String?>?
The State of the BackupPlan.
final
stateReason → Input<String?>?
Detailed description of why BackupPlan is in its current state.
final
uid → Input<String?>?
Server generated, unique identifier of UUID format.
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