CreateVolume - Amazon FSx

CreateVolume

Creates an Amazon FSx for NetApp ONTAP storage volume.

Request Syntax

{ "ClientRequestToken": "string", "Name": "string", "OntapConfiguration": { "JunctionPath": "string", "SecurityStyle": "string", "SizeInMegabytes": number, "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "TieringPolicy": { "CoolingPeriod": number, "Name": "string" } }, "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeType": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClientRequestToken

(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [A-za-z0-9_.-]{0,63}$

Required: No

Name

Specifies the name of the volume you're creating.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 203.

Pattern: ^[^\u0000\u0085\u2028\u2029\r\n]{1,203}$

Required: Yes

OntapConfiguration

Specifies the ONTAP configuration to use in creating the volume.

Type: CreateOntapVolumeConfiguration object

Required: No

Tags

A list of Tag values, with a maximum of 50 elements.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

VolumeType

Specifies the type of volume to create; ONTAP is the only valid volume type.

Type: String

Valid Values: ONTAP

Required: Yes

Response Syntax

{ "Volume": { "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInMegabytes": number, "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Volume

Returned after a successful CreateVolume API operation, describing the volume just created.

Type: Volume object

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequest

A generic error indicating a failure with a client request.

HTTP Status Code: 400

FileSystemNotFound

No Amazon FSx file systems were found based upon supplied parameters.

HTTP Status Code: 400

IncompatibleParameterError

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

HTTP Status Code: 400

InternalServerError

A generic error indicating a server-side failure.

HTTP Status Code: 500

MissingVolumeConfiguration

A volume configuration is required for this operation.

HTTP Status Code: 400

ServiceLimitExceeded

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.

HTTP Status Code: 400

StorageVirtualMachineNotFound

No Amazon FSx for NetApp ONTAP SVMs were found based upon the supplied parameters.

HTTP Status Code: 400

UnsupportedOperation

The requested operation is not supported for this resource or API.

HTTP Status Code: 400

Examples

Create an ONTAP storage volume

The following example creates a 100 GB storage volume with storage efficiency enabled, and a storage tiering configuration with a 60 day cooling period with tiering of snapshots only.

{ "Name": "finance-volume1" "OntapConfiguration": { "JunctionPath": "/finance/vol1", "SizeInMegabytes": 102400, "StorageEfficiencyEnabled": true, "StorageVirtualMachineId": "svm-0123456789abcdef0", "TieringPolicy": { "CoolingPeriod": 60, "Name": "SNAPSHOT_ONLY" } }, "VolumeType": "ONTAP" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: