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
  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
    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,
  },
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

(Optional) 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)

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

Possible values:

  • WINDOWS
  • LUSTRE

Returns:

  • (String)

    The type of Amazon FSx file system to create.

#kms_key_idString

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system at rest. Amazon FSx for Lustre does not support KMS encryption. 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 an Amazon FSx for Windows File Server file system at rest.

#lustre_configurationTypes::CreateFileSystemLustreConfiguration

The Lustre configuration for the file system being created. This value is required if FileSystemType is set to LUSTRE.

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

The storage capacity of the file system being created.

For Windows file systems, valid values are 32 GiB - 65,536 GiB.

For Lustre file systems, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3600 GiB.

Returns:

  • (Integer)

    The storage capacity of the file system being created.

#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 standy file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.

For Windows SINGLE_AZ_1 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. This value is required if FileSystemType is set to WINDOWS.

Returns: