Class: AWSCDK::FSX::CfnFileSystemProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
fsx/cfn_file_system_props.rb

Overview

Properties for defining a CfnFileSystem.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(file_system_type:, subnet_ids:, backup_id: nil, file_system_type_version: nil, kms_key_id: nil, lustre_configuration: nil, network_type: nil, ontap_configuration: nil, open_zfs_configuration: nil, security_group_ids: nil, storage_capacity: nil, storage_type: nil, tags: nil, windows_configuration: nil) ⇒ CfnFileSystemProps

Returns a new instance of CfnFileSystemProps.

Parameters:

  • file_system_type (String) —

    The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , ONTAP , or OPENZFS .

  • subnet_ids (Array<String>) —

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

  • backup_id (String, nil) (defaults to: nil) —

    The ID of the file system backup that you are using to create a file system.

  • file_system_type_version (String, nil) (defaults to: nil) —

    For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.

  • kms_key_id (String, nil) (defaults to: nil) —

    The ID of the AWS Key Management Service ( AWS ) key used to encrypt Amazon FSx file system data.

  • lustre_configuration (AWSCDK::IResolvable, AWSCDK::FSX::CfnFileSystem::LustreConfigurationProperty, nil) (defaults to: nil) —

    The Lustre configuration for the file system being created.

  • network_type (String, nil) (defaults to: nil) —

    The network type of the file system.

  • ontap_configuration (AWSCDK::IResolvable, AWSCDK::FSX::CfnFileSystem::OntapConfigurationProperty, nil) (defaults to: nil) —

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

  • open_zfs_configuration (AWSCDK::IResolvable, AWSCDK::FSX::CfnFileSystem::OpenZFSConfigurationProperty, nil) (defaults to: nil) —

    The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

  • security_group_ids (Array<String>, nil) (defaults to: nil) —

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

  • storage_capacity (Numeric, nil) (defaults to: nil) —

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

  • storage_type (String, nil) (defaults to: nil) —

    Sets the storage class for the file system that you're creating.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    The tags to associate with the file system.

  • windows_configuration (AWSCDK::IResolvable, AWSCDK::FSX::CfnFileSystem::WindowsConfigurationProperty, nil) (defaults to: nil) —

    The configuration object for the Microsoft Windows file system you are creating.



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'fsx/cfn_file_system_props.rb', line 23

def initialize(file_system_type:, subnet_ids:, backup_id: nil, file_system_type_version: nil, kms_key_id: nil, lustre_configuration: nil, network_type: nil, ontap_configuration: nil, open_zfs_configuration: nil, security_group_ids: nil, storage_capacity: nil, storage_type: nil, tags: nil, windows_configuration: nil)
  @file_system_type = file_system_type
  Jsii::Type.check_type(@file_system_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fileSystemType")
  @subnet_ids = subnet_ids
  Jsii::Type.check_type(@subnet_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "subnetIds")
  @backup_id = backup_id
  Jsii::Type.check_type(@backup_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "backupId") unless @backup_id.nil?
  @file_system_type_version = file_system_type_version
  Jsii::Type.check_type(@file_system_type_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fileSystemTypeVersion") unless @file_system_type_version.nil?
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless @kms_key_id.nil?
  @lustre_configuration = lustre_configuration.is_a?(Hash) ? ::AWSCDK::FSX::CfnFileSystem::LustreConfigurationProperty.new(**lustre_configuration.transform_keys(&:to_sym)) : lustre_configuration
  Jsii::Type.check_type(@lustre_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mc3guQ2ZuRmlsZVN5c3RlbS5MdXN0cmVDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "lustreConfiguration") unless @lustre_configuration.nil?
  @network_type = network_type
  Jsii::Type.check_type(@network_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "networkType") unless @network_type.nil?
  @ontap_configuration = ontap_configuration.is_a?(Hash) ? ::AWSCDK::FSX::CfnFileSystem::OntapConfigurationProperty.new(**ontap_configuration.transform_keys(&:to_sym)) : ontap_configuration
  Jsii::Type.check_type(@ontap_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mc3guQ2ZuRmlsZVN5c3RlbS5PbnRhcENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "ontapConfiguration") unless @ontap_configuration.nil?
  @open_zfs_configuration = open_zfs_configuration.is_a?(Hash) ? ::AWSCDK::FSX::CfnFileSystem::OpenZFSConfigurationProperty.new(**open_zfs_configuration.transform_keys(&:to_sym)) : open_zfs_configuration
  Jsii::Type.check_type(@open_zfs_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mc3guQ2ZuRmlsZVN5c3RlbS5PcGVuWkZTQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "openZfsConfiguration") unless @open_zfs_configuration.nil?
  @security_group_ids = security_group_ids
  Jsii::Type.check_type(@security_group_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroupIds") unless @security_group_ids.nil?
  @storage_capacity = storage_capacity
  Jsii::Type.check_type(@storage_capacity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "storageCapacity") unless @storage_capacity.nil?
  @storage_type = storage_type
  Jsii::Type.check_type(@storage_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "storageType") unless @storage_type.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @windows_configuration = windows_configuration.is_a?(Hash) ? ::AWSCDK::FSX::CfnFileSystem::WindowsConfigurationProperty.new(**windows_configuration.transform_keys(&:to_sym)) : windows_configuration
  Jsii::Type.check_type(@windows_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mc3guQ2ZuRmlsZVN5c3RlbS5XaW5kb3dzQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "windowsConfiguration") unless @windows_configuration.nil?
end

Instance Attribute Details

#backup_id ⇒ String? (readonly)

The ID of the file system backup that you are using to create a file system.

For more information, see CreateFileSystemFromBackup .

Returns:

  • (String, nil)

See Also:



74
75
76
 
# File 'fsx/cfn_file_system_props.rb', line 74

def backup_id
  @backup_id
end

#file_system_type ⇒ String (readonly)

The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , ONTAP , or OPENZFS .

Returns:

  • (String)

See Also:



58
59
60
 
# File 'fsx/cfn_file_system_props.rb', line 58

def file_system_type
  @file_system_type
end

#file_system_type_version ⇒ String? (readonly)

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, nil)

See Also:



90
91
92
 
# File 'fsx/cfn_file_system_props.rb', line 90

def file_system_type_version
  @file_system_type_version
end

#kms_key_id ⇒ String? (readonly)

The ID of the AWS Key Management Service ( AWS ) key used to encrypt Amazon FSx file system data.

Used as follows with Amazon FSx file system types:

  • 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 AWS key for your account.

  • Amazon FSx for NetApp ONTAP
  • Amazon FSx for OpenZFS
  • Amazon FSx for Windows File Server

If this ID isn't specified, the Amazon FSx-managed key for your account is used. For more information, see Encrypt in the AWS Key Management Service API Reference .

Returns:

  • (String, nil)

See Also:



107
108
109
 
# File 'fsx/cfn_file_system_props.rb', line 107

def kms_key_id
  @kms_key_id
end

#lustre_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The Lustre configuration for the file system being created.

This configuration is required if the FileSystemType is set to LUSTRE .

The following parameters are not supported when creating Lustre file systems with a data repository association.

  • AutoImportPolicy
  • ExportPath
  • ImportedChunkSize
  • ImportPath

Returns:

See Also:



121
122
123
 
# File 'fsx/cfn_file_system_props.rb', line 121

def lustre_configuration
  @lustre_configuration
end

#network_type ⇒ String? (readonly)

The network type of the file system.

Returns:

  • (String, nil)

See Also:



126
127
128
 
# File 'fsx/cfn_file_system_props.rb', line 126

def network_type
  @network_type
end

#ontap_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

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

This configuration is required if the FileSystemType is set to ONTAP .

Returns:

See Also:



133
134
135
 
# File 'fsx/cfn_file_system_props.rb', line 133

def ontap_configuration
  @ontap_configuration
end

#open_zfs_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

This configuration is required if the FileSystemType is set to OPENZFS .

Returns:

See Also:



140
141
142
 
# File 'fsx/cfn_file_system_props.rb', line 140

def open_zfs_configuration
  @open_zfs_configuration
end

#security_group_ids ⇒ Array<String>? (readonly)

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>, nil)

See Also:



149
150
151
 
# File 'fsx/cfn_file_system_props.rb', line 149

def security_group_ids
  @security_group_ids
end

#storage_capacity ⇒ Numeric? (readonly)

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

StorageCapacity is required if you are creating a new file system. It is not required if you are creating a file system by restoring a backup.

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 SSD storage capacity that you can configure depends on the value of the HAPairs property. The minimum value is calculated as 1,024 GiB * HAPairs and the maximum is calculated as 524,288 GiB * HAPairs, up to a maximum amount of SSD storage capacity of 1,048,576 GiB (1 pebibyte).

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). If you are creating a file system from a backup, you can specify a storage capacity equal to or greater than the original file system's storage capacity.

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:

  • (Numeric, nil)

See Also:



171
172
173
 
# File 'fsx/cfn_file_system_props.rb', line 171

def storage_capacity
  @storage_capacity
end

#storage_type ⇒ String? (readonly)

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, nil)

See Also:



184
185
186
 
# File 'fsx/cfn_file_system_props.rb', line 184

def storage_type
  @storage_type
end

#subnet_ids ⇒ Array<String> (readonly)

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

See Also:



67
68
69
 
# File 'fsx/cfn_file_system_props.rb', line 67

def subnet_ids
  @subnet_ids
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The tags to associate with the file system.

For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide .

Returns:

See Also:



191
192
193
 
# File 'fsx/cfn_file_system_props.rb', line 191

def tags
  @tags
end

#windows_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration object for the Microsoft Windows file system you are creating.

This configuration is required if FileSystemType is set to WINDOWS .

Returns:

See Also:



198
199
200
 
# File 'fsx/cfn_file_system_props.rb', line 198

def windows_configuration
  @windows_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'fsx/cfn_file_system_props.rb', line 200

def self.jsii_properties
  {
    :file_system_type => "fileSystemType",
    :subnet_ids => "subnetIds",
    :backup_id => "backupId",
    :file_system_type_version => "fileSystemTypeVersion",
    :kms_key_id => "kmsKeyId",
    :lustre_configuration => "lustreConfiguration",
    :network_type => "networkType",
    :ontap_configuration => "ontapConfiguration",
    :open_zfs_configuration => "openZfsConfiguration",
    :security_group_ids => "securityGroupIds",
    :storage_capacity => "storageCapacity",
    :storage_type => "storageType",
    :tags => "tags",
    :windows_configuration => "windowsConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'fsx/cfn_file_system_props.rb', line 219

def to_jsii
  result = {}
  result.merge!({
    "fileSystemType" => @file_system_type,
    "subnetIds" => @subnet_ids,
    "backupId" => @backup_id,
    "fileSystemTypeVersion" => @file_system_type_version,
    "kmsKeyId" => @kms_key_id,
    "lustreConfiguration" => @lustre_configuration,
    "networkType" => @network_type,
    "ontapConfiguration" => @ontap_configuration,
    "openZfsConfiguration" => @open_zfs_configuration,
    "securityGroupIds" => @security_group_ids,
    "storageCapacity" => @storage_capacity,
    "storageType" => @storage_type,
    "tags" => @tags,
    "windowsConfiguration" => @windows_configuration,
  })
  result.compact
end