class Aws::FSx::Types::CreateFileSystemRequest
The request object used to create a new Amazon FSx
file system.
@note When making an API call, you may pass CreateFileSystemRequest
data as a hash: { client_request_token: "ClientRequestToken", file_system_type: "WINDOWS", # required, accepts WINDOWS, LUSTRE, ONTAP storage_capacity: 1, # required storage_type: "SSD", # accepts SSD, HDD subnet_ids: ["SubnetId"], # required security_group_ids: ["SecurityGroupId"], tags: [ { key: "TagKey", # required value: "TagValue", # required }, ], kms_key_id: "KmsKeyId", windows_configuration: { active_directory_id: "DirectoryId", self_managed_active_directory_configuration: { domain_name: "ActiveDirectoryFullyQualifiedName", # required organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName", file_system_administrators_group: "FileSystemAdministratorsGroupName", user_name: "DirectoryUserName", # required password: "DirectoryPassword", # required dns_ips: ["IpAddress"], # required }, deployment_type: "MULTI_AZ_1", # accepts MULTI_AZ_1, SINGLE_AZ_1, SINGLE_AZ_2 preferred_subnet_id: "SubnetId", throughput_capacity: 1, # required weekly_maintenance_start_time: "WeeklyTime", daily_automatic_backup_start_time: "DailyTime", automatic_backup_retention_days: 1, copy_tags_to_backups: false, aliases: ["AlternateDNSName"], audit_log_configuration: { file_access_audit_log_level: "DISABLED", # required, accepts DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE file_share_access_audit_log_level: "DISABLED", # required, accepts DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE audit_log_destination: "GeneralARN", }, }, lustre_configuration: { weekly_maintenance_start_time: "WeeklyTime", import_path: "ArchivePath", export_path: "ArchivePath", imported_file_chunk_size: 1, deployment_type: "SCRATCH_1", # accepts SCRATCH_1, SCRATCH_2, PERSISTENT_1 auto_import_policy: "NONE", # accepts NONE, NEW, NEW_CHANGED per_unit_storage_throughput: 1, daily_automatic_backup_start_time: "DailyTime", automatic_backup_retention_days: 1, copy_tags_to_backups: false, drive_cache_type: "NONE", # accepts NONE, READ data_compression_type: "NONE", # accepts NONE, LZ4 }, ontap_configuration: { automatic_backup_retention_days: 1, daily_automatic_backup_start_time: "DailyTime", deployment_type: "MULTI_AZ_1", # required, accepts MULTI_AZ_1 endpoint_ip_address_range: "IpAddressRange", fsx_admin_password: "AdminPassword", disk_iops_configuration: { mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED iops: 1, }, preferred_subnet_id: "SubnetId", route_table_ids: ["RouteTableId"], throughput_capacity: 1, # required weekly_maintenance_start_time: "WeeklyTime", }, }
@!attribute [rw] client_request_token
A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. **A suitable default value is auto-generated.** You should normally not need to pass this option. @return [String]
@!attribute [rw] file_system_type
The type of Amazon FSx file system to create. Valid values are `WINDOWS`, `LUSTRE`, and `ONTAP`. @return [String]
@!attribute [rw] storage_capacity
Sets the storage capacity of the file system that you're creating. For Lustre file systems: * For `SCRATCH_2` and `PERSISTENT_1 SSD` deployment types, valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. * For `PERSISTENT HDD` file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems. * For `SCRATCH_1` deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB. For Windows file systems: * If `StorageType=SSD`, valid values are 32 GiB - 65,536 GiB (64 TiB). * If `StorageType=HDD`, valid values are 2000 GiB - 65,536 GiB (64 TiB). For ONTAP file systems: * Valid values are 1024 GiB - 196,608 GiB (192 TiB). ^ @return [Integer]
@!attribute [rw] storage_type
Sets the storage type for the file system you're creating. Valid values are `SSD` and `HDD`. * Set to `SSD` to use solid state drive storage. SSD is supported on all Windows, Lustre, and ONTAP deployment types. * Set to `HDD` to use hard disk drive storage. HDD is supported on `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment types, and on `PERSISTENT` Lustre file system deployment types. Default value is `SSD`. For more information, see [ Storage Type Options][1] in the *Amazon FSx for Windows User Guide* and [Multiple Storage Options][2] in the *Amazon FSx for Lustre User Guide*. [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options [2]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options @return [String]
@!attribute [rw] subnet_ids
Specifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAP `MULTI_AZ_1` file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the `WindowsConfiguration > PreferredSubnetID` or `OntapConfiguration > PreferredSubnetID` properties. For more information, see [ Availability and durability: Single-AZ and Multi-AZ file systems][1] in the *Amazon FSx for Windows User Guide* and [ Availability and durability][2] in the *Amazon FSx for ONTAP User Guide*. For Windows `SINGLE_AZ_1` and `SINGLE_AZ_2` file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone. [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html @return [Array<String>]
@!attribute [rw] security_group_ids
A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system. @return [Array<String>]
@!attribute [rw] tags
The tags to apply to the file system being created. The key value of the `Name` tag appears in the console as the file system name. @return [Array<Types::Tag>]
@!attribute [rw] kms_key_id
The ID of the Key Management Service (KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx for Lustre `PERSISTENT_1` file systems at rest. If not specified, the Amazon FSx managed key is used. The Amazon FSx for Lustre `SCRATCH_1` and `SCRATCH_2` file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see [Encrypt][1] in the *Key Management Service API Reference*. [1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html @return [String]
@!attribute [rw] windows_configuration
The Microsoft Windows configuration for the file system being created. @return [Types::CreateFileSystemWindowsConfiguration]
@!attribute [rw] lustre_configuration
The Lustre configuration for the file system being created. @return [Types::CreateFileSystemLustreConfiguration]
@!attribute [rw] ontap_configuration
The ONTAP configuration properties of the FSx for NetApp ONTAP file system that you are creating. @return [Types::CreateFileSystemOntapConfiguration]
@see docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemRequest AWS API Documentation
Constants
- SENSITIVE