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

The request object used to create a new Amazon FSx file system.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  A string of up to 63 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

  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.

• #network_type ⇒ String

  The network type of the Amazon FSx file system that you are creating.

• #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 class 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 63 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.

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2831

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,
  :network_type)
  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.

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2831

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,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_type_version ⇒ String

For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are 2.10, 2.12, and 2.15:

• 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.

• 2.12 is supported by all Lustre deployment types, except for PERSISTENT_2 with a metadata configuration mode.

• 2.15 is supported by all Lustre deployment types and is recommended for all new file systems.

Default value is 2.10, except for the following deployments:

• Default value is 2.12 when DeploymentType is set to PERSISTENT_2 without a metadata configuration mode.

• Default value is 2.15 when DeploymentType is set to PERSISTENT_2 with a metadata configuration mode.

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2831

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,
  :network_type)
  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 and PERSISTENT_2 deployment types only.

  SCRATCH_1 and SCRATCH_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.

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2831

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,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#lustre_configuration ⇒ Types::CreateFileSystemLustreConfiguration

The Lustre configuration for the file system being created.

The following parameters are not supported for file systems with a data repository association created with .

• AutoImportPolicy

• ExportPath

• ImportedFileChunkSize

• ImportPath

Returns:

• (Types::CreateFileSystemLustreConfiguration)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2831

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,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#network_type ⇒ String

The network type of the Amazon FSx file system that you are creating. Valid values are IPV4 (which supports IPv4 only) and DUAL (for dual-stack mode, which supports both IPv4 and IPv6). The default is IPV4. Supported for FSx for OpenZFS, FSx for ONTAP, and FSx for Windows File Server file systems.

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2831

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,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#ontap_configuration ⇒ Types::CreateFileSystemOntapConfiguration

The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

Returns:

• (Types::CreateFileSystemOntapConfiguration)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2831

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,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#open_zfs_configuration ⇒ Types::CreateFileSystemOpenZFSConfiguration

The OpenZFS configuration for the file system that's being created.

Returns:

• (Types::CreateFileSystemOpenZFSConfiguration)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2831

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,
  :network_type)
  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.

You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2831

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,
  :network_type)
  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, and PERSISTENT_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 depends on the value of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 * HAPairs.

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).

Returns:

• (Integer)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2831

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,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ String

Sets the storage class for the file system that you're creating. Valid values are SSD, HDD, and INTELLIGENT_TIERING.

• 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, which is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT_1 Lustre file system deployment types.

• Set to INTELLIGENT_TIERING to use fully elastic, intelligently-tiered storage. Intelligent-Tiering is only available for OpenZFS file systems with the Multi-AZ deployment type and for Lustre file systems with the Persistent_2 deployment type.

Default value is SSD. For more information, see Storage type options in the FSx for Windows File Server User Guide, FSx for Lustre storage classes in the FSx for Lustre User Guide, and Working with Intelligent-Tiering in the Amazon FSx for OpenZFS User Guide.

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2831

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,
  :network_type)
  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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2831

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,
  :network_type)
  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.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2831

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,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#windows_configuration ⇒ Types::CreateFileSystemWindowsConfiguration

The Microsoft Windows configuration for the file system that's being created.

Returns:

• (Types::CreateFileSystemWindowsConfiguration)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2831

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,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end