Backup class

Creates a Backup for the given BackupPlan. Auto-naming is currently not supported for this resource.

Constructors

Backup(String name, {BackupArgs? args, CustomResourceOptions? options})

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

Properties

allNamespaces ↔ Output<bool>

If True, all namespaces were included in the Backup.

late, final

backupId ↔ Output<String?>

Optional. The client-provided short name for the Backup 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 Backups in this BackupPlan

late, final

backupPlanId ↔ Output<String>

late, final

childResources → Set<Resource>

final, inherited

clusterMetadata ↔ Output<ClusterMetadataResponse>

Information about the GKE cluster from which this Backup was created.

late, final

completeTime ↔ Output<String>

Completion time of the Backup

late, final

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

configBackupSizeBytes ↔ Output<String>

The size of the config backup in bytes.

late, final

containsSecrets ↔ Output<bool>

Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.

late, final

containsVolumeData ↔ Output<bool>

Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.

late, final

createTime ↔ Output<String>

The timestamp when this Backup resource was created.

late, final

deleteLockDays ↔ Output<int>

Optional. Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan's backup_delete_lock_days setting and may only be increased (either at creation time or in a subsequent update).

late, final

deleteLockExpireTime ↔ Output<String>

The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days).

late, final

description ↔ Output<String>

Optional. User specified descriptive string for this Backup.

late, final

encryptionKey ↔ Output<EncryptionKeyResponse>

The customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's encryption_key value.

late, final

etag ↔ Output<String>

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An etag is returned in the response to GetBackup, and systems are expected to put that etag in the request to UpdateBackup or DeleteBackup 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

manual ↔ Output<bool>

This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created manually.

late, final

name ↔ Output<String>

The fully qualified name of the Backup. projects/*/locations/*/backupPlans/*/backups/*

late, final

podCount ↔ Output<int>

The total number of Kubernetes Pods contained in the Backup.

late, final

project ↔ Output<String>

late, final

resourceCount ↔ Output<int>

The total number of Kubernetes resources included in the Backup.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

retainDays ↔ Output<int>

Optional. The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0: - If 0, no automatic deletion will occur for this Backup. - If not 0, this must be >= delete_lock_days and <= 365. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's backup_retain_days value.

late, final

retainExpireTime ↔ Output<String>

The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selectedApplications ↔ Output<NamespacedNamesResponse>

If set, the list of ProtectedApplications whose resources were included in the Backup.

late, final

selectedNamespaces ↔ Output<NamespacesResponse>

If set, the list of namespaces that were included in the Backup.

late, final

sizeBytes ↔ Output<String>

The total size of the Backup in bytes = config backup size + sum(volume backup sizes)

late, final

state ↔ Output<String>

Current state of the Backup

late, final

stateReason ↔ Output<String>

Human-readable description of why the backup 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 UUID4

late, final

updateTime ↔ Output<String>

The timestamp when this Backup resource was last updated.

late, final

urn ↔ Output<String>

late, final, inherited

volumeCount ↔ Output<int>

The total number of volume backups contained in the Backup.

late, final

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