BackupPlanArgs class

The set of arguments for BackupPlan. The set of arguments for BackupPlan.

Constructors

BackupPlanArgs({Input<BackupConfig>? backupConfig, required Input<String> backupPlanId, Input<Schedule>? backupSchedule, required Input<String> cluster, Input<bool>? deactivated, Input<String>? description, Input<Map<String, String>>? labels, Input<String>? location, Input<String>? project, Input<RetentionPolicy>? retentionPolicy})
Creates a new BackupPlanArgs. backupConfig Optional. Defines the configuration of Backups created via this BackupPlan. backupPlanId Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location backupSchedule Optional. Defines a schedule for automatic Backup creation via this BackupPlan. cluster Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/* deactivated Optional. 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). Default: False description Optional. User specified descriptive string for this BackupPlan. labels Optional. A set of custom labels supplied by user. location Optional. project Optional. retentionPolicy Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
const
BackupPlanArgs.fromMap(Map<String, dynamic> map)
factory

Properties

backupConfig → Input<BackupConfig>?
Optional. Defines the configuration of Backups created via this BackupPlan.
final
backupPlanId → Input<String>
Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location
final
backupSchedule → Input<Schedule>?
Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
final
cluster → Input<String>
Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*
final
deactivated → Input<bool>?
Optional. 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). Default: False
final
description → Input<String>?
Optional. User specified descriptive string for this BackupPlan.
final
hashCode → int
The hash code for this object.
no setterinherited
labels → Input<Map<String, String>>?
Optional. A set of custom labels supplied by user.
final
location → Input<String>?
final
project → Input<String>?
final
retentionPolicy → Input<RetentionPolicy>?
Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

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