Backup class

Creates a backup. 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

backupId ↔ Output<String>

Required. The ID to use for the backup. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.

late, final

capacityGb ↔ Output<String>

Capacity of the source file share when the backup was created.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The time when the backup was created.

late, final

description ↔ Output<String>

A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.

late, final

downloadBytes ↔ Output<String>

Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage.

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

kmsKey ↔ Output<String>

Immutable. KMS key name used for data encryption.

late, final

labels ↔ Output<Map<String, String>>

Resource labels to represent user provided metadata.

late, final

location ↔ Output<String>

late, final

name ↔ Output<String>

The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.

late, final

project ↔ Output<String>

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

satisfiesPzs ↔ Output<bool>

Reserved for future use.

late, final

sourceFileShare ↔ Output<String>

Name of the file share in the source Filestore instance that the backup is created from.

late, final

sourceInstance ↔ Output<String>

The resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.

late, final

sourceInstanceTier ↔ Output<String>

The service tier of the source Filestore instance that this backup is created from.

late, final

state ↔ Output<String>

The backup state.

late, final

storageBytes ↔ Output<String>

The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

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