You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::FSx::Types::CreateFileSystemRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateFileSystemRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  client_request_token: "ClientRequestToken",
  file_system_type: "WINDOWS", # required, accepts WINDOWS, LUSTRE
  storage_capacity: 1, # required
  storage_type: "SSD", # accepts SSD, HDD
  subnet_ids: ["SubnetId"], # required
  security_group_ids: ["SecurityGroupId"],
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  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,
  },
  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
    per_unit_storage_throughput: 1,
    daily_automatic_backup_start_time: "DailyTime",
    automatic_backup_retention_days: 1,
    copy_tags_to_backups: false,
  },
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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

Returns:

  • (String)

    A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation.

#file_system_typeString

The type of Amazon FSx file system to create, either WINDOWS or LUSTRE.

Possible values:

  • WINDOWS
  • LUSTRE

Returns:

  • (String)

    The type of Amazon FSx file system to create, either WINDOWS or LUSTRE.

#kms_key_idString

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and Amazon FSx for Lustre PERSISTENT_1 file systems at rest. In either case, 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 in the AWS Key Management Service API Reference.

Returns:

  • (String)

    The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and Amazon FSx for Lustre PERSISTENT_1 file systems at rest.

#lustre_configurationTypes::CreateFileSystemLustreConfiguration

The Lustre configuration for the file system being created.

Returns:

#security_group_idsArray<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.

Returns:

  • (Array<String>)

    A list of IDs specifying the security groups to apply to all network interfaces created for file system access.

#storage_capacityInteger

Sets the storage capacity of the file system that you\'re creating.

For Lustre file systems:

  • For SCRATCH_2 and PERSISTENT_1 deployment types, valid values are 1.2, 2.4, and increments of 2.4 TiB.

  • For SCRATCH_1 deployment type, valid values are 1.2, 2.4, and increments of 3.6 TiB.

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

Returns:

  • (Integer)

    Sets the storage capacity of the file system that you\'re creating.

#storage_typeString

Sets the storage type for the Amazon FSx for Windows 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 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.

Default value is SSD. For more information, see Storage Type Options in the Amazon FSx for Windows User Guide.

Returns:

  • (String)

    Sets the storage type for the Amazon FSx for Windows file system you\'re creating.

#subnet_idsArray<String>

Specifies the IDs of the subnets that the file system will be accessible from. For Windows 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 property.

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.

Returns:

  • (Array<String>)

    Specifies the IDs of the subnets that the file system will be accessible from.

#tagsArray<Types::Tag>

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.

Returns:

  • (Array<Types::Tag>)

    The tags to apply to the file system being created.

#windows_configurationTypes::CreateFileSystemWindowsConfiguration

The Microsoft Windows configuration for the file system being created.

Returns: