SnapshotArgs

data class SnapshotArgs(val chainName: Output<String>? = null, val description: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val locationHint: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val requestId: Output<String>? = null, val snapshotEncryptionKey: Output<CustomerEncryptionKeyArgs>? = null, val snapshotType: Output<SnapshotSnapshotType>? = null, val sourceDisk: Output<String>? = null, val sourceDiskEncryptionKey: Output<CustomerEncryptionKeyArgs>? = null, val storageLocations: Output<List<String>>? = null) : ConvertibleToJava<SnapshotArgs>

Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project.

Constructors

Link copied to clipboard
fun SnapshotArgs(chainName: Output<String>? = null, description: Output<String>? = null, labels: Output<Map<String, String>>? = null, locationHint: Output<String>? = null, name: Output<String>? = null, project: Output<String>? = null, requestId: Output<String>? = null, snapshotEncryptionKey: Output<CustomerEncryptionKeyArgs>? = null, snapshotType: Output<SnapshotSnapshotType>? = null, sourceDisk: Output<String>? = null, sourceDiskEncryptionKey: Output<CustomerEncryptionKeyArgs>? = null, storageLocations: Output<List<String>>? = null)

Functions

Link copied to clipboard
open override fun toJava(): SnapshotArgs

Properties

Link copied to clipboard
val chainName: Output<String>? = null

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.

Link copied to clipboard
val description: Output<String>? = null

An optional description of this resource. Provide this property when you create the resource.

Link copied to clipboard
val labels: Output<Map<String, String>>? = null

Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.

Link copied to clipboard
val locationHint: Output<String>? = null

An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.

Link copied to clipboard
val name: Output<String>? = null

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]([-a-z0-9]*[a-z0-9])? 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.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val requestId: Output<String>? = null

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Link copied to clipboard

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.

Link copied to clipboard
val snapshotType: Output<SnapshotSnapshotType>? = null

Indicates the type of the snapshot.

Link copied to clipboard
val sourceDisk: Output<String>? = null

The source disk used to create this snapshot.

Link copied to clipboard

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

Link copied to clipboard
val storageLocations: Output<List<String>>? = null

Cloud Storage bucket storage location of the snapshot (regional or multi-regional).