Parameter |
Choices/Defaults |
Comments |
auth_kind
string
/ required
|
Choices:
- application
- machineaccount
- serviceaccount
|
The type of credential used.
|
description
string
|
|
An optional description of this resource. Provide this property when you create the resource.
|
disk_encryption_key
dictionary
|
|
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.
|
|
kms_key_name
string
|
|
The name of the encryption key that is stored in Google Cloud KMS.
|
|
raw_key
string
|
|
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
|
env_type
string
|
|
Specifies which Ansible environment you're running this module within.
This should not be set unless you know what you're doing.
This only alters the User Agent string for any API requests.
|
labels
dictionary
added in 2.7 |
|
Labels to apply to this disk. A list of key->value pairs.
|
licenses
list
|
|
Any applicable publicly visible licenses.
|
name
string
/ required
|
|
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.
|
physical_block_size_bytes
integer
added in 2.8 |
|
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.
|
project
string
|
|
The Google Cloud Platform project to use.
|
scopes
list
|
|
Array of scopes to be used.
|
service_account_contents
jsonarg
|
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
|
service_account_email
string
|
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
|
service_account_file
path
|
|
The path of a Service Account JSON file if serviceaccount is selected as type.
|
size_gb
integer
|
|
Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
|
source_image
string
|
|
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-8 to use the latest Debian 8 image: projects/debian-cloud/global/images/family/debian-8 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD To create a disk with a private image that you created, specify the image name in the following format: global/images/my-private-image You can also specify a private 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-private-family .
|
source_image_encryption_key
dictionary
|
|
The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
|
|
kms_key_name
string
|
|
The name of the encryption key that is stored in Google Cloud KMS.
|
|
raw_key
string
|
|
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
|
source_snapshot
dictionary
|
|
The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource.
This field represents a link to a Snapshot resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_snapshot task and then set this source_snapshot field to "{{ name-of-resource }}"
|
source_snapshot_encryption_key
dictionary
|
|
The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
|
|
kms_key_name
string
|
|
The name of the encryption key that is stored in Google Cloud KMS.
|
|
raw_key
string
|
|
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
|
state
string
|
Choices:
present ←
- absent
|
Whether the given object should exist in GCP
|
type
string
added in 2.7 |
|
URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
|
zone
string
/ required
|
|
A reference to the zone where the disk resides.
|