CreateVolumeCommand

Suggest an Edit

Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { FSxClient, CreateVolumeCommand } from "@aws-sdk/client-fsx"; // ES Modules import
// const { FSxClient, CreateVolumeCommand } = require("@aws-sdk/client-fsx"); // CommonJS import
const client = new FSxClient(config);
const input = { // CreateVolumeRequest
  ClientRequestToken: "STRING_VALUE",
  VolumeType: "ONTAP" || "OPENZFS", // required
  Name: "STRING_VALUE", // required
  OntapConfiguration: { // CreateOntapVolumeConfiguration
    JunctionPath: "STRING_VALUE",
    SecurityStyle: "UNIX" || "NTFS" || "MIXED",
    SizeInMegabytes: Number("int"),
    StorageEfficiencyEnabled: true || false,
    StorageVirtualMachineId: "STRING_VALUE", // required
    TieringPolicy: { // TieringPolicy
      CoolingPeriod: Number("int"),
      Name: "SNAPSHOT_ONLY" || "AUTO" || "ALL" || "NONE",
    },
    OntapVolumeType: "RW" || "DP",
    SnapshotPolicy: "STRING_VALUE",
    CopyTagsToBackups: true || false,
    SnaplockConfiguration: { // CreateSnaplockConfiguration
      AuditLogVolume: true || false,
      AutocommitPeriod: { // AutocommitPeriod
        Type: "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "NONE", // required
        Value: Number("int"),
      },
      PrivilegedDelete: "DISABLED" || "ENABLED" || "PERMANENTLY_DISABLED",
      RetentionPeriod: { // SnaplockRetentionPeriod
        DefaultRetention: { // RetentionPeriod
          Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required
          Value: Number("int"),
        },
        MinimumRetention: {
          Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required
          Value: Number("int"),
        },
        MaximumRetention: {
          Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required
          Value: Number("int"),
        },
      },
      SnaplockType: "COMPLIANCE" || "ENTERPRISE", // required
      VolumeAppendModeEnabled: true || false,
    },
    VolumeStyle: "FLEXVOL" || "FLEXGROUP",
    AggregateConfiguration: { // CreateAggregateConfiguration
      Aggregates: [ // Aggregates
        "STRING_VALUE",
      ],
      ConstituentsPerAggregate: Number("int"),
    },
    SizeInBytes: Number("long"),
  },
  Tags: [ // Tags
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
  OpenZFSConfiguration: { // CreateOpenZFSVolumeConfiguration
    ParentVolumeId: "STRING_VALUE", // required
    StorageCapacityReservationGiB: Number("int"),
    StorageCapacityQuotaGiB: Number("int"),
    RecordSizeKiB: Number("int"),
    DataCompressionType: "NONE" || "ZSTD" || "LZ4",
    CopyTagsToSnapshots: true || false,
    OriginSnapshot: { // CreateOpenZFSOriginSnapshotConfiguration
      SnapshotARN: "STRING_VALUE", // required
      CopyStrategy: "CLONE" || "FULL_COPY" || "INCREMENTAL_COPY", // required
    },
    ReadOnly: true || false,
    NfsExports: [ // OpenZFSNfsExports
      { // OpenZFSNfsExport
        ClientConfigurations: [ // OpenZFSClientConfigurations // required
          { // OpenZFSClientConfiguration
            Clients: "STRING_VALUE", // required
            Options: [ // OpenZFSNfsExportOptions // required
              "STRING_VALUE",
            ],
          },
        ],
      },
    ],
    UserAndGroupQuotas: [ // OpenZFSUserAndGroupQuotas
      { // OpenZFSUserOrGroupQuota
        Type: "USER" || "GROUP", // required
        Id: Number("int"), // required
        StorageCapacityQuotaGiB: Number("int"), // required
      },
    ],
  },
};
const command = new CreateVolumeCommand(input);
const response = await client.send(command);
// { // CreateVolumeResponse
//   Volume: { // Volume
//     CreationTime: new Date("TIMESTAMP"),
//     FileSystemId: "STRING_VALUE",
//     Lifecycle: "CREATING" || "CREATED" || "DELETING" || "FAILED" || "MISCONFIGURED" || "PENDING" || "AVAILABLE",
//     Name: "STRING_VALUE",
//     OntapConfiguration: { // OntapVolumeConfiguration
//       FlexCacheEndpointType: "NONE" || "ORIGIN" || "CACHE",
//       JunctionPath: "STRING_VALUE",
//       SecurityStyle: "UNIX" || "NTFS" || "MIXED",
//       SizeInMegabytes: Number("int"),
//       StorageEfficiencyEnabled: true || false,
//       StorageVirtualMachineId: "STRING_VALUE",
//       StorageVirtualMachineRoot: true || false,
//       TieringPolicy: { // TieringPolicy
//         CoolingPeriod: Number("int"),
//         Name: "SNAPSHOT_ONLY" || "AUTO" || "ALL" || "NONE",
//       },
//       UUID: "STRING_VALUE",
//       OntapVolumeType: "RW" || "DP" || "LS",
//       SnapshotPolicy: "STRING_VALUE",
//       CopyTagsToBackups: true || false,
//       SnaplockConfiguration: { // SnaplockConfiguration
//         AuditLogVolume: true || false,
//         AutocommitPeriod: { // AutocommitPeriod
//           Type: "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "NONE", // required
//           Value: Number("int"),
//         },
//         PrivilegedDelete: "DISABLED" || "ENABLED" || "PERMANENTLY_DISABLED",
//         RetentionPeriod: { // SnaplockRetentionPeriod
//           DefaultRetention: { // RetentionPeriod
//             Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required
//             Value: Number("int"),
//           },
//           MinimumRetention: {
//             Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required
//             Value: Number("int"),
//           },
//           MaximumRetention: {
//             Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required
//             Value: Number("int"),
//           },
//         },
//         SnaplockType: "COMPLIANCE" || "ENTERPRISE",
//         VolumeAppendModeEnabled: true || false,
//       },
//       VolumeStyle: "FLEXVOL" || "FLEXGROUP",
//       AggregateConfiguration: { // AggregateConfiguration
//         Aggregates: [ // Aggregates
//           "STRING_VALUE",
//         ],
//         TotalConstituents: Number("int"),
//       },
//       SizeInBytes: Number("long"),
//     },
//     ResourceARN: "STRING_VALUE",
//     Tags: [ // Tags
//       { // Tag
//         Key: "STRING_VALUE", // required
//         Value: "STRING_VALUE", // required
//       },
//     ],
//     VolumeId: "STRING_VALUE",
//     VolumeType: "ONTAP" || "OPENZFS",
//     LifecycleTransitionReason: { // LifecycleTransitionReason
//       Message: "STRING_VALUE",
//     },
//     AdministrativeActions: [ // AdministrativeActions
//       { // AdministrativeAction
//         AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE" || "THROUGHPUT_OPTIMIZATION" || "IOPS_OPTIMIZATION" || "STORAGE_TYPE_OPTIMIZATION" || "MISCONFIGURED_STATE_RECOVERY" || "VOLUME_UPDATE_WITH_SNAPSHOT" || "VOLUME_INITIALIZE_WITH_SNAPSHOT" || "DOWNLOAD_DATA_FROM_BACKUP",
//         ProgressPercent: Number("int"),
//         RequestTime: new Date("TIMESTAMP"),
//         Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_OPTIMIZING" || "OPTIMIZING",
//         TargetFileSystemValues: { // FileSystem
//           OwnerId: "STRING_VALUE",
//           CreationTime: new Date("TIMESTAMP"),
//           FileSystemId: "STRING_VALUE",
//           FileSystemType: "WINDOWS" || "LUSTRE" || "ONTAP" || "OPENZFS",
//           Lifecycle: "AVAILABLE" || "CREATING" || "FAILED" || "DELETING" || "MISCONFIGURED" || "UPDATING" || "MISCONFIGURED_UNAVAILABLE",
//           FailureDetails: { // FileSystemFailureDetails
//             Message: "STRING_VALUE",
//           },
//           StorageCapacity: Number("int"),
//           StorageType: "SSD" || "HDD" || "INTELLIGENT_TIERING",
//           VpcId: "STRING_VALUE",
//           SubnetIds: [ // SubnetIds
//             "STRING_VALUE",
//           ],
//           NetworkInterfaceIds: [ // NetworkInterfaceIds
//             "STRING_VALUE",
//           ],
//           DNSName: "STRING_VALUE",
//           KmsKeyId: "STRING_VALUE",
//           ResourceARN: "STRING_VALUE",
//           Tags: [
//             {
//               Key: "STRING_VALUE", // required
//               Value: "STRING_VALUE", // required
//             },
//           ],
//           WindowsConfiguration: { // WindowsFileSystemConfiguration
//             ActiveDirectoryId: "STRING_VALUE",
//             SelfManagedActiveDirectoryConfiguration: { // SelfManagedActiveDirectoryAttributes
//               DomainName: "STRING_VALUE",
//               OrganizationalUnitDistinguishedName: "STRING_VALUE",
//               FileSystemAdministratorsGroup: "STRING_VALUE",
//               UserName: "STRING_VALUE",
//               DnsIps: [ // DnsIps
//                 "STRING_VALUE",
//               ],
//             },
//             DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1" || "SINGLE_AZ_2",
//             RemoteAdministrationEndpoint: "STRING_VALUE",
//             PreferredSubnetId: "STRING_VALUE",
//             PreferredFileServerIp: "STRING_VALUE",
//             ThroughputCapacity: Number("int"),
//             MaintenanceOperationsInProgress: [ // FileSystemMaintenanceOperations
//               "PATCHING" || "BACKING_UP",
//             ],
//             WeeklyMaintenanceStartTime: "STRING_VALUE",
//             DailyAutomaticBackupStartTime: "STRING_VALUE",
//             AutomaticBackupRetentionDays: Number("int"),
//             CopyTagsToBackups: true || false,
//             Aliases: [ // Aliases
//               { // Alias
//                 Name: "STRING_VALUE",
//                 Lifecycle: "AVAILABLE" || "CREATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED",
//               },
//             ],
//             AuditLogConfiguration: { // WindowsAuditLogConfiguration
//               FileAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required
//               FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required
//               AuditLogDestination: "STRING_VALUE",
//             },
//             DiskIopsConfiguration: { // DiskIopsConfiguration
//               Mode: "AUTOMATIC" || "USER_PROVISIONED",
//               Iops: Number("long"),
//             },
//           },
//           LustreConfiguration: { // LustreFileSystemConfiguration
//             WeeklyMaintenanceStartTime: "STRING_VALUE",
//             DataRepositoryConfiguration: { // DataRepositoryConfiguration
//               Lifecycle: "CREATING" || "AVAILABLE" || "MISCONFIGURED" || "UPDATING" || "DELETING" || "FAILED",
//               ImportPath: "STRING_VALUE",
//               ExportPath: "STRING_VALUE",
//               ImportedFileChunkSize: Number("int"),
//               AutoImportPolicy: "NONE" || "NEW" || "NEW_CHANGED" || "NEW_CHANGED_DELETED",
//               FailureDetails: { // DataRepositoryFailureDetails
//                 Message: "STRING_VALUE",
//               },
//             },
//             DeploymentType: "SCRATCH_1" || "SCRATCH_2" || "PERSISTENT_1" || "PERSISTENT_2",
//             PerUnitStorageThroughput: Number("int"),
//             MountName: "STRING_VALUE",
//             DailyAutomaticBackupStartTime: "STRING_VALUE",
//             AutomaticBackupRetentionDays: Number("int"),
//             CopyTagsToBackups: true || false,
//             DriveCacheType: "NONE" || "READ",
//             DataCompressionType: "NONE" || "LZ4",
//             LogConfiguration: { // LustreLogConfiguration
//               Level: "DISABLED" || "WARN_ONLY" || "ERROR_ONLY" || "WARN_ERROR", // required
//               Destination: "STRING_VALUE",
//             },
//             RootSquashConfiguration: { // LustreRootSquashConfiguration
//               RootSquash: "STRING_VALUE",
//               NoSquashNids: [ // LustreNoSquashNids
//                 "STRING_VALUE",
//               ],
//             },
//             MetadataConfiguration: { // FileSystemLustreMetadataConfiguration
//               Iops: Number("int"),
//               Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
//             },
//             EfaEnabled: true || false,
//           },
//           AdministrativeActions: [
//             {
//               AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE" || "THROUGHPUT_OPTIMIZATION" || "IOPS_OPTIMIZATION" || "STORAGE_TYPE_OPTIMIZATION" || "MISCONFIGURED_STATE_RECOVERY" || "VOLUME_UPDATE_WITH_SNAPSHOT" || "VOLUME_INITIALIZE_WITH_SNAPSHOT" || "DOWNLOAD_DATA_FROM_BACKUP",
//               ProgressPercent: Number("int"),
//               RequestTime: new Date("TIMESTAMP"),
//               Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_OPTIMIZING" || "OPTIMIZING",
//               TargetFileSystemValues: {
//                 OwnerId: "STRING_VALUE",
//                 CreationTime: new Date("TIMESTAMP"),
//                 FileSystemId: "STRING_VALUE",
//                 FileSystemType: "WINDOWS" || "LUSTRE" || "ONTAP" || "OPENZFS",
//                 Lifecycle: "AVAILABLE" || "CREATING" || "FAILED" || "DELETING" || "MISCONFIGURED" || "UPDATING" || "MISCONFIGURED_UNAVAILABLE",
//                 FailureDetails: {
//                   Message: "STRING_VALUE",
//                 },
//                 StorageCapacity: Number("int"),
//                 StorageType: "SSD" || "HDD" || "INTELLIGENT_TIERING",
//                 VpcId: "STRING_VALUE",
//                 SubnetIds: [
//                   "STRING_VALUE",
//                 ],
//                 NetworkInterfaceIds: [
//                   "STRING_VALUE",
//                 ],
//                 DNSName: "STRING_VALUE",
//                 KmsKeyId: "STRING_VALUE",
//                 ResourceARN: "STRING_VALUE",
//                 Tags: "<Tags>",
//                 WindowsConfiguration: {
//                   ActiveDirectoryId: "STRING_VALUE",
//                   SelfManagedActiveDirectoryConfiguration: {
//                     DomainName: "STRING_VALUE",
//                     OrganizationalUnitDistinguishedName: "STRING_VALUE",
//                     FileSystemAdministratorsGroup: "STRING_VALUE",
//                     UserName: "STRING_VALUE",
//                     DnsIps: [
//                       "STRING_VALUE",
//                     ],
//                   },
//                   DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1" || "SINGLE_AZ_2",
//                   RemoteAdministrationEndpoint: "STRING_VALUE",
//                   PreferredSubnetId: "STRING_VALUE",
//                   PreferredFileServerIp: "STRING_VALUE",
//                   ThroughputCapacity: Number("int"),
//                   MaintenanceOperationsInProgress: [
//                     "PATCHING" || "BACKING_UP",
//                   ],
//                   WeeklyMaintenanceStartTime: "STRING_VALUE",
//                   DailyAutomaticBackupStartTime: "STRING_VALUE",
//                   AutomaticBackupRetentionDays: Number("int"),
//                   CopyTagsToBackups: true || false,
//                   Aliases: [
//                     {
//                       Name: "STRING_VALUE",
//                       Lifecycle: "AVAILABLE" || "CREATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED",
//                     },
//                   ],
//                   AuditLogConfiguration: {
//                     FileAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required
//                     FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required
//                     AuditLogDestination: "STRING_VALUE",
//                   },
//                   DiskIopsConfiguration: {
//                     Mode: "AUTOMATIC" || "USER_PROVISIONED",
//                     Iops: Number("long"),
//                   },
//                 },
//                 LustreConfiguration: {
//                   WeeklyMaintenanceStartTime: "STRING_VALUE",
//                   DataRepositoryConfiguration: {
//                     Lifecycle: "CREATING" || "AVAILABLE" || "MISCONFIGURED" || "UPDATING" || "DELETING" || "FAILED",
//                     ImportPath: "STRING_VALUE",
//                     ExportPath: "STRING_VALUE",
//                     ImportedFileChunkSize: Number("int"),
//                     AutoImportPolicy: "NONE" || "NEW" || "NEW_CHANGED" || "NEW_CHANGED_DELETED",
//                     FailureDetails: {
//                       Message: "STRING_VALUE",
//                     },
//                   },
//                   DeploymentType: "SCRATCH_1" || "SCRATCH_2" || "PERSISTENT_1" || "PERSISTENT_2",
//                   PerUnitStorageThroughput: Number("int"),
//                   MountName: "STRING_VALUE",
//                   DailyAutomaticBackupStartTime: "STRING_VALUE",
//                   AutomaticBackupRetentionDays: Number("int"),
//                   CopyTagsToBackups: true || false,
//                   DriveCacheType: "NONE" || "READ",
//                   DataCompressionType: "NONE" || "LZ4",
//                   LogConfiguration: {
//                     Level: "DISABLED" || "WARN_ONLY" || "ERROR_ONLY" || "WARN_ERROR", // required
//                     Destination: "STRING_VALUE",
//                   },
//                   RootSquashConfiguration: {
//                     RootSquash: "STRING_VALUE",
//                     NoSquashNids: [
//                       "STRING_VALUE",
//                     ],
//                   },
//                   MetadataConfiguration: {
//                     Iops: Number("int"),
//                     Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
//                   },
//                   EfaEnabled: true || false,
//                 },
//                 AdministrativeActions: "<AdministrativeActions>",
//                 OntapConfiguration: { // OntapFileSystemConfiguration
//                   AutomaticBackupRetentionDays: Number("int"),
//                   DailyAutomaticBackupStartTime: "STRING_VALUE",
//                   DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1" || "SINGLE_AZ_2" || "MULTI_AZ_2",
//                   EndpointIpAddressRange: "STRING_VALUE",
//                   Endpoints: { // FileSystemEndpoints
//                     Intercluster: { // FileSystemEndpoint
//                       DNSName: "STRING_VALUE",
//                       IpAddresses: [ // OntapEndpointIpAddresses
//                         "STRING_VALUE",
//                       ],
//                     },
//                     Management: {
//                       DNSName: "STRING_VALUE",
//                       IpAddresses: [
//                         "STRING_VALUE",
//                       ],
//                     },
//                   },
//                   DiskIopsConfiguration: {
//                     Mode: "AUTOMATIC" || "USER_PROVISIONED",
//                     Iops: Number("long"),
//                   },
//                   PreferredSubnetId: "STRING_VALUE",
//                   RouteTableIds: [ // RouteTableIds
//                     "STRING_VALUE",
//                   ],
//                   ThroughputCapacity: Number("int"),
//                   WeeklyMaintenanceStartTime: "STRING_VALUE",
//                   FsxAdminPassword: "STRING_VALUE",
//                   HAPairs: Number("int"),
//                   ThroughputCapacityPerHAPair: Number("int"),
//                 },
//                 FileSystemTypeVersion: "STRING_VALUE",
//                 OpenZFSConfiguration: { // OpenZFSFileSystemConfiguration
//                   AutomaticBackupRetentionDays: Number("int"),
//                   CopyTagsToBackups: true || false,
//                   CopyTagsToVolumes: true || false,
//                   DailyAutomaticBackupStartTime: "STRING_VALUE",
//                   DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2" || "SINGLE_AZ_HA_1" || "SINGLE_AZ_HA_2" || "MULTI_AZ_1",
//                   ThroughputCapacity: Number("int"),
//                   WeeklyMaintenanceStartTime: "STRING_VALUE",
//                   DiskIopsConfiguration: {
//                     Mode: "AUTOMATIC" || "USER_PROVISIONED",
//                     Iops: Number("long"),
//                   },
//                   RootVolumeId: "STRING_VALUE",
//                   PreferredSubnetId: "STRING_VALUE",
//                   EndpointIpAddressRange: "STRING_VALUE",
//                   RouteTableIds: [
//                     "STRING_VALUE",
//                   ],
//                   EndpointIpAddress: "STRING_VALUE",
//                   ReadCacheConfiguration: { // OpenZFSReadCacheConfiguration
//                     SizingMode: "NO_CACHE" || "USER_PROVISIONED" || "PROPORTIONAL_TO_THROUGHPUT_CAPACITY",
//                     SizeGiB: Number("int"),
//                   },
//                 },
//               },
//               FailureDetails: { // AdministrativeActionFailureDetails
//                 Message: "STRING_VALUE",
//               },
//               TargetVolumeValues: {
//                 CreationTime: new Date("TIMESTAMP"),
//                 FileSystemId: "STRING_VALUE",
//                 Lifecycle: "CREATING" || "CREATED" || "DELETING" || "FAILED" || "MISCONFIGURED" || "PENDING" || "AVAILABLE",
//                 Name: "STRING_VALUE",
//                 OntapConfiguration: {
//                   FlexCacheEndpointType: "NONE" || "ORIGIN" || "CACHE",
//                   JunctionPath: "STRING_VALUE",
//                   SecurityStyle: "UNIX" || "NTFS" || "MIXED",
//                   SizeInMegabytes: Number("int"),
//                   StorageEfficiencyEnabled: true || false,
//                   StorageVirtualMachineId: "STRING_VALUE",
//                   StorageVirtualMachineRoot: true || false,
//                   TieringPolicy: {
//                     CoolingPeriod: Number("int"),
//                     Name: "SNAPSHOT_ONLY" || "AUTO" || "ALL" || "NONE",
//                   },
//                   UUID: "STRING_VALUE",
//                   OntapVolumeType: "RW" || "DP" || "LS",
//                   SnapshotPolicy: "STRING_VALUE",
//                   CopyTagsToBackups: true || false,
//                   SnaplockConfiguration: {
//                     AuditLogVolume: true || false,
//                     AutocommitPeriod: {
//                       Type: "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "NONE", // required
//                       Value: Number("int"),
//                     },
//                     PrivilegedDelete: "DISABLED" || "ENABLED" || "PERMANENTLY_DISABLED",
//                     RetentionPeriod: {
//                       DefaultRetention: {
//                         Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required
//                         Value: Number("int"),
//                       },
//                       MinimumRetention: {
//                         Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required
//                         Value: Number("int"),
//                       },
//                       MaximumRetention: "<RetentionPeriod>", // required
//                     },
//                     SnaplockType: "COMPLIANCE" || "ENTERPRISE",
//                     VolumeAppendModeEnabled: true || false,
//                   },
//                   VolumeStyle: "FLEXVOL" || "FLEXGROUP",
//                   AggregateConfiguration: {
//                     Aggregates: [
//                       "STRING_VALUE",
//                     ],
//                     TotalConstituents: Number("int"),
//                   },
//                   SizeInBytes: Number("long"),
//                 },
//                 ResourceARN: "STRING_VALUE",
//                 Tags: "<Tags>",
//                 VolumeId: "STRING_VALUE",
//                 VolumeType: "ONTAP" || "OPENZFS",
//                 LifecycleTransitionReason: {
//                   Message: "STRING_VALUE",
//                 },
//                 AdministrativeActions: "<AdministrativeActions>",
//                 OpenZFSConfiguration: { // OpenZFSVolumeConfiguration
//                   ParentVolumeId: "STRING_VALUE",
//                   VolumePath: "STRING_VALUE",
//                   StorageCapacityReservationGiB: Number("int"),
//                   StorageCapacityQuotaGiB: Number("int"),
//                   RecordSizeKiB: Number("int"),
//                   DataCompressionType: "NONE" || "ZSTD" || "LZ4",
//                   CopyTagsToSnapshots: true || false,
//                   OriginSnapshot: { // OpenZFSOriginSnapshotConfiguration
//                     SnapshotARN: "STRING_VALUE",
//                     CopyStrategy: "CLONE" || "FULL_COPY" || "INCREMENTAL_COPY",
//                   },
//                   ReadOnly: true || false,
//                   NfsExports: [ // OpenZFSNfsExports
//                     { // OpenZFSNfsExport
//                       ClientConfigurations: [ // OpenZFSClientConfigurations // required
//                         { // OpenZFSClientConfiguration
//                           Clients: "STRING_VALUE", // required
//                           Options: [ // OpenZFSNfsExportOptions // required
//                             "STRING_VALUE",
//                           ],
//                         },
//                       ],
//                     },
//                   ],
//                   UserAndGroupQuotas: [ // OpenZFSUserAndGroupQuotas
//                     { // OpenZFSUserOrGroupQuota
//                       Type: "USER" || "GROUP", // required
//                       Id: Number("int"), // required
//                       StorageCapacityQuotaGiB: Number("int"), // required
//                     },
//                   ],
//                   RestoreToSnapshot: "STRING_VALUE",
//                   DeleteIntermediateSnaphots: true || false,
//                   DeleteClonedVolumes: true || false,
//                   DeleteIntermediateData: true || false,
//                   SourceSnapshotARN: "STRING_VALUE",
//                   DestinationSnapshot: "STRING_VALUE",
//                   CopyStrategy: "CLONE" || "FULL_COPY" || "INCREMENTAL_COPY",
//                 },
//               },
//               TargetSnapshotValues: { // Snapshot
//                 ResourceARN: "STRING_VALUE",
//                 SnapshotId: "STRING_VALUE",
//                 Name: "STRING_VALUE",
//                 VolumeId: "STRING_VALUE",
//                 CreationTime: new Date("TIMESTAMP"),
//                 Lifecycle: "PENDING" || "CREATING" || "DELETING" || "AVAILABLE",
//                 LifecycleTransitionReason: {
//                   Message: "STRING_VALUE",
//                 },
//                 Tags: "<Tags>",
//                 AdministrativeActions: "<AdministrativeActions>",
//               },
//               TotalTransferBytes: Number("long"),
//               RemainingTransferBytes: Number("long"),
//             },
//           ],
//           OntapConfiguration: {
//             AutomaticBackupRetentionDays: Number("int"),
//             DailyAutomaticBackupStartTime: "STRING_VALUE",
//             DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1" || "SINGLE_AZ_2" || "MULTI_AZ_2",
//             EndpointIpAddressRange: "STRING_VALUE",
//             Endpoints: {
//               Intercluster: {
//                 DNSName: "STRING_VALUE",
//                 IpAddresses: [
//                   "STRING_VALUE",
//                 ],
//               },
//               Management: {
//                 DNSName: "STRING_VALUE",
//                 IpAddresses: [
//                   "STRING_VALUE",
//                 ],
//               },
//             },
//             DiskIopsConfiguration: {
//               Mode: "AUTOMATIC" || "USER_PROVISIONED",
//               Iops: Number("long"),
//             },
//             PreferredSubnetId: "STRING_VALUE",
//             RouteTableIds: [
//               "STRING_VALUE",
//             ],
//             ThroughputCapacity: Number("int"),
//             WeeklyMaintenanceStartTime: "STRING_VALUE",
//             FsxAdminPassword: "STRING_VALUE",
//             HAPairs: Number("int"),
//             ThroughputCapacityPerHAPair: Number("int"),
//           },
//           FileSystemTypeVersion: "STRING_VALUE",
//           OpenZFSConfiguration: {
//             AutomaticBackupRetentionDays: Number("int"),
//             CopyTagsToBackups: true || false,
//             CopyTagsToVolumes: true || false,
//             DailyAutomaticBackupStartTime: "STRING_VALUE",
//             DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2" || "SINGLE_AZ_HA_1" || "SINGLE_AZ_HA_2" || "MULTI_AZ_1",
//             ThroughputCapacity: Number("int"),
//             WeeklyMaintenanceStartTime: "STRING_VALUE",
//             DiskIopsConfiguration: "<DiskIopsConfiguration>",
//             RootVolumeId: "STRING_VALUE",
//             PreferredSubnetId: "STRING_VALUE",
//             EndpointIpAddressRange: "STRING_VALUE",
//             RouteTableIds: [
//               "STRING_VALUE",
//             ],
//             EndpointIpAddress: "STRING_VALUE",
//             ReadCacheConfiguration: {
//               SizingMode: "NO_CACHE" || "USER_PROVISIONED" || "PROPORTIONAL_TO_THROUGHPUT_CAPACITY",
//               SizeGiB: Number("int"),
//             },
//           },
//         },
//         FailureDetails: {
//           Message: "STRING_VALUE",
//         },
//         TargetVolumeValues: "<Volume>",
//         TargetSnapshotValues: {
//           ResourceARN: "STRING_VALUE",
//           SnapshotId: "STRING_VALUE",
//           Name: "STRING_VALUE",
//           VolumeId: "STRING_VALUE",
//           CreationTime: new Date("TIMESTAMP"),
//           Lifecycle: "PENDING" || "CREATING" || "DELETING" || "AVAILABLE",
//           LifecycleTransitionReason: "<LifecycleTransitionReason>",
//           Tags: "<Tags>",
//           AdministrativeActions: "<AdministrativeActions>",
//         },
//         TotalTransferBytes: Number("long"),
//         RemainingTransferBytes: Number("long"),
//       },
//     ],
//     OpenZFSConfiguration: {
//       ParentVolumeId: "STRING_VALUE",
//       VolumePath: "STRING_VALUE",
//       StorageCapacityReservationGiB: Number("int"),
//       StorageCapacityQuotaGiB: Number("int"),
//       RecordSizeKiB: Number("int"),
//       DataCompressionType: "NONE" || "ZSTD" || "LZ4",
//       CopyTagsToSnapshots: true || false,
//       OriginSnapshot: {
//         SnapshotARN: "STRING_VALUE",
//         CopyStrategy: "CLONE" || "FULL_COPY" || "INCREMENTAL_COPY",
//       },
//       ReadOnly: true || false,
//       NfsExports: [
//         {
//           ClientConfigurations: [ // required
//             {
//               Clients: "STRING_VALUE", // required
//               Options: [ // required
//                 "STRING_VALUE",
//               ],
//             },
//           ],
//         },
//       ],
//       UserAndGroupQuotas: [
//         {
//           Type: "USER" || "GROUP", // required
//           Id: Number("int"), // required
//           StorageCapacityQuotaGiB: Number("int"), // required
//         },
//       ],
//       RestoreToSnapshot: "STRING_VALUE",
//       DeleteIntermediateSnaphots: true || false,
//       DeleteClonedVolumes: true || false,
//       DeleteIntermediateData: true || false,
//       SourceSnapshotARN: "STRING_VALUE",
//       DestinationSnapshot: "STRING_VALUE",
//       CopyStrategy: "CLONE" || "FULL_COPY" || "INCREMENTAL_COPY",
//     },
//   },
// };

CreateVolumeCommand Input

See CreateVolumeCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

Specifies the name of the volume that you're creating.

VolumeType
Required
VolumeType | undefined

Specifies the type of volume to create; ONTAP and OPENZFS are the only valid volume types.

ClientRequestToken
string | undefined

(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 Command Line Interface (CLI) or an Amazon Web Services SDK.

OntapConfiguration
CreateOntapVolumeConfiguration | undefined

Specifies the configuration to use when creating the ONTAP volume.

OpenZFSConfiguration
CreateOpenZFSVolumeConfiguration | undefined

Specifies the configuration to use when creating the OpenZFS volume.

Tags
Tag[] | undefined

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

CreateVolumeCommand Output

See CreateVolumeCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Volume
Volume | undefined

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

Throws

Name
Fault
Details
BadRequest
client

A generic error indicating a failure with a client request.

FileSystemNotFound
client

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

IncompatibleParameterError
client

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.

InternalServerError
server

A generic error indicating a server-side failure.

MissingVolumeConfiguration
client

A volume configuration is required for this operation.

ServiceLimitExceeded
client

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

StorageVirtualMachineNotFound
client

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

UnsupportedOperation
client

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

FSxServiceException
Base exception class for all service exceptions from FSx service.