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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-fsx/types.rb

Overview

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
  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",
    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 for the ‘CreateFileSystem` operation.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/aws-sdk-fsx/types.rb', line 402

class CreateFileSystemRequest < Struct.new(
  :client_request_token,
  :file_system_type,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :kms_key_id,
  :windows_configuration,
  :lustre_configuration)
  include Aws::Structure
end

#file_system_type ⇒ String

The type of file system.

Returns:

  • (String) 


402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/aws-sdk-fsx/types.rb', line 402

class CreateFileSystemRequest < Struct.new(
  :client_request_token,
  :file_system_type,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :kms_key_id,
  :windows_configuration,
  :lustre_configuration)
  include Aws::Structure
end

#kms_key_id ⇒ String

The ID of your AWS Key Management Service (AWS KMS) key. This ID is used to encrypt the data in your file system at rest. For more information, see [Encrypt] in the *AWS Key Management Service API Reference*.

[1]: docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html

Returns:

  • (String) 


402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/aws-sdk-fsx/types.rb', line 402

class CreateFileSystemRequest < Struct.new(
  :client_request_token,
  :file_system_type,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :kms_key_id,
  :windows_configuration,
  :lustre_configuration)
  include Aws::Structure
end

#lustre_configuration ⇒ Types::CreateFileSystemLustreConfiguration

The configuration object for Lustre file systems used in the ‘CreateFileSystem` operation.

Returns:



402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/aws-sdk-fsx/types.rb', line 402

class CreateFileSystemRequest < Struct.new(
  :client_request_token,
  :file_system_type,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :kms_key_id,
  :windows_configuration,
  :lustre_configuration)
  include Aws::Structure
end

#security_group_ids ⇒ Array<String>

A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces. This list isn’t returned in later describe requests.

Returns:

  • (Array<String>) 


402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/aws-sdk-fsx/types.rb', line 402

class CreateFileSystemRequest < Struct.new(
  :client_request_token,
  :file_system_type,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :kms_key_id,
  :windows_configuration,
  :lustre_configuration)
  include Aws::Structure
end

#storage_capacity ⇒ Integer

The storage capacity of the file system.

For Windows file systems, the storage capacity has a minimum of 300 GiB, and a maximum of 65,536 GiB.

For Lustre file systems, the storage capacity has a minimum of 3,600 GiB. Storage capacity is provisioned in increments of 3,600 GiB.

Returns:

  • (Integer) 


402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/aws-sdk-fsx/types.rb', line 402

class CreateFileSystemRequest < Struct.new(
  :client_request_token,
  :file_system_type,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :kms_key_id,
  :windows_configuration,
  :lustre_configuration)
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

A list of IDs for the subnets that the file system will be accessible from. File systems support only one subnet. The file server is also launched in that subnet’s Availability Zone.

Returns:

  • (Array<String>) 


402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/aws-sdk-fsx/types.rb', line 402

class CreateFileSystemRequest < Struct.new(
  :client_request_token,
  :file_system_type,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :kms_key_id,
  :windows_configuration,
  :lustre_configuration)
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags to be applied to the file system at file system creation. The key value of the ‘Name` tag appears in the console as the file system name.

Returns:



402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/aws-sdk-fsx/types.rb', line 402

class CreateFileSystemRequest < Struct.new(
  :client_request_token,
  :file_system_type,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :kms_key_id,
  :windows_configuration,
  :lustre_configuration)
  include Aws::Structure
end

#windows_configuration ⇒ Types::CreateFileSystemWindowsConfiguration

The configuration for this Microsoft Windows file system.

Returns:



402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/aws-sdk-fsx/types.rb', line 402

class CreateFileSystemRequest < Struct.new(
  :client_request_token,
  :file_system_type,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :kms_key_id,
  :windows_configuration,
  :lustre_configuration)
  include Aws::Structure
end