disk#

State module for managing Disks.

async idem_gcp.states.gcp.compute.disk.present(hub, ctx, name: str, project: str = None, zone: str = None, region: str = None, resource_id: str = None, request_id: str = None, source_image: str = None, size_gb: str = None, source_snapshot: str = None, source_storage_object: str = None, options: str = None, type_: (<class 'str'>, 'alias=type') = None, licenses: ~typing.List[str] = None, guest_os_features: ~typing.List[~types.GuestOsFeature] = None, disk_encryption_key: ~types.CustomerEncryptionKey = None, source_image_encryption_key: ~types.CustomerEncryptionKey = None, source_snapshot_encryption_key: ~types.CustomerEncryptionKey = None, labels: ~typing.Dict[str, str] = None, label_fingerprint: str = None, replica_zones: ~typing.List[str] = None, license_codes: ~typing.List[str] = None, physical_block_size_bytes: str = None, resource_policies: ~typing.List[str] = None, source_disk: str = None, provisioned_iops: str = None, location_hint: str = None, architecture: str = None, params: ~types.DiskParams = None, description: str = None, id_: (dict_tools.typing.Computed.<class 'str'>, 'alias=id') = None) → Dict[str, Any][source]#

Creates or updates 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.

Parameters:

name (str) – An Idem name of the resource.
zone (str, Optional) – The name of the zone for this request.
region (str, Optional) – The name of the region for this request.
project (str, Optional) – Project ID for this request.
resource_id (str, Optional) – An identifier of the resource in the provider. Defaults to None.
request_id (str, Optional) – An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). Defaults to None.
source_image (str, Optional) – 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 . Defaults to None.
size_gb (str, Optional) – 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. Defaults to None.
source_snapshot (str, Optional) –
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
Defaults to None.
source_storage_object (str, Optional) – 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. Defaults to None.
options (str, Optional) – Internal use only. Defaults to None.
type (str, Optional) – 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-ssd. See Persistent disk types. Defaults to None.
licenses (List[str], Optional) – A list of publicly visible licenses. Reserved for Google’s use. Defaults to None.
guest_os_features (List[Dict[str, Any]], Optional) –
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. Defaults to None.
- type(str, Optional):
  The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_SNP_CAPABLE
  
  For more information, see Enabling guest operating system features.
disk_encryption_key (Dict[str, Any], Optional) –
Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format:

”diskEncryptionKey.kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version”

If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don’t need to provide a key to use the disk later. Defaults to None.
- raw_key(str, Optional):
  Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example:
  
  "raw_key": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
- rsa_encrypted_key(str, Optional):
  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. For example:
  
  "rsa_encrypted_key": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/ NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEM MoNUXMCZEIpg9Vtp9x2oe=="
  
  The key must meet the following requirements before you can provide it to Compute Engine:
  1. The key is wrapped using a RSA public key certificate provided by Google.
  2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
  Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
- kms_key_name(str, Optional):
  The name of the encryption key that is stored in Google Cloud KMS. For example:
  
  "kms_key_name": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key
- kms_key_service_account(str, Optional):
  The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example:
  
  "kms_key_service_account": "name@project_id.iam.gserviceaccount.com/
source_image_encryption_key (Dict[str, Any], Optional) –
The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Defaults to None.
- raw_key(str, Optional):
  Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: “rawKey”: “SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=”
- rsa_encrypted_key(str, Optional):
  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. For example: “rsaEncryptedKey”: “ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==” The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
- kms_key_name(str, Optional):
  The name of the encryption key that is stored in Google Cloud KMS. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key
- kms_key_service_account(str, Optional):
  The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: “kmsKeyServiceAccount”: “name@project_id.iam.gserviceaccount.com/
source_snapshot_encryption_key (Dict[str, Any], Optional) –
The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. Defaults to None.
- raw_key(str, Optional):
  Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: “rawKey”: “SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=”
- rsa_encrypted_key(str, Optional):
  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. For example: “rsaEncryptedKey”: “ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==” The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
- kms_key_name(str, Optional):
  The name of the encryption key that is stored in Google Cloud KMS. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key
- kms_key_service_account(str, Optional):
  The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: “kmsKeyServiceAccount”: “name@project_id.iam.gserviceaccount.com/
labels (Dict[str, Dict[str, str]], Optional) – Labels to apply to this disk. These can be later modified by the setLabels method. Defaults to None.
label_fingerprint (str, Optional) – 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. Defaults to None.
replica_zones (List[str], Optional) – URLs of the zones where the disk should be replicated to. Only applicable for regional resources. Defaults to None.
license_codes (List[str], Optional) – Integer license codes indicating which licenses are attached to this disk. Defaults to None.
physical_block_size_bytes (str, Optional) – 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. Defaults to None.
resource_policies (List[str], Optional) – Resource policies applied to this disk for automatic snapshot creations. To remove a policy set resource_policies to be an empty array e.g. [] Defaults to None.
source_disk (str, Optional) –
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
Defaults to None.
provisioned_iops (str, Optional) – 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. Defaults to None.
location_hint (str, Optional) – 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. Defaults to None.
architecture (str, Optional) – The architecture of the disk. Valid values are ARM64 or X86_64. Defaults to None.
params (Dict[str, Dict[str, str]], Optional) –
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. Defaults to None.
- resource_manager_tags(Dict[str, str], Optional):
  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.
description (str, Optional) – An optional description of this resource. Defaults to None.
id (str, Optional) – The unique identifier for the resource. This identifier is defined by the server. Read-only property

Returns:

Dict[str, Any]

Examples

example_resource_name:
  gcp.compute.disk.present:
    - project: project-name
    - zone: us-central1-a
    - description: Description for example_resource_name
    - type: projects/project-name/zones/us-central1-a/diskTypes/pd-balanced
    - size_gb: 10
    - resource_policies:
        - projects/project-name/regions/us-central1/resourcePolicies/default-schedule-1

async idem_gcp.states.gcp.compute.disk.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describe the resource in a way that can be recreated/managed with the corresponding “present” function.

Retrieves a list of persistent disks contained within the specified zone.

Returns:: Dict[str, Any]

Examples

$ idem describe gcp.compute.disk

idem_gcp.states.gcp.compute.disk.is_pending(hub, ret: dict, state: str = None, **pending_kwargs) → bool[source]#: Default implemented for each module.