Skip to content

Latest commit

 

History

History
897 lines (600 loc) · 39.3 KB

compute_disk.md

File metadata and controls

897 lines (600 loc) · 39.3 KB
Raw
permalink
/compute_disk/

compute_disk

compute_disk represents the google_compute_disk Terraform resource.

This package contains functions and utilities for setting up the resource using Jsonnet code.

Index

Fields

fn new

new()

google.compute_disk.new injects a new google_compute_disk Terraform resource block into the root module document.

Additionally, this inserts a private function into the _ref attribute that generates references to attributes of the resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
google.compute_disk.new('some_id')

You can get the reference to the id field of the created google.compute_disk using the reference:

$._ref.google_compute_disk.some_id.get('id')

This is the same as directly entering "${ google_compute_disk.some_id.id }" as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super, self, or $ to refer to the root object. Instead, make an explicit outer object using local.

Args:

  • resourceLabel (string): The name label of the block.
  • description (string): An optional description of this resource. Provide this property when you create the resource. When null, the description field will be omitted from the resulting object.
  • image (string): The image from which to initialize this disk. This can be one of: the image's 'self_link', '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 google_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. When null, the image field will be omitted from the resulting object.
  • labels (obj): Labels to apply to this disk. A list of key->value pairs. When null, the labels field will be omitted from the resulting object.
  • licenses (list): Any applicable license URI. When null, the licenses field will be omitted from the resulting object.
  • name (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.
  • physical_block_size_bytes (number): 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. When null, the physical_block_size_bytes field will be omitted from the resulting object.
  • project (string): Set the project field on the resulting resource block. When null, the project field will be omitted from the resulting object.
  • provisioned_iops (number): 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 When null, the provisioned_iops field will be omitted from the resulting object.
  • provisioned_throughput (number): 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 When null, the provisioned_throughput field will be omitted from the resulting object.
  • size (number): 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, Terraform 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. When null, the size field will be omitted from the resulting object.

  • snapshot (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:

  • 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot'

  • 'projects/project/global/snapshots/snapshot'

  • 'global/snapshots/snapshot'

  • 'snapshot' When null, the snapshot field will be omitted from the resulting object.

    • source_disk (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:

  • 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} When null, the source_disk field will be omitted from the resulting object.

    • type (string): URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. When null, the type field will be omitted from the resulting object.
    • zone (string): A reference to the zone where the disk resides. When null, the zone field will be omitted from the resulting object.
    • async_primary_disk (list[obj]): A nested object resource When null, the async_primary_disk sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.compute_disk.async_primary_disk.new constructor.
    • disk_encryption_key (list[obj]): 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. When null, the disk_encryption_key sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.compute_disk.disk_encryption_key.new constructor.

  • guest_os_features (list[obj]): A list of features to enable on the guest operating system. Applicable only for bootable disks. When null, the guest_os_features sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.compute_disk.guest_os_features.new constructor.
  • source_image_encryption_key (list[obj]): The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. When null, the source_image_encryption_key sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.compute_disk.source_image_encryption_key.new constructor.
  • source_snapshot_encryption_key (list[obj]): The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. When null, the source_snapshot_encryption_key sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.compute_disk.source_snapshot_encryption_key.new constructor.
  • timeouts (obj): Set the timeouts field on the resulting resource block. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.compute_disk.timeouts.new constructor.

Returns:

  • A mixin object that injects the new resource into the root Terraform configuration.

fn newAttrs

newAttrs()

google.compute_disk.newAttrs constructs a new object with attributes and blocks configured for the compute_disk Terraform resource.

Unlike google.compute_disk.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

  • description (string): An optional description of this resource. Provide this property when you create the resource. When null, the description field will be omitted from the resulting object.
  • image (string): The image from which to initialize this disk. This can be one of: the image's 'self_link', '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 google_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. When null, the image field will be omitted from the resulting object.
  • labels (obj): Labels to apply to this disk. A list of key->value pairs. When null, the labels field will be omitted from the resulting object.
  • licenses (list): Any applicable license URI. When null, the licenses field will be omitted from the resulting object.
  • name (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.
  • physical_block_size_bytes (number): 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. When null, the physical_block_size_bytes field will be omitted from the resulting object.
  • project (string): Set the project field on the resulting object. When null, the project field will be omitted from the resulting object.
  • provisioned_iops (number): 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 When null, the provisioned_iops field will be omitted from the resulting object.
  • provisioned_throughput (number): 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 When null, the provisioned_throughput field will be omitted from the resulting object.
  • size (number): 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, Terraform 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. When null, the size field will be omitted from the resulting object.

  • snapshot (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:

  • 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot'

  • 'projects/project/global/snapshots/snapshot'

  • 'global/snapshots/snapshot'

  • 'snapshot' When null, the snapshot field will be omitted from the resulting object.

    • source_disk (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:

  • 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} When null, the source_disk field will be omitted from the resulting object.

    • type (string): URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. When null, the type field will be omitted from the resulting object.
    • zone (string): A reference to the zone where the disk resides. When null, the zone field will be omitted from the resulting object.
    • async_primary_disk (list[obj]): A nested object resource When null, the async_primary_disk sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.compute_disk.async_primary_disk.new constructor.
    • disk_encryption_key (list[obj]): 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. When null, the disk_encryption_key sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.compute_disk.disk_encryption_key.new constructor.

  • guest_os_features (list[obj]): A list of features to enable on the guest operating system. Applicable only for bootable disks. When null, the guest_os_features sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.compute_disk.guest_os_features.new constructor.
  • source_image_encryption_key (list[obj]): The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. When null, the source_image_encryption_key sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.compute_disk.source_image_encryption_key.new constructor.
  • source_snapshot_encryption_key (list[obj]): The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. When null, the source_snapshot_encryption_key sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.compute_disk.source_snapshot_encryption_key.new constructor.
  • timeouts (obj): Set the timeouts field on the resulting object. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.compute_disk.timeouts.new constructor.

Returns:

  • An attribute object that can be used with tf.withResource to construct a new compute_disk resource into the root Terraform configuration.

fn withAsyncPrimaryDisk

withAsyncPrimaryDisk()

google.list[obj].withAsyncPrimaryDisk constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the async_primary_disk field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the google.list[obj].withAsyncPrimaryDiskMixin function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the async_primary_disk field.

fn withAsyncPrimaryDiskMixin

withAsyncPrimaryDiskMixin()

google.list[obj].withAsyncPrimaryDiskMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the async_primary_disk field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the google.list[obj].withAsyncPrimaryDisk function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the async_primary_disk field.

fn withDescription

withDescription()

google.string.withDescription constructs a mixin object that can be merged into the string Terraform resource block to set or update the description field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the description field.

fn withDiskEncryptionKey

withDiskEncryptionKey()

google.list[obj].withDiskEncryptionKey constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the disk_encryption_key field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the google.list[obj].withDiskEncryptionKeyMixin function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the disk_encryption_key field.

fn withDiskEncryptionKeyMixin

withDiskEncryptionKeyMixin()

google.list[obj].withDiskEncryptionKeyMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the disk_encryption_key field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the google.list[obj].withDiskEncryptionKey function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the disk_encryption_key field.

fn withGuestOsFeatures

withGuestOsFeatures()

google.list[obj].withGuestOsFeatures constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the guest_os_features field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the google.list[obj].withGuestOsFeaturesMixin function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the guest_os_features field.

fn withGuestOsFeaturesMixin

withGuestOsFeaturesMixin()

google.list[obj].withGuestOsFeaturesMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the guest_os_features field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the google.list[obj].withGuestOsFeatures function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the guest_os_features field.

fn withImage

withImage()

google.string.withImage constructs a mixin object that can be merged into the string Terraform resource block to set or update the image field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the image field.

fn withLabels

withLabels()

google.obj.withLabels constructs a mixin object that can be merged into the obj Terraform resource block to set or update the labels field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (obj): The value to set for the labels field.

fn withLicenses

withLicenses()

google.list.withLicenses constructs a mixin object that can be merged into the list Terraform resource block to set or update the licenses field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list): The value to set for the licenses field.

fn withName

withName()

google.string.withName constructs a mixin object that can be merged into the string Terraform resource block to set or update the name field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the name field.

fn withPhysicalBlockSizeBytes

withPhysicalBlockSizeBytes()

google.number.withPhysicalBlockSizeBytes constructs a mixin object that can be merged into the number Terraform resource block to set or update the physical_block_size_bytes field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (number): The value to set for the physical_block_size_bytes field.

fn withProject

withProject()

google.string.withProject constructs a mixin object that can be merged into the string Terraform resource block to set or update the project field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the project field.

fn withProvisionedIops

withProvisionedIops()

google.number.withProvisionedIops constructs a mixin object that can be merged into the number Terraform resource block to set or update the provisioned_iops field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (number): The value to set for the provisioned_iops field.

fn withProvisionedThroughput

withProvisionedThroughput()

google.number.withProvisionedThroughput constructs a mixin object that can be merged into the number Terraform resource block to set or update the provisioned_throughput field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (number): The value to set for the provisioned_throughput field.

fn withSize

withSize()

google.number.withSize constructs a mixin object that can be merged into the number Terraform resource block to set or update the size field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (number): The value to set for the size field.

fn withSnapshot

withSnapshot()

google.string.withSnapshot constructs a mixin object that can be merged into the string Terraform resource block to set or update the snapshot field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the snapshot field.

fn withSourceDisk

withSourceDisk()

google.string.withSourceDisk constructs a mixin object that can be merged into the string Terraform resource block to set or update the source_disk field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the source_disk field.

fn withSourceImageEncryptionKey

withSourceImageEncryptionKey()

google.list[obj].withSourceImageEncryptionKey constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the source_image_encryption_key field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the google.list[obj].withSourceImageEncryptionKeyMixin function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the source_image_encryption_key field.

fn withSourceImageEncryptionKeyMixin

withSourceImageEncryptionKeyMixin()

google.list[obj].withSourceImageEncryptionKeyMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the source_image_encryption_key field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the google.list[obj].withSourceImageEncryptionKey function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the source_image_encryption_key field.

fn withSourceSnapshotEncryptionKey

withSourceSnapshotEncryptionKey()

google.list[obj].withSourceSnapshotEncryptionKey constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the source_snapshot_encryption_key field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the google.list[obj].withSourceSnapshotEncryptionKeyMixin function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the source_snapshot_encryption_key field.

fn withSourceSnapshotEncryptionKeyMixin

withSourceSnapshotEncryptionKeyMixin()

google.list[obj].withSourceSnapshotEncryptionKeyMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the source_snapshot_encryption_key field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the google.list[obj].withSourceSnapshotEncryptionKey function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the source_snapshot_encryption_key field.

fn withTimeouts

withTimeouts()

google.obj.withTimeouts constructs a mixin object that can be merged into the obj Terraform resource block to set or update the timeouts field.

This function will replace the map with the passed in value. If you wish to instead merge the passed in value to the existing map, use the google.obj.withTimeoutsMixin function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (obj): The value to set for the timeouts field.

fn withTimeoutsMixin

withTimeoutsMixin()

google.obj.withTimeoutsMixin constructs a mixin object that can be merged into the obj Terraform resource block to set or update the timeouts field.

This function will merge the passed in value to the existing map. If you wish to instead replace the entire map with the passed in value, use the google.obj.withTimeouts function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (obj): The value to set for the timeouts field.

fn withType

withType()

google.string.withType constructs a mixin object that can be merged into the string Terraform resource block to set or update the type field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the type field.

fn withZone

withZone()

google.string.withZone constructs a mixin object that can be merged into the string Terraform resource block to set or update the zone field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the zone field.

obj async_primary_disk

fn async_primary_disk.new

new()

google.compute_disk.async_primary_disk.new constructs a new object with attributes and blocks configured for the async_primary_disk Terraform sub block.

Args:

  • disk (string): Primary disk for asynchronous disk replication.

Returns:

  • An attribute object that represents the async_primary_disk sub block.

obj disk_encryption_key

fn disk_encryption_key.new

new()

google.compute_disk.disk_encryption_key.new constructs a new object with attributes and blocks configured for the disk_encryption_key Terraform sub block.

Args:

  • kms_key_self_link (string): The self link of the encryption key used to encrypt the disk. Also called KmsKeyName in the cloud console. Your project's Compute Engine System service account ('service-{{PROJECT_NUMBER}}@compute-system.iam.gserviceaccount.com') must have 'roles/cloudkms.cryptoKeyEncrypterDecrypter' to use this feature. See https://cloud.google.com/compute/docs/disks/customer-managed-encryption#encrypt_a_new_persistent_disk_with_your_own_keys When null, the kms_key_self_link field will be omitted from the resulting object.
  • kms_key_service_account (string): The service account used for the encryption request for the given KMS key. If absent, the Compute Engine Service Agent service account is used. When null, the kms_key_service_account field will be omitted from the resulting object.
  • raw_key (string): Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. When null, the raw_key field will be omitted from the resulting object.
  • rsa_encrypted_key (string): Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. When null, the rsa_encrypted_key field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the disk_encryption_key sub block.

obj guest_os_features

fn guest_os_features.new

new()

google.compute_disk.guest_os_features.new constructs a new object with attributes and blocks configured for the guest_os_features Terraform sub block.

Args:

  • type (string): The type of supported feature. Read Enabling guest operating system features to see a list of available options. Possible values: ["MULTI_IP_SUBNET", "SECURE_BOOT", "SEV_CAPABLE", "UEFI_COMPATIBLE", "VIRTIO_SCSI_MULTIQUEUE", "WINDOWS", "GVNIC", "SEV_LIVE_MIGRATABLE", "SEV_SNP_CAPABLE", "SUSPEND_RESUME_COMPATIBLE", "TDX_CAPABLE"]

Returns:

  • An attribute object that represents the guest_os_features sub block.

obj source_image_encryption_key

fn source_image_encryption_key.new

new()

google.compute_disk.source_image_encryption_key.new constructs a new object with attributes and blocks configured for the source_image_encryption_key Terraform sub block.

Args:

  • kms_key_self_link (string): The self link of the encryption key used to encrypt the disk. Also called KmsKeyName in the cloud console. Your project's Compute Engine System service account ('service-{{PROJECT_NUMBER}}@compute-system.iam.gserviceaccount.com') must have 'roles/cloudkms.cryptoKeyEncrypterDecrypter' to use this feature. See https://cloud.google.com/compute/docs/disks/customer-managed-encryption#encrypt_a_new_persistent_disk_with_your_own_keys When null, the kms_key_self_link field will be omitted from the resulting object.
  • kms_key_service_account (string): The service account used for the encryption request for the given KMS key. If absent, the Compute Engine Service Agent service account is used. When null, the kms_key_service_account field will be omitted from the resulting object.
  • raw_key (string): Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. When null, the raw_key field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the source_image_encryption_key sub block.

obj source_snapshot_encryption_key

fn source_snapshot_encryption_key.new

new()

google.compute_disk.source_snapshot_encryption_key.new constructs a new object with attributes and blocks configured for the source_snapshot_encryption_key Terraform sub block.

Args:

  • kms_key_self_link (string): The self link of the encryption key used to encrypt the disk. Also called KmsKeyName in the cloud console. Your project's Compute Engine System service account ('service-{{PROJECT_NUMBER}}@compute-system.iam.gserviceaccount.com') must have 'roles/cloudkms.cryptoKeyEncrypterDecrypter' to use this feature. See https://cloud.google.com/compute/docs/disks/customer-managed-encryption#encrypt_a_new_persistent_disk_with_your_own_keys When null, the kms_key_self_link field will be omitted from the resulting object.
  • kms_key_service_account (string): The service account used for the encryption request for the given KMS key. If absent, the Compute Engine Service Agent service account is used. When null, the kms_key_service_account field will be omitted from the resulting object.
  • raw_key (string): Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. When null, the raw_key field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the source_snapshot_encryption_key sub block.

obj timeouts

fn timeouts.new

new()

google.compute_disk.timeouts.new constructs a new object with attributes and blocks configured for the timeouts Terraform sub block.

Args:

  • create (string): Set the create field on the resulting object. When null, the create field will be omitted from the resulting object.
  • delete (string): Set the delete field on the resulting object. When null, the delete field will be omitted from the resulting object.
  • update (string): Set the update field on the resulting object. When null, the update field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the timeouts sub block.