BackupPlan class

Creates a new BackupPlan in a given location. Auto-naming is currently not supported for this resource.

Constructors

BackupPlan(String name, {BackupPlanArgs? args, CustomResourceOptions? options})

Creates a new BackupPlan. name The Pulumi resource name. args Arguments used to configure this BackupPlan. The set of arguments for BackupPlan. options Resource options controlling this resource's behavior.

Properties

backupConfig ↔ Output<BackupConfigResponse>

Optional. Defines the configuration of Backups created via this BackupPlan.

late, final

backupPlanId ↔ Output<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

late, final

backupSchedule ↔ Output<ScheduleResponse>

Optional. Defines a schedule for automatic Backup creation via this BackupPlan.

late, final

childResources → Set<Resource>

final, inherited

cluster ↔ Output<String>

Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*

late, final

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The timestamp when this BackupPlan resource was created.

late, final

deactivated ↔ Output<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

late, final

description ↔ Output<String>

Optional. User specified descriptive string for this BackupPlan.

late, final

etag ↔ Output<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 GetBackupPlan, and systems are expected to put that etag in the request to UpdateBackupPlan or DeleteBackupPlan to ensure that their change will be applied to the same version of the resource.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<Map<String, String>>

Optional. A set of custom labels supplied by user.

late, final

location ↔ Output<String>

late, final

name ↔ Output<String>

The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*

late, final

project ↔ Output<String>

late, final

protectedPodCount ↔ Output<int>

The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

retentionPolicy ↔ Output<RetentionPolicyResponse>

Optional. RetentionPolicy governs lifecycle of Backups created under this plan.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state ↔ Output<String>

State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update

late, final

stateReason ↔ Output<String>

Human-readable description of why BackupPlan is in the current state

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

uid ↔ Output<String>

Server generated global unique identifier of UUID format.

late, final

updateTime ↔ Output<String>

The timestamp when this BackupPlan resource was last updated.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited