CreateVolume
Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.
Request Syntax
{
"ClientRequestToken": "string",
"Name": "string",
"OntapConfiguration": {
"AggregateConfiguration": {
"Aggregates": [ "string" ],
"ConstituentsPerAggregate": number
},
"CopyTagsToBackups": boolean,
"JunctionPath": "string",
"OntapVolumeType": "string",
"SecurityStyle": "string",
"SizeInBytes": number,
"SizeInMegabytes": number,
"SnaplockConfiguration": {
"AuditLogVolume": boolean,
"AutocommitPeriod": {
"Type": "string",
"Value": number
},
"PrivilegedDelete": "string",
"RetentionPeriod": {
"DefaultRetention": {
"Type": "string",
"Value": number
},
"MaximumRetention": {
"Type": "string",
"Value": number
},
"MinimumRetention": {
"Type": "string",
"Value": number
}
},
"SnaplockType": "string",
"VolumeAppendModeEnabled": boolean
},
"SnapshotPolicy": "string",
"StorageEfficiencyEnabled": boolean,
"StorageVirtualMachineId": "string",
"TieringPolicy": {
"CoolingPeriod": number,
"Name": "string"
},
"VolumeStyle": "string"
},
"OpenZFSConfiguration": {
"CopyTagsToSnapshots": boolean,
"DataCompressionType": "string",
"NfsExports": [
{
"ClientConfigurations": [
{
"Clients": "string",
"Options": [ "string" ]
}
]
}
],
"OriginSnapshot": {
"CopyStrategy": "string",
"SnapshotARN": "string"
},
"ParentVolumeId": "string",
"ReadOnly": boolean,
"RecordSizeKiB": number,
"StorageCapacityQuotaGiB": number,
"StorageCapacityReservationGiB": number,
"UserAndGroupQuotas": [
{
"Id": number,
"StorageCapacityQuotaGiB": number,
"Type": "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 63 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 that 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 configuration to use when creating the ONTAP volume.
Type: CreateOntapVolumeConfiguration object
Required: No
- OpenZFSConfiguration
-
Specifies the configuration to use when creating the OpenZFS volume.
Type: CreateOpenZFSVolumeConfiguration object
Required: No
- Tags
-
A list of
Tagvalues, 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;
ONTAPandOPENZFSare the only valid volume types.Type: String
Valid Values:
ONTAP | OPENZFSRequired: Yes
Response Syntax
{
"Volume": {
"AdministrativeActions": [
{
"AdministrativeActionType": "string",
"FailureDetails": {
"Message": "string"
},
"ProgressPercent": number,
"RemainingTransferBytes": number,
"RequestTime": number,
"Status": "string",
"TargetFileSystemValues": {
"AdministrativeActions": [
"AdministrativeAction"
],
"CreationTime": number,
"DNSName": "string",
"FailureDetails": {
"Message": "string"
},
"FileSystemId": "string",
"FileSystemType": "string",
"FileSystemTypeVersion": "string",
"KmsKeyId": "string",
"Lifecycle": "string",
"LustreConfiguration": {
"AutomaticBackupRetentionDays": number,
"CopyTagsToBackups": boolean,
"DailyAutomaticBackupStartTime": "string",
"DataCompressionType": "string",
"DataRepositoryConfiguration": {
"AutoImportPolicy": "string",
"ExportPath": "string",
"FailureDetails": {
"Message": "string"
},
"ImportedFileChunkSize": number,
"ImportPath": "string",
"Lifecycle": "string"
},
"DeploymentType": "string",
"DriveCacheType": "string",
"EfaEnabled": boolean,
"LogConfiguration": {
"Destination": "string",
"Level": "string"
},
"MetadataConfiguration": {
"Iops": number,
"Mode": "string"
},
"MountName": "string",
"PerUnitStorageThroughput": number,
"RootSquashConfiguration": {
"NoSquashNids": [ "string" ],
"RootSquash": "string"
},
"WeeklyMaintenanceStartTime": "string"
},
"NetworkInterfaceIds": [ "string" ],
"OntapConfiguration": {
"AutomaticBackupRetentionDays": number,
"DailyAutomaticBackupStartTime": "string",
"DeploymentType": "string",
"DiskIopsConfiguration": {
"Iops": number,
"Mode": "string"
},
"EndpointIpAddressRange": "string",
"Endpoints": {
"Intercluster": {
"DNSName": "string",
"IpAddresses": [ "string" ]
},
"Management": {
"DNSName": "string",
"IpAddresses": [ "string" ]
}
},
"FsxAdminPassword": "string",
"HAPairs": number,
"PreferredSubnetId": "string",
"RouteTableIds": [ "string" ],
"ThroughputCapacity": number,
"ThroughputCapacityPerHAPair": number,
"WeeklyMaintenanceStartTime": "string"
},
"OpenZFSConfiguration": {
"AutomaticBackupRetentionDays": number,
"CopyTagsToBackups": boolean,
"CopyTagsToVolumes": boolean,
"DailyAutomaticBackupStartTime": "string",
"DeploymentType": "string",
"DiskIopsConfiguration": {
"Iops": number,
"Mode": "string"
},
"EndpointIpAddress": "string",
"EndpointIpAddressRange": "string",
"PreferredSubnetId": "string",
"ReadCacheConfiguration": {
"SizeGiB": number,
"SizingMode": "string"
},
"RootVolumeId": "string",
"RouteTableIds": [ "string" ],
"ThroughputCapacity": number,
"WeeklyMaintenanceStartTime": "string"
},
"OwnerId": "string",
"ResourceARN": "string",
"StorageCapacity": number,
"StorageType": "string",
"SubnetIds": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VpcId": "string",
"WindowsConfiguration": {
"ActiveDirectoryId": "string",
"Aliases": [
{
"Lifecycle": "string",
"Name": "string"
}
],
"AuditLogConfiguration": {
"AuditLogDestination": "string",
"FileAccessAuditLogLevel": "string",
"FileShareAccessAuditLogLevel": "string"
},
"AutomaticBackupRetentionDays": number,
"CopyTagsToBackups": boolean,
"DailyAutomaticBackupStartTime": "string",
"DeploymentType": "string",
"DiskIopsConfiguration": {
"Iops": number,
"Mode": "string"
},
"MaintenanceOperationsInProgress": [ "string" ],
"PreferredFileServerIp": "string",
"PreferredSubnetId": "string",
"RemoteAdministrationEndpoint": "string",
"SelfManagedActiveDirectoryConfiguration": {
"DnsIps": [ "string" ],
"DomainName": "string",
"FileSystemAdministratorsGroup": "string",
"OrganizationalUnitDistinguishedName": "string",
"UserName": "string"
},
"ThroughputCapacity": number,
"WeeklyMaintenanceStartTime": "string"
}
},
"TargetSnapshotValues": {
"AdministrativeActions": [
"AdministrativeAction"
],
"CreationTime": number,
"Lifecycle": "string",
"LifecycleTransitionReason": {
"Message": "string"
},
"Name": "string",
"ResourceARN": "string",
"SnapshotId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VolumeId": "string"
},
"TargetVolumeValues": "Volume",
"TotalTransferBytes": number
}
],
"CreationTime": number,
"FileSystemId": "string",
"Lifecycle": "string",
"LifecycleTransitionReason": {
"Message": "string"
},
"Name": "string",
"OntapConfiguration": {
"AggregateConfiguration": {
"Aggregates": [ "string" ],
"TotalConstituents": number
},
"CopyTagsToBackups": boolean,
"FlexCacheEndpointType": "string",
"JunctionPath": "string",
"OntapVolumeType": "string",
"SecurityStyle": "string",
"SizeInBytes": number,
"SizeInMegabytes": number,
"SnaplockConfiguration": {
"AuditLogVolume": boolean,
"AutocommitPeriod": {
"Type": "string",
"Value": number
},
"PrivilegedDelete": "string",
"RetentionPeriod": {
"DefaultRetention": {
"Type": "string",
"Value": number
},
"MaximumRetention": {
"Type": "string",
"Value": number
},
"MinimumRetention": {
"Type": "string",
"Value": number
}
},
"SnaplockType": "string",
"VolumeAppendModeEnabled": boolean
},
"SnapshotPolicy": "string",
"StorageEfficiencyEnabled": boolean,
"StorageVirtualMachineId": "string",
"StorageVirtualMachineRoot": boolean,
"TieringPolicy": {
"CoolingPeriod": number,
"Name": "string"
},
"UUID": "string",
"VolumeStyle": "string"
},
"OpenZFSConfiguration": {
"CopyStrategy": "string",
"CopyTagsToSnapshots": boolean,
"DataCompressionType": "string",
"DeleteClonedVolumes": boolean,
"DeleteIntermediateData": boolean,
"DeleteIntermediateSnaphots": boolean,
"DestinationSnapshot": "string",
"NfsExports": [
{
"ClientConfigurations": [
{
"Clients": "string",
"Options": [ "string" ]
}
]
}
],
"OriginSnapshot": {
"CopyStrategy": "string",
"SnapshotARN": "string"
},
"ParentVolumeId": "string",
"ReadOnly": boolean,
"RecordSizeKiB": number,
"RestoreToSnapshot": "string",
"SourceSnapshotARN": "string",
"StorageCapacityQuotaGiB": number,
"StorageCapacityReservationGiB": number,
"UserAndGroupQuotas": [
{
"Id": number,
"StorageCapacityQuotaGiB": number,
"Type": "string"
}
],
"VolumePath": "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.
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 FSx for 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 FSx for 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"
}Create an Amazon FSx for OpenZFS 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": "sales-vol1"
"OpenZFSConfiguration": {
"CopyTagsToSnapshots": true,
"DataCompressionType": "LZ4",
"NfsExports": [
{
"ClientConfigurations": [
{
"Clients": "*",
"Options": [ "rw","root_squash","crossmnt" ]
}
]
}
],
"OriginSnapshot": {
"CopyStrategy": "CLONE",
"SnapshotARN": "arn:aws:fsx:us-east-2:111122223333:snapshot/fsvol-0123456789abcdef0/fsvolsnap-1234567890abcdef0"
},
"ParentVolumeId": "fsvol-abcdef01234567890",
"ReadOnly": false,
"RecordSizeKiB": 1024,
"StorageCapacityQuotaGiB": 10000,
"StorageCapacityReservationGiB": -1,
"UserAndGroupQuotas": [
{
"Id": 1004,
"StorageCapacityQuotaGiB": 2000,
"Type": "GROUP"
}
]
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
