Cloud.AWS.Volume

Cloud.AWS.Volume
Cloud.AWS.Volume

Request schema for provisioning of AWS Storage

JSON Example
{
    "account": "string",
    "capacityGb": 0,
    "constraints": [
        {
            "tag": "string"
        }
    ],
    "count": 0,
    "encrypted": false,
    "iops": 0,
    "maxDiskCapacityInGB": 0,
    "name": "string",
    "persistent": false,
    "providerId": "string",
    "region": "string",
    "resourceName": "string",
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "volumeType": "string",
    "zone": "string"
}
string
account
Optional

Cloud Account indicates the name of the endpoint used to provision this machine.

integer
capacityGb
Required

Disk size in gigabytes.

array of object
constraints
Optional

To create the correct storage at provisioning time, blueprint constraints are matched against infrastructure capability tags. Constraints must include the key name. Options include value, negative [!], and hard or soft requirement.

integer
count
Optional

The number of resource instances to be created.

boolean
encrypted
Optional

Whether or not the disk is encrypted.

integer
iops
Optional

The amount of IOPS to provision for the disk. Required for volumeType io1, io2 and gp3. Default value for gp3 is 3000 IOPS.

integer
maxDiskCapacityInGB
Optional

Maximum disk size allowed for create or resize disk operation

string
name
Optional

Name of the Disk

boolean
persistent
Optional

Indicates that the disk will survive machine or deployment deletion

string
providerId
Optional

A unique identifier of the resource in the context of the provider.

string
region
Optional

Region name where the disk landed.

string
resourceName
Optional

The actual name of the disk determined after the allocation.

array of object
tags
Optional

Tags

string
volumeType
Optional

EBS volume type of standard, gp2, gp3, io1, io2, sc1, or st1.

Possible values are : gp3, io2, gp2, io1, sc1, st1, standard,
string
zone
Optional

Availability zone where the volume landed.