import * as pulumi from "@pulumi/pulumi"; import { input as inputs, output as outputs } from "../../types"; /** * Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. */ export declare class Disk extends pulumi.CustomResource { /** * Get an existing Disk resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): Disk; /** * Returns true if the given object is an instance of Disk. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Disk; /** * [Output Only] Creation timestamp in RFC3339 text format. */ readonly creationTimestamp: pulumi.Output; /** * An optional description of this resource. Provide this property when you create the resource. */ readonly description: pulumi.Output; /** * 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, to create a disk image, to create a machine 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. */ readonly diskEncryptionKey: pulumi.Output; /** * Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature. */ readonly eraseWindowsVssSignature: pulumi.Output; /** * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ readonly guestOsFeatures: pulumi.Output; /** * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. */ readonly interface: pulumi.Output; /** * [Output Only] Type of the resource. Always compute#disk for disks. */ readonly kind: pulumi.Output; /** * A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. * * To see the latest fingerprint, make a get() request to retrieve a disk. */ readonly labelFingerprint: pulumi.Output; /** * Labels to apply to this disk. These can be later modified by the setLabels method. */ readonly labels: pulumi.Output<{ [key: string]: string; }>; /** * [Output Only] Last attach timestamp in RFC3339 text format. */ readonly lastAttachTimestamp: pulumi.Output; /** * [Output Only] Last detach timestamp in RFC3339 text format. */ readonly lastDetachTimestamp: pulumi.Output; /** * Integer license codes indicating which licenses are attached to this disk. */ readonly licenseCodes: pulumi.Output; /** * A list of publicly visible licenses. Reserved for Google's use. */ readonly licenses: pulumi.Output; /** * An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API. */ readonly locationHint: pulumi.Output; /** * Indicates whether or not the disk can be read/write attached to more than one instance. */ readonly multiWriter: pulumi.Output; /** * 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. */ readonly name: pulumi.Output; /** * Internal use only. */ readonly options: pulumi.Output; /** * Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, 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. */ readonly physicalBlockSizeBytes: pulumi.Output; /** * Indicates how many IOPS must be provisioned for the disk. */ readonly provisionedIops: pulumi.Output; /** * [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ readonly region: pulumi.Output; /** * URLs of the zones where the disk should be replicated to. Only applicable for regional resources. */ readonly replicaZones: pulumi.Output; /** * Resource policies applied to this disk for automatic snapshot creations. */ readonly resourcePolicies: pulumi.Output; /** * [Output Only] Reserved for future use. */ readonly satisfiesPzs: pulumi.Output; /** * [Output Only] Server-defined fully-qualified URL for this resource. */ readonly selfLink: pulumi.Output; /** * [Output Only] Server-defined URL for this resource's resource id. */ readonly selfLinkWithId: pulumi.Output; /** * Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. * * If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive. */ readonly sizeGb: pulumi.Output; /** * 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: * - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk * - https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk * - projects/project/zones/zone/disks/disk * - projects/project/regions/region/disks/disk * - zones/zone/disks/disk * - regions/region/disks/disk */ readonly sourceDisk: pulumi.Output; /** * [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used. */ readonly sourceDiskId: pulumi.Output; /** * The source image used to create this disk. If the source image is deleted, this field will not be set. * * To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: * projects/debian-cloud/global/images/family/debian-9 * * * Alternatively, use a specific version of a public operating system image: * projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD * * * To create a disk with a custom image that you created, specify the image name in the following format: * global/images/my-custom-image * * * You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: * global/images/family/my-image-family */ readonly sourceImage: pulumi.Output; /** * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. */ readonly sourceImageEncryptionKey: pulumi.Output; /** * [Output Only] 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. */ readonly sourceImageId: pulumi.Output; /** * [Deprecated] The source in-place 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: * - https://www.googleapis.com/compute/v1/projects/project/global/inPlaceSnapshots/inPlaceSnapshots * - projects/project/global/inPlaceSnapshots/inPlaceSnapshots * - global/inPlaceSnapshots/inPlaceSnapshots */ readonly sourceInPlaceSnapshot: pulumi.Output; /** * [Deprecated] [Output Only] The unique ID of the in-place snapshot used to create this disk. This value identifies the exact in-place snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an in-place snapshot that was later deleted and recreated under the same name, the source in-place snapshot ID would identify the exact version of the in-place snapshot that was used. */ readonly sourceInPlaceSnapshotId: pulumi.Output; /** * 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: * - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot * - projects/project/zones/zone/instantSnapshots/instantSnapshot * - zones/zone/instantSnapshots/instantSnapshot */ readonly sourceInstantSnapshot: pulumi.Output; /** * [Output Only] 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. */ readonly sourceInstantSnapshotId: pulumi.Output; /** * The source 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: * - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot * - projects/project/global/snapshots/snapshot * - global/snapshots/snapshot */ readonly sourceSnapshot: pulumi.Output; /** * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. */ readonly sourceSnapshotEncryptionKey: pulumi.Output; /** * [Output Only] 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. */ readonly sourceSnapshotId: pulumi.Output; /** * 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. */ readonly sourceStorageObject: pulumi.Output; /** * [Output Only] The status of disk creation. * - CREATING: Disk is provisioning. * - RESTORING: Source data is being copied into the disk. * - FAILED: Disk creation failed. * - READY: Disk is ready for use. * - DELETING: Disk is deleting. */ readonly status: pulumi.Output; /** * [Deprecated] Storage type of the persistent disk. */ readonly storageType: pulumi.Output; /** * URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd */ readonly type: pulumi.Output; /** * A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: * https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch */ readonly userLicenses: pulumi.Output; /** * [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance */ readonly users: pulumi.Output; /** * [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ readonly zone: pulumi.Output; /** * Create a Disk resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: DiskArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a Disk resource. */ export interface DiskArgs { /** * [Output Only] Creation timestamp in RFC3339 text format. */ readonly creationTimestamp?: pulumi.Input; /** * An optional description of this resource. Provide this property when you create the resource. */ readonly description?: pulumi.Input; readonly disk: pulumi.Input; /** * 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, to create a disk image, to create a machine 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. */ readonly diskEncryptionKey?: pulumi.Input; /** * Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature. */ readonly eraseWindowsVssSignature?: pulumi.Input; /** * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ readonly guestOsFeatures?: pulumi.Input[]>; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ readonly id?: pulumi.Input; /** * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. */ readonly interface?: pulumi.Input; /** * [Output Only] Type of the resource. Always compute#disk for disks. */ readonly kind?: pulumi.Input; /** * A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. * * To see the latest fingerprint, make a get() request to retrieve a disk. */ readonly labelFingerprint?: pulumi.Input; /** * Labels to apply to this disk. These can be later modified by the setLabels method. */ readonly labels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * [Output Only] Last attach timestamp in RFC3339 text format. */ readonly lastAttachTimestamp?: pulumi.Input; /** * [Output Only] Last detach timestamp in RFC3339 text format. */ readonly lastDetachTimestamp?: pulumi.Input; /** * Integer license codes indicating which licenses are attached to this disk. */ readonly licenseCodes?: pulumi.Input[]>; /** * A list of publicly visible licenses. Reserved for Google's use. */ readonly licenses?: pulumi.Input[]>; /** * An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API. */ readonly locationHint?: pulumi.Input; /** * Indicates whether or not the disk can be read/write attached to more than one instance. */ readonly multiWriter?: pulumi.Input; /** * 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. */ readonly name?: pulumi.Input; /** * Internal use only. */ readonly options?: pulumi.Input; /** * Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, 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. */ readonly physicalBlockSizeBytes?: pulumi.Input; readonly project: pulumi.Input; /** * Indicates how many IOPS must be provisioned for the disk. */ readonly provisionedIops?: pulumi.Input; /** * [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ readonly region?: pulumi.Input; /** * URLs of the zones where the disk should be replicated to. Only applicable for regional resources. */ readonly replicaZones?: pulumi.Input[]>; /** * Resource policies applied to this disk for automatic snapshot creations. */ readonly resourcePolicies?: pulumi.Input[]>; /** * [Output Only] Reserved for future use. */ readonly satisfiesPzs?: pulumi.Input; /** * [Output Only] Server-defined fully-qualified URL for this resource. */ readonly selfLink?: pulumi.Input; /** * [Output Only] Server-defined URL for this resource's resource id. */ readonly selfLinkWithId?: pulumi.Input; /** * Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. * * If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive. */ readonly sizeGb?: pulumi.Input; /** * 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: * - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk * - https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk * - projects/project/zones/zone/disks/disk * - projects/project/regions/region/disks/disk * - zones/zone/disks/disk * - regions/region/disks/disk */ readonly sourceDisk?: pulumi.Input; /** * [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used. */ readonly sourceDiskId?: pulumi.Input; /** * The source image used to create this disk. If the source image is deleted, this field will not be set. * * To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: * projects/debian-cloud/global/images/family/debian-9 * * * Alternatively, use a specific version of a public operating system image: * projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD * * * To create a disk with a custom image that you created, specify the image name in the following format: * global/images/my-custom-image * * * You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: * global/images/family/my-image-family */ readonly sourceImage?: pulumi.Input; /** * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. */ readonly sourceImageEncryptionKey?: pulumi.Input; /** * [Output Only] 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. */ readonly sourceImageId?: pulumi.Input; /** * [Deprecated] The source in-place 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: * - https://www.googleapis.com/compute/v1/projects/project/global/inPlaceSnapshots/inPlaceSnapshots * - projects/project/global/inPlaceSnapshots/inPlaceSnapshots * - global/inPlaceSnapshots/inPlaceSnapshots */ readonly sourceInPlaceSnapshot?: pulumi.Input; /** * [Deprecated] [Output Only] The unique ID of the in-place snapshot used to create this disk. This value identifies the exact in-place snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an in-place snapshot that was later deleted and recreated under the same name, the source in-place snapshot ID would identify the exact version of the in-place snapshot that was used. */ readonly sourceInPlaceSnapshotId?: pulumi.Input; /** * 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: * - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot * - projects/project/zones/zone/instantSnapshots/instantSnapshot * - zones/zone/instantSnapshots/instantSnapshot */ readonly sourceInstantSnapshot?: pulumi.Input; /** * [Output Only] 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. */ readonly sourceInstantSnapshotId?: pulumi.Input; /** * The source 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: * - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot * - projects/project/global/snapshots/snapshot * - global/snapshots/snapshot */ readonly sourceSnapshot?: pulumi.Input; /** * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. */ readonly sourceSnapshotEncryptionKey?: pulumi.Input; /** * [Output Only] 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. */ readonly sourceSnapshotId?: pulumi.Input; /** * 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. */ readonly sourceStorageObject?: pulumi.Input; /** * [Output Only] The status of disk creation. * - CREATING: Disk is provisioning. * - RESTORING: Source data is being copied into the disk. * - FAILED: Disk creation failed. * - READY: Disk is ready for use. * - DELETING: Disk is deleting. */ readonly status?: pulumi.Input; /** * [Deprecated] Storage type of the persistent disk. */ readonly storageType?: pulumi.Input; /** * URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd */ readonly type?: pulumi.Input; /** * A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: * https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch */ readonly userLicenses?: pulumi.Input[]>; /** * [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance */ readonly users?: pulumi.Input[]>; /** * [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ readonly zone: pulumi.Input; }