Package com.hashicorp.cdktf.providers.google.compute_instance_template

Interface ComputeInstanceTemplateDisk

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    ComputeInstanceTemplateDisk.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:18.551Z")
@Stability(Stable)
public interface ComputeInstanceTemplateDisk
extends software.amazon.jsii.JsiiSerializable

    • Method Detail

      • getAutoDelete

        @Stability(Stable)
@Nullable
default Object getAutoDelete()
        Whether or not the disk should be auto-deleted. This defaults to true.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#auto_delete ComputeInstanceTemplate#auto_delete}

      • getBoot

        @Stability(Stable)
@Nullable
default Object getBoot()
        Indicates that this is a boot disk.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#boot ComputeInstanceTemplate#boot}

      • getDeviceName

        @Stability(Stable)
@Nullable
default String getDeviceName()
        A unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance.

        If not specified, the server chooses a default device name to apply to this disk. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#device_name ComputeInstanceTemplate#device_name}

      • getDiskEncryptionKey

        @Stability(Stable)
@Nullable
default ComputeInstanceTemplateDiskDiskEncryptionKey getDiskEncryptionKey()
        disk_encryption_key block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#disk_encryption_key ComputeInstanceTemplate#disk_encryption_key}

      • getDiskName

        @Stability(Stable)
@Nullable
default String getDiskName()
        Name of the disk. When not provided, this defaults to the name of the instance.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#disk_name ComputeInstanceTemplate#disk_name}

      • getDiskSizeGb

        @Stability(Stable)
@Nullable
default Number getDiskSizeGb()
        The size of the image in gigabytes.

        If not specified, it will inherit the size of its base image. For SCRATCH disks, the size must be one of 375 or 3000 GB, with a default of 375 GB. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#disk_size_gb ComputeInstanceTemplate#disk_size_gb}

      • getDiskType

        @Stability(Stable)
@Nullable
default String getDiskType()
        The Google Compute Engine disk type. Such as "pd-ssd", "local-ssd", "pd-balanced" or "pd-standard".

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#disk_type ComputeInstanceTemplate#disk_type}

      • getInterfaceValue

        @Stability(Stable)
@Nullable
default String getInterfaceValue()
        Specifies the disk interface to use for attaching this disk.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#interface ComputeInstanceTemplate#interface}

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        A set of key/value label pairs to assign to disks,.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#labels ComputeInstanceTemplate#labels}

      • getMode

        @Stability(Stable)
@Nullable
default String getMode()
        The mode in which to attach this disk, either READ_WRITE or READ_ONLY.

        If you are attaching or creating a boot disk, this must read-write mode. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#mode ComputeInstanceTemplate#mode}

      • getProvisionedIops

        @Stability(Stable)
@Nullable
default Number getProvisionedIops()
        Indicates how many IOPS to provision for the disk.

        This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the [Extreme persistent disk documentation](https://cloud.google.com/compute/docs/disks/extreme-persistent-disk). Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#provisioned_iops ComputeInstanceTemplate#provisioned_iops}

      • getResourceManagerTags

        @Stability(Stable)
@Nullable
default Map<String,​String> getResourceManagerTags()
        A map of resource manager tags.

        Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#resource_manager_tags ComputeInstanceTemplate#resource_manager_tags}

      • getResourcePolicies

        @Stability(Stable)
@Nullable
default List<String> getResourcePolicies()
        A list (short name or id) of resource policies to attach to this disk.

        Currently a max of 1 resource policy is supported. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#resource_policies ComputeInstanceTemplate#resource_policies}

      • getSource

        @Stability(Stable)
@Nullable
default String getSource()
        The name (not self_link) of the disk (such as those managed by google_compute_disk) to attach.

        ~> Note: Either source or source_image is required when creating a new instance except for when creating a local SSD. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#source ComputeInstanceTemplate#source}

      • getSourceImage

        @Stability(Stable)
@Nullable
default String getSourceImage()
        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}. ~> Note: Either source or source_image is required when creating a new instance except for when creating a local SSD. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#source_image ComputeInstanceTemplate#source_image}

      • getSourceImageEncryptionKey

        @Stability(Stable)
@Nullable
default ComputeInstanceTemplateDiskSourceImageEncryptionKey getSourceImageEncryptionKey()
        source_image_encryption_key block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#source_image_encryption_key ComputeInstanceTemplate#source_image_encryption_key}

      • getSourceSnapshot

        @Stability(Stable)
@Nullable
default String getSourceSnapshot()
        The source snapshot to create this disk.

        When creating a new instance, one of initializeParams.sourceSnapshot, initializeParams.sourceImage, or disks.source is required except for local SSD. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#source_snapshot ComputeInstanceTemplate#source_snapshot}

      • getSourceSnapshotEncryptionKey

        @Stability(Stable)
@Nullable
default ComputeInstanceTemplateDiskSourceSnapshotEncryptionKey getSourceSnapshotEncryptionKey()
        source_snapshot_encryption_key block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#source_snapshot_encryption_key ComputeInstanceTemplate#source_snapshot_encryption_key}

      • getType

        @Stability(Stable)
@Nullable
default String getType()
        The type of Google Compute Engine disk, can be either "SCRATCH" or "PERSISTENT".

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_instance_template#type ComputeInstanceTemplate#type}