SnapshotArgs class

The set of arguments for Snapshot. The set of arguments for Snapshot.

Constructors

SnapshotArgs({Input<String?>? chainName, Input<String?>? deletionPolicy, Input<String?>? description, Input<bool?>? guestFlush, Input<Map<String, String>?>? labels, Input<String?>? name, Input<SnapshotParams?>? params, Input<String?>? project, Input<SnapshotSnapshotEncryptionKey?>? snapshotEncryptionKey, Input<String?>? snapshotType, Input<String?>? sourceDisk, Input<SnapshotSourceDiskEncryptionKey?>? sourceDiskEncryptionKey, Input<String?>? sourceInstantSnapshot, Input<List<String>?>? storageLocations, Input<String?>? zone})
Creates a new SnapshotArgs. chainName Creates the new snapshot in the snapshot chain labeled with the deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description An optional description of this resource. guestFlush (Optional, Beta) labels Labels to apply to this Snapshot. name Name of the resource; provided by the client when the resource is params Additional params passed with the request, but not persisted as part of resource payload project The ID of the project in which the resource belongs. snapshotEncryptionKey Encrypts the snapshot using a customer-supplied encryption key. snapshotType Indicates the type of the snapshot. sourceDisk A reference to the disk used to create this snapshot. sourceDiskEncryptionKey The customer-supplied encryption key of the source snapshot. Required sourceInstantSnapshot A reference to the instant snapshot used to create this snapshot. storageLocations Cloud Storage bucket storage location of the snapshot (regional or multi-regional). zone A reference to the zone where the disk is hosted.
const
SnapshotArgs.fromMap(Map<String, dynamic> map)
factory

Properties

chainName → Input<String?>?
Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.
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?>?
An optional description of this resource.
final
guestFlush → Input<bool?>?
(Optional, Beta) Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.
final
hashCode → int
The hash code for this object.
no setterinherited
labels → Input<Map<String, String>?>?
Labels to apply to this Snapshot. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
final
name → Input<String?>?
Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
final
params → Input<SnapshotParams?>?
Additional params passed with the request, but not persisted as part of resource payload Structure is documented below.
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
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
snapshotEncryptionKey → Input<SnapshotSnapshotEncryptionKey?>?
Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. Structure is documented below.
final
snapshotType → Input<String?>?
Indicates the type of the snapshot. Possible values are: ARCHIVE, STANDARD.
final
sourceDisk → Input<String?>?
A reference to the disk used to create this snapshot.
final
sourceDiskEncryptionKey → Input<SnapshotSourceDiskEncryptionKey?>?
The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. Structure is documented below.
final
sourceInstantSnapshot → Input<String?>?
A reference to the instant snapshot used to create this snapshot.
final
storageLocations → Input<List<String>?>?
Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
final
zone → Input<String?>?
A reference to the zone where the disk is hosted.
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