Class: Aws::FSx::Types::CreateFileSystemRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::FSx::Types::CreateFileSystemRequest
- Defined in:
- gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb
Overview
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, OPENZFS
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, PERSISTENT_2
auto_import_policy: "NONE", # accepts NONE, NEW, NEW_CHANGED, NEW_CHANGED_DELETED
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
log_configuration: {
level: "DISABLED", # required, accepts DISABLED, WARN_ONLY, ERROR_ONLY, WARN_ERROR
destination: "GeneralARN",
},
root_squash_configuration: {
root_squash: "LustreRootSquash",
no_squash_nids: ["LustreNoSquashNid"],
},
},
ontap_configuration: {
automatic_backup_retention_days: 1,
daily_automatic_backup_start_time: "DailyTime",
deployment_type: "MULTI_AZ_1", # required, accepts MULTI_AZ_1, SINGLE_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",
},
file_system_type_version: "FileSystemTypeVersion",
open_zfs_configuration: {
automatic_backup_retention_days: 1,
copy_tags_to_backups: false,
copy_tags_to_volumes: false,
daily_automatic_backup_start_time: "DailyTime",
deployment_type: "SINGLE_AZ_1", # required, accepts SINGLE_AZ_1
throughput_capacity: 1, # required
weekly_maintenance_start_time: "WeeklyTime",
disk_iops_configuration: {
mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
iops: 1,
},
root_volume_configuration: {
record_size_ki_b: 1,
data_compression_type: "NONE", # accepts NONE, ZSTD, LZ4
nfs_exports: [
{
client_configurations: [ # required
{
clients: "OpenZFSClients", # required
options: ["OpenZFSNfsExportOption"], # required
},
],
},
],
user_and_group_quotas: [
{
type: "USER", # required, accepts USER, GROUP
id: 1, # required
storage_capacity_quota_gi_b: 1, # required
},
],
copy_tags_to_snapshots: false,
read_only: false,
},
},
}
The request object used to create a new Amazon FSx file system.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_request_token ⇒ String
A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation.
-
#file_system_type ⇒ String
The type of Amazon FSx file system to create.
-
#file_system_type_version ⇒ String
(Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.
-
#kms_key_id ⇒ String
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:.
-
#lustre_configuration ⇒ Types::CreateFileSystemLustreConfiguration
The Lustre configuration for the file system being created.
-
#ontap_configuration ⇒ Types::CreateFileSystemOntapConfiguration
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
-
#open_zfs_configuration ⇒ Types::CreateFileSystemOpenZFSConfiguration
The OpenZFS configuration for the file system that's being created.
-
#security_group_ids ⇒ Array<String>
A list of IDs specifying the security groups to apply to all network interfaces created for file system access.
-
#storage_capacity ⇒ Integer
Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).
-
#storage_type ⇒ String
Sets the storage type for the file system that you're creating.
-
#subnet_ids ⇒ Array<String>
Specifies the IDs of the subnets that the file system will be accessible from.
-
#tags ⇒ Array<Types::Tag>
The tags to apply to the file system that's being created.
-
#windows_configuration ⇒ Types::CreateFileSystemWindowsConfiguration
The Microsoft Windows configuration for the file system that's being created.
Instance Attribute Details
#client_request_token ⇒ String
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.
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2300 class CreateFileSystemRequest < Struct.new( :client_request_token, :file_system_type, :storage_capacity, :storage_type, :subnet_ids, :security_group_ids, :tags, :kms_key_id, :windows_configuration, :lustre_configuration, :ontap_configuration, :file_system_type_version, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end |
#file_system_type ⇒ String
The type of Amazon FSx file system to create. Valid values are
WINDOWS
, LUSTRE
, ONTAP
, and OPENZFS
.
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2300 class CreateFileSystemRequest < Struct.new( :client_request_token, :file_system_type, :storage_capacity, :storage_type, :subnet_ids, :security_group_ids, :tags, :kms_key_id, :windows_configuration, :lustre_configuration, :ontap_configuration, :file_system_type_version, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end |
#file_system_type_version ⇒ String
(Optional) For FSx for Lustre file systems, sets the Lustre version
for the file system that you're creating. Valid values are 2.10
and 2.12
:
2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
2.12 is supported by all Lustre deployment types.
2.12
is required when setting FSx for LustreDeploymentType
toPERSISTENT_2
.
Default value = 2.10
, except when DeploymentType
is set to
PERSISTENT_2
, then the default is 2.12
.
FileSystemTypeVersion
to 2.10
for a PERSISTENT_2
Lustre deployment type, the CreateFileSystem
operation fails.
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2300 class CreateFileSystemRequest < Struct.new( :client_request_token, :file_system_type, :storage_capacity, :storage_type, :subnet_ids, :security_group_ids, :tags, :kms_key_id, :windows_configuration, :lustre_configuration, :ontap_configuration, :file_system_type_version, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end |
#kms_key_id ⇒ String
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:
Amazon FSx for Lustre
PERSISTENT_1
andPERSISTENT_2
deployment types only.SCRATCH_1
andSCRATCH_2
types are encrypted using the Amazon FSx service KMS key for your account.Amazon FSx for NetApp ONTAP
Amazon FSx for OpenZFS
Amazon FSx for Windows File Server
If a KmsKeyId
isn't specified, the Amazon FSx-managed KMS key for
your account is used. For more information, see Encrypt in the
Key Management Service API Reference.
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2300 class CreateFileSystemRequest < Struct.new( :client_request_token, :file_system_type, :storage_capacity, :storage_type, :subnet_ids, :security_group_ids, :tags, :kms_key_id, :windows_configuration, :lustre_configuration, :ontap_configuration, :file_system_type_version, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end |
#lustre_configuration ⇒ Types::CreateFileSystemLustreConfiguration
The Lustre configuration for the file system being created.
Persistent_2
deployment type. Instead, use
CreateDataRepositoryAssociation
to create a data repository
association to link your Lustre file system to a data repository.
AutoImportPolicy
ExportPath
ImportedChunkSize
ImportPath
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2300 class CreateFileSystemRequest < Struct.new( :client_request_token, :file_system_type, :storage_capacity, :storage_type, :subnet_ids, :security_group_ids, :tags, :kms_key_id, :windows_configuration, :lustre_configuration, :ontap_configuration, :file_system_type_version, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end |
#ontap_configuration ⇒ Types::CreateFileSystemOntapConfiguration
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2300 class CreateFileSystemRequest < Struct.new( :client_request_token, :file_system_type, :storage_capacity, :storage_type, :subnet_ids, :security_group_ids, :tags, :kms_key_id, :windows_configuration, :lustre_configuration, :ontap_configuration, :file_system_type_version, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end |
#open_zfs_configuration ⇒ Types::CreateFileSystemOpenZFSConfiguration
The OpenZFS configuration for the file system that's being created.
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2300 class CreateFileSystemRequest < Struct.new( :client_request_token, :file_system_type, :storage_capacity, :storage_type, :subnet_ids, :security_group_ids, :tags, :kms_key_id, :windows_configuration, :lustre_configuration, :ontap_configuration, :file_system_type_version, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end |
#security_group_ids ⇒ Array<String>
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.
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2300 class CreateFileSystemRequest < Struct.new( :client_request_token, :file_system_type, :storage_capacity, :storage_type, :subnet_ids, :security_group_ids, :tags, :kms_key_id, :windows_configuration, :lustre_configuration, :ontap_configuration, :file_system_type_version, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end |
#storage_capacity ⇒ Integer
Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).
FSx for Lustre file systems - The amount of storage capacity
that you can configure depends on the value that you set for
StorageType
and the Lustre DeploymentType
, as follows:
For
SCRATCH_2
,PERSISTENT_2
andPERSISTENT_1
deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.For
PERSISTENT_1
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.
FSx for ONTAP file systems - The amount of storage capacity that you can configure is from 1024 GiB up to 196,608 GiB (192 TiB).
FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
FSx for Windows File Server file systems - The amount of storage
capacity that you can configure depends on the value that you set
for StorageType
as follows:
For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2300 class CreateFileSystemRequest < Struct.new( :client_request_token, :file_system_type, :storage_capacity, :storage_type, :subnet_ids, :security_group_ids, :tags, :kms_key_id, :windows_configuration, :lustre_configuration, :ontap_configuration, :file_system_type_version, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end |
#storage_type ⇒ String
Sets the storage type for the file system that 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, ONTAP, and OpenZFS deployment types.Set to
HDD
to use hard disk drive storage. HDD is supported onSINGLE_AZ_2
andMULTI_AZ_1
Windows file system deployment types, and onPERSISTENT_1
Lustre file system deployment types.
Default value is SSD
. For more information, see Storage type
options in the FSx for Windows File Server User Guide and
Multiple storage options in the FSx for Lustre User Guide.
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2300 class CreateFileSystemRequest < Struct.new( :client_request_token, :file_system_type, :storage_capacity, :storage_type, :subnet_ids, :security_group_ids, :tags, :kms_key_id, :windows_configuration, :lustre_configuration, :ontap_configuration, :file_system_type_version, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end |
#subnet_ids ⇒ Array<String>
Specifies the IDs of the subnets that the file system will be
accessible from. For Windows and ONTAP MULTI_AZ_1
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 about Multi-AZ file system
configuration, see Availability and durability: Single-AZ and
Multi-AZ file systems in the Amazon FSx for Windows User Guide
and Availability and durability in the Amazon FSx for ONTAP
User Guide.
For Windows SINGLE_AZ_1
and SINGLE_AZ_2
and all Lustre
deployment types, provide exactly one subnet ID. The file server is
launched in that subnet's Availability Zone.
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2300 class CreateFileSystemRequest < Struct.new( :client_request_token, :file_system_type, :storage_capacity, :storage_type, :subnet_ids, :security_group_ids, :tags, :kms_key_id, :windows_configuration, :lustre_configuration, :ontap_configuration, :file_system_type_version, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
The tags to apply to the file system that's being created. The key
value of the Name
tag appears in the console as the file system
name.
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2300 class CreateFileSystemRequest < Struct.new( :client_request_token, :file_system_type, :storage_capacity, :storage_type, :subnet_ids, :security_group_ids, :tags, :kms_key_id, :windows_configuration, :lustre_configuration, :ontap_configuration, :file_system_type_version, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end |
#windows_configuration ⇒ Types::CreateFileSystemWindowsConfiguration
The Microsoft Windows configuration for the file system that's being created.
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2300 class CreateFileSystemRequest < Struct.new( :client_request_token, :file_system_type, :storage_capacity, :storage_type, :subnet_ids, :security_group_ids, :tags, :kms_key_id, :windows_configuration, :lustre_configuration, :ontap_configuration, :file_system_type_version, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end |