Class: Google::Apis::ComputeV1::AttachedDiskInitializeParams
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::AttachedDiskInitializeParams
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/representations.rb more...
Overview
[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This field is persisted and returned for instanceTemplate and not returned in the context of instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.
Instance Attribute Summary collapse
-
#architecture ⇒ String
The architecture of the attached disk.
-
#description ⇒ String
An optional description.
-
#disk_name ⇒ String
Specifies the disk name.
-
#disk_size_gb ⇒ Fixnum
Specifies the size of the disk in base-2 GB.
-
#disk_type ⇒ String
Specifies the disk type to use to create the instance.
-
#enable_confidential_compute ⇒ Boolean
(also: #enable_confidential_compute?)
Whether this disk is using confidential compute mode.
-
#labels ⇒ Hash<String,String>
Labels to apply to this disk.
-
#licenses ⇒ Array<String>
A list of publicly visible licenses.
-
#on_update_action ⇒ String
Specifies which action to take on instance update with this disk.
-
#provisioned_iops ⇒ Fixnum
Indicates how many IOPS to provision for the disk.
-
#provisioned_throughput ⇒ Fixnum
Indicates how much throughput to provision for the disk.
-
#replica_zones ⇒ Array<String>
Required for each regional disk associated with the instance.
-
#resource_manager_tags ⇒ Hash<String,String>
Resource manager tags to be bound to the disk.
-
#resource_policies ⇒ Array<String>
Resource policies applied to this disk for automatic snapshot creations.
-
#source_image ⇒ String
The source image to create this disk.
-
#source_image_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey
The customer-supplied encryption key of the source image.
-
#source_snapshot ⇒ String
The source snapshot to create this disk.
-
#source_snapshot_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey
The customer-supplied encryption key of the source snapshot.
-
#storage_pool ⇒ String
The storage pool in which the new disk is created.
Instance Method Summary collapse
-
#initialize(**args) ⇒ AttachedDiskInitializeParams
constructor
A new instance of AttachedDiskInitializeParams.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ AttachedDiskInitializeParams
Returns a new instance of AttachedDiskInitializeParams.
1787 1788 1789 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1787 def initialize(**args) update!(**args) end |
Instance Attribute Details
#architecture ⇒ String
The architecture of the attached disk. Valid values are arm64 or x86_64.
Corresponds to the JSON property architecture
1641 1642 1643 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1641 def architecture @architecture end |
#description ⇒ String
An optional description. Provide this property when creating the disk.
Corresponds to the JSON property description
1646 1647 1648 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1646 def description @description end |
#disk_name ⇒ String
Specifies the disk name. If not specified, the default is to use the name of
the instance. If a disk with the same name already exists in the given region,
the existing disk is attached to the new instance and the new disk is not
created.
Corresponds to the JSON property diskName
1654 1655 1656 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1654 def disk_name @disk_name end |
#disk_size_gb ⇒ Fixnum
Specifies the size of the disk in base-2 GB. The size must be at least 10 GB.
If you specify a sourceImage, which is required for boot disks, the default
size is the size of the sourceImage. If you do not specify a sourceImage, the
default disk size is 500 GB.
Corresponds to the JSON property diskSizeGb
1662 1663 1664 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1662 def disk_size_gb @disk_size_gb end |
#disk_type ⇒ String
Specifies the disk type to use to create the instance. If not specified, the
default is pd-standard, specified using the full URL. For example: https://www.
googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard
For a full list of acceptable values, see Persistent disk types. If you
specify this field when creating a VM, you can provide either the full or
partial URL. For example, the following values are valid: - https://www.
googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType -
projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType
If you specify this field when creating or updating an instance template or
all-instances configuration, specify the type of the disk, not the URL. For
example: pd-standard.
Corresponds to the JSON property diskType
1677 1678 1679 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1677 def disk_type @disk_type end |
#enable_confidential_compute ⇒ Boolean Also known as: enable_confidential_compute?
Whether this disk is using confidential compute mode.
Corresponds to the JSON property enableConfidentialCompute
1682 1683 1684 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1682 def enable_confidential_compute @enable_confidential_compute end |
#labels ⇒ Hash<String,String>
Labels to apply to this disk. These can be later modified by the disks.
setLabels method. This field is only applicable for persistent disks.
Corresponds to the JSON property labels
1689 1690 1691 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1689 def labels @labels end |
#licenses ⇒ Array<String>
A list of publicly visible licenses. Reserved for Google's use.
Corresponds to the JSON property licenses
1694 1695 1696 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1694 def licenses @licenses end |
#on_update_action ⇒ String
Specifies which action to take on instance update with this disk. Default is
to use the existing disk.
Corresponds to the JSON property onUpdateAction
1700 1701 1702 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1700 def on_update_action @on_update_action end |
#provisioned_iops ⇒ Fixnum
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.
Corresponds to the JSON property provisionedIops
1707 1708 1709 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1707 def provisioned_iops @provisioned_iops end |
#provisioned_throughput ⇒ Fixnum
Indicates how much throughput to provision for the disk. This sets the number
of throughput mb per second that the disk can handle. Values must greater than
or equal to 1.
Corresponds to the JSON property provisionedThroughput
1714 1715 1716 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1714 def provisioned_throughput @provisioned_throughput end |
#replica_zones ⇒ Array<String>
Required for each regional disk associated with the instance. Specify the URLs
of the zones where the disk should be replicated to. You must provide exactly
two replica zones, and one zone must be the same as the instance zone.
Corresponds to the JSON property replicaZones
1721 1722 1723 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1721 def replica_zones @replica_zones end |
#resource_manager_tags ⇒ Hash<String,String>
Resource manager tags to be bound to the disk. 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.
Corresponds to the JSON property
resourceManagerTags`
1729 1730 1731 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1729 def @resource_manager_tags end |
#resource_policies ⇒ Array<String>
Resource policies applied to this disk for automatic snapshot creations.
Specified using the full or partial URL. For instance template, specify only
the resource policy name.
Corresponds to the JSON property resourcePolicies
1736 1737 1738 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1736 def resource_policies @resource_policies end |
#source_image ⇒ String
The source image to create this disk. When creating a new instance boot disk,
one of initializeParams.sourceImage or initializeParams.sourceSnapshot or
disks.source is required. 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 If the source image is deleted later,
this field will not be set.
Corresponds to the JSON property sourceImage
1753 1754 1755 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1753 def source_image @source_image end |
#source_image_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey
The customer-supplied encryption key of the source image. Required if the
source image is protected by a customer-supplied encryption key.
InstanceTemplate and InstancePropertiesPatch do not store customer-supplied
encryption keys, so you cannot create disks for instances in a managed
instance group if the source images are encrypted with your own keys.
Corresponds to the JSON property sourceImageEncryptionKey
1762 1763 1764 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1762 def source_image_encryption_key @source_image_encryption_key end |
#source_snapshot ⇒ String
The source snapshot to create this disk. When creating a new instance boot
disk, one of initializeParams.sourceSnapshot or initializeParams.sourceImage
or disks.source is required. To create a disk with a snapshot that you created,
specify the snapshot name in the following format: global/snapshots/my-backup
If the source snapshot is deleted later, this field will not be set.
Corresponds to the JSON property sourceSnapshot
1771 1772 1773 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1771 def source_snapshot @source_snapshot end |
#source_snapshot_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey
The customer-supplied encryption key of the source snapshot.
Corresponds to the JSON property sourceSnapshotEncryptionKey
1776 1777 1778 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1776 def source_snapshot_encryption_key @source_snapshot_encryption_key end |
#storage_pool ⇒ String
The storage pool in which the new disk is created. 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 /
storagePools/storagePool - projects/project/zones/zone/storagePools/
storagePool - zones/zone/storagePools/storagePool
Corresponds to the JSON property storagePool
1785 1786 1787 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1785 def storage_pool @storage_pool end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 |
# File 'lib/google/apis/compute_v1/classes.rb', line 1792 def update!(**args) @architecture = args[:architecture] if args.key?(:architecture) @description = args[:description] if args.key?(:description) @disk_name = args[:disk_name] if args.key?(:disk_name) @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb) @disk_type = args[:disk_type] if args.key?(:disk_type) @enable_confidential_compute = args[:enable_confidential_compute] if args.key?(:enable_confidential_compute) @labels = args[:labels] if args.key?(:labels) @licenses = args[:licenses] if args.key?(:licenses) @on_update_action = args[:on_update_action] if args.key?(:on_update_action) @provisioned_iops = args[:provisioned_iops] if args.key?(:provisioned_iops) @provisioned_throughput = args[:provisioned_throughput] if args.key?(:provisioned_throughput) @replica_zones = args[:replica_zones] if args.key?(:replica_zones) @resource_manager_tags = args[:resource_manager_tags] if args.key?(:resource_manager_tags) @resource_policies = args[:resource_policies] if args.key?(:resource_policies) @source_image = args[:source_image] if args.key?(:source_image) @source_image_encryption_key = args[:source_image_encryption_key] if args.key?(:source_image_encryption_key) @source_snapshot = args[:source_snapshot] if args.key?(:source_snapshot) @source_snapshot_encryption_key = args[:source_snapshot_encryption_key] if args.key?(:source_snapshot_encryption_key) @storage_pool = args[:storage_pool] if args.key?(:storage_pool) end |