DiskState class

Input properties used for looking up and filtering Disk resources.

Constructors

DiskState({Input<String?>? accessMode, Input<String?>? architecture, Input<DiskAsyncPrimaryDisk?>? asyncPrimaryDisk, Input<bool?>? createSnapshotBeforeDestroy, Input<String?>? createSnapshotBeforeDestroyPrefix, Input<String?>? creationTimestamp, Input<String?>? deletionPolicy, Input<String?>? description, Input<DiskDiskEncryptionKey?>? diskEncryptionKey, Input<String?>? diskId, Input<Map<String, String>?>? effectiveLabels, Input<bool?>? enableConfidentialCompute, Input<bool?>? eraseWindowsVssSignature, Input<List<DiskGuestOsFeature>?>? guestOsFeatures, Input<String?>? image, Input<String?>? interface, Input<String?>? labelFingerprint, Input<Map<String, String>?>? labels, Input<String?>? lastAttachTimestamp, Input<String?>? lastDetachTimestamp, Input<List<String>?>? licenses, Input<bool?>? multiWriter, Input<String?>? name, Input<DiskParams?>? params, Input<int?>? physicalBlockSizeBytes, Input<String?>? project, Input<int?>? provisionedIops, Input<int?>? provisionedThroughput, Input<Map<String, String>?>? pulumiLabels, Input<List<String>?>? resourcePolicies, Input<String?>? selfLink, Input<int?>? size, Input<String?>? snapshot, Input<String?>? sourceDisk, Input<String?>? sourceDiskId, Input<DiskSourceImageEncryptionKey?>? sourceImageEncryptionKey, Input<String?>? sourceImageId, Input<String?>? sourceInstantSnapshot, Input<String?>? sourceInstantSnapshotId, Input<DiskSourceSnapshotEncryptionKey?>? sourceSnapshotEncryptionKey, Input<String?>? sourceSnapshotId, Input<String?>? sourceStorageObject, Input<String?>? storagePool, Input<String?>? type, Input<List<String>?>? users, Input<String?>? zone})
Creates a new DiskState. accessMode The access mode of the disk. architecture The architecture of the disk. Values include X86_64, ARM64. asyncPrimaryDisk A nested object resource. createSnapshotBeforeDestroy If set to true, a snapshot of the disk will be created before it is destroyed. createSnapshotBeforeDestroyPrefix This will set a custom name prefix for the snapshot that's created when the disk is deleted. creationTimestamp Creation timestamp in RFC3339 text format. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description An optional description of this resource. Provide this property when diskEncryptionKey Encrypts the disk using a customer-supplied encryption key. diskId The unique identifier for the resource. This identifier is defined by the server. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. enableConfidentialCompute Whether this disk is using confidential compute mode. eraseWindowsVssSignature (Optional, Beta) guestOsFeatures A list of features to enable on the guest operating system. image The image from which to initialize this disk. This can be interface (Optional, Beta, Deprecated) labelFingerprint The fingerprint used for optimistic locking of this resource. Used labels Labels to apply to this disk. A list of key->value pairs. lastAttachTimestamp Last attach timestamp in RFC3339 text format. lastDetachTimestamp Last detach timestamp in RFC3339 text format. licenses Any applicable license URI. multiWriter (Optional, Beta) 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 physicalBlockSizeBytes Physical block size of the persistent disk, in bytes. If not present project The ID of the project in which the resource belongs. provisionedIops Indicates how many IOPS must be provisioned for the disk. provisionedThroughput Indicates how much Throughput must be provisioned for the disk. pulumiLabels The combination of labels configured directly on the resource resourcePolicies (Optional, Beta) selfLink The URI of the created resource. size Size of the persistent disk, specified in GB. You can specify this snapshot The source snapshot used to create this disk. You can provide this as sourceDisk The source disk used to create this disk. You can provide this as a partial or full URL to the resource. sourceDiskId The ID value of the disk used to create this image. This value may sourceImageEncryptionKey The customer-supplied encryption key of the source image. Required if sourceImageId The ID value of the image used to create this disk. This value sourceInstantSnapshot The source instant snapshot used to create this disk. You can provide this as a partial or full URL to the resource. sourceInstantSnapshotId The unique ID of the instant snapshot used to create this disk. This value identifies sourceSnapshotEncryptionKey The customer-supplied encryption key of the source snapshot. Required sourceSnapshotId The unique ID of the snapshot used to create this disk. This value sourceStorageObject The full Google Cloud Storage URI where the disk image is stored. storagePool The URL or the name of the storage pool in which the new disk is created. type URL of the disk type resource describing which disk type to use to users Links to the users of the disk (attached instances) in form: zone A reference to the zone where the disk resides.
const
DiskState.fromMap(Map<String, dynamic> map)
factory

Properties

accessMode → Input<String?>?
The access mode of the disk. For example:
final
architecture → Input<String?>?
The architecture of the disk. Values include X86_64, ARM64.
final
asyncPrimaryDisk → Input<DiskAsyncPrimaryDisk?>?
A nested object resource. Structure is documented below.
final
createSnapshotBeforeDestroy → Input<bool?>?
If set to true, a snapshot of the disk will be created before it is destroyed. If your disk is encrypted with customer managed encryption keys these will be reused for the snapshot creation. The name of the snapshot by default will be {{disk-name}}-YYYYMMDD-HHmm
final
createSnapshotBeforeDestroyPrefix → Input<String?>?
This will set a custom name prefix for the snapshot that's created when the disk is deleted.
final
creationTimestamp → Input<String?>?
Creation timestamp in RFC3339 text format.
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. Provide this property when you create the resource.
final
diskEncryptionKey → Input<DiskDiskEncryptionKey?>?
Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Structure is documented below.
final
diskId → Input<String?>?
The unique identifier for the resource. This identifier is defined by the server.
final
effectiveLabels → Input<Map<String, String>?>?
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
final
enableConfidentialCompute → Input<bool?>?
Whether this disk is using confidential compute mode. Note: Only supported on hyperdisk skus, diskEncryptionKey is required when setting to true
final
eraseWindowsVssSignature → Input<bool?>?
(Optional, Beta) Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature.
final
guestOsFeatures → Input<List<DiskGuestOsFeature>?>?
A list of features to enable on the guest operating system. Applicable only for bootable disks. Structure is documented below.
final
hashCode → int
The hash code for this object.
no setterinherited
image → Input<String?>?
The image from which to initialize this disk. This can be one of: the image's selfLink, projects/{project}/global/images/{image}, projects/{project}/global/images/family/{family}, global/images/{image}, global/images/family/{family}, family/{family}, {project}/{family}, {project}/{image}, {family}, or {image}. If referred by family, the images names must include the family name. If they don't, use the gcp.compute.Image data source. For instance, the image centos-6-v20180104 includes its family name centos-6. These images can be referred by family name here.
final
interface → Input<String?>?
(Optional, Beta, Deprecated) Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.
final
labelFingerprint → Input<String?>?
The fingerprint used for optimistic locking of this resource. Used internally during updates.
final
labels → Input<Map<String, String>?>?
Labels to apply to this disk. A list of key->value pairs.
final
lastAttachTimestamp → Input<String?>?
Last attach timestamp in RFC3339 text format.
final
lastDetachTimestamp → Input<String?>?
Last detach timestamp in RFC3339 text format.
final
licenses → Input<List<String>?>?
Any applicable license URI.
final
multiWriter → Input<bool?>?
(Optional, Beta) Indicates whether or not the disk can be read/write attached to more than one instance.
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<DiskParams?>?
Additional params passed with the request, but not persisted as part of resource payload Structure is documented below.
final
physicalBlockSizeBytes → Input<int?>?
Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.
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
provisionedIops → Input<int?>?
Indicates how many IOPS must be provisioned for the disk. Note: Updating currently is only supported by hyperdisk skus without the need to delete and recreate the disk, hyperdisk allows for an update of IOPS every 4 hours. To update your hyperdisk more frequently, you'll need to manually delete and recreate it
final
provisionedThroughput → Input<int?>?
Indicates how much Throughput must be provisioned for the disk. Note: Updating currently is only supported by hyperdisk skus without the need to delete and recreate the disk, hyperdisk allows for an update of Throughput every 4 hours. To update your hyperdisk more frequently, you'll need to manually delete and recreate it
final
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
resourcePolicies → Input<List<String>?>?
(Optional, Beta) Resource policies applied to this disk for automatic snapshot creations. ~>NOTE This value does not support updating the resource policy, as resource policies can not be updated more than one at a time. Use gcp.compute.DiskResourcePolicyAttachment to allow for updating the resource policy attached to the disk.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
The URI of the created resource.
final
size → Input<int?>?
Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the image or snapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with image or snapshot, the value must not be less than the size of the image or the size of the snapshot. ~>NOTE If you change the size, the provider updates the disk size if upsizing is detected but recreates the disk if downsizing is requested. You can add lifecycle.prevent_destroy in the config to prevent destroying and recreating.
final
snapshot → Input<String?>?
The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. If the snapshot is in another project than this disk, you must supply a full URL. For example, the following are valid values:
final
sourceDisk → Input<String?>?
The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
final
sourceDiskId → Input<String?>?
The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
final
sourceImageEncryptionKey → Input<DiskSourceImageEncryptionKey?>?
The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Structure is documented below.
final
sourceImageId → Input<String?>?
The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
final
sourceInstantSnapshot → Input<String?>?
The source instant snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
final
sourceInstantSnapshotId → Input<String?>?
The unique ID of the instant snapshot used to create this disk. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact version of the instant snapshot that was used.
final
sourceSnapshotEncryptionKey → Input<DiskSourceSnapshotEncryptionKey?>?
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
sourceSnapshotId → Input<String?>?
The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
final
sourceStorageObject → Input<String?>?
The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.
final
storagePool → Input<String?>?
The URL or the name of the storage pool in which the new disk is created. For example:
final
type → Input<String?>?
URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
final
users → Input<List<String>?>?
Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
final
zone → Input<String?>?
A reference to the zone where the disk resides.
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