Package software.amazon.awscdk.services.fsx

Class CfnFileSystem

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.fsx.CfnFileSystem
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-31T18:44:11.856Z") @Stability(Stable) public class CfnFileSystem extends CfnResource implements IInspectable
A CloudFormation `AWS::FSx::FileSystem`.

The AWS::FSx::FileSystem resource is an Amazon FSx resource type that specifies an Amazon FSx file system. You can create any of the following supported file system types:

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

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.fsx.*;
 CfnFileSystem cfnFileSystem = CfnFileSystem.Builder.create(this, "MyCfnFileSystem")
         .fileSystemType("fileSystemType")
         .subnetIds(List.of("subnetIds"))
         // the properties below are optional
         .backupId("backupId")
         .fileSystemTypeVersion("fileSystemTypeVersion")
         .kmsKeyId("kmsKeyId")
         .lustreConfiguration(LustreConfigurationProperty.builder()
                 .autoImportPolicy("autoImportPolicy")
                 .automaticBackupRetentionDays(123)
                 .copyTagsToBackups(false)
                 .dailyAutomaticBackupStartTime("dailyAutomaticBackupStartTime")
                 .dataCompressionType("dataCompressionType")
                 .deploymentType("deploymentType")
                 .driveCacheType("driveCacheType")
                 .exportPath("exportPath")
                 .importedFileChunkSize(123)
                 .importPath("importPath")
                 .perUnitStorageThroughput(123)
                 .weeklyMaintenanceStartTime("weeklyMaintenanceStartTime")
                 .build())
         .ontapConfiguration(OntapConfigurationProperty.builder()
                 .deploymentType("deploymentType")
                 // the properties below are optional
                 .automaticBackupRetentionDays(123)
                 .dailyAutomaticBackupStartTime("dailyAutomaticBackupStartTime")
                 .diskIopsConfiguration(DiskIopsConfigurationProperty.builder()
                         .iops(123)
                         .mode("mode")
                         .build())
                 .endpointIpAddressRange("endpointIpAddressRange")
                 .fsxAdminPassword("fsxAdminPassword")
                 .preferredSubnetId("preferredSubnetId")
                 .routeTableIds(List.of("routeTableIds"))
                 .throughputCapacity(123)
                 .weeklyMaintenanceStartTime("weeklyMaintenanceStartTime")
                 .build())
         .openZfsConfiguration(OpenZFSConfigurationProperty.builder()
                 .deploymentType("deploymentType")
                 // the properties below are optional
                 .automaticBackupRetentionDays(123)
                 .copyTagsToBackups(false)
                 .copyTagsToVolumes(false)
                 .dailyAutomaticBackupStartTime("dailyAutomaticBackupStartTime")
                 .diskIopsConfiguration(DiskIopsConfigurationProperty.builder()
                         .iops(123)
                         .mode("mode")
                         .build())
                 .options(List.of("options"))
                 .rootVolumeConfiguration(RootVolumeConfigurationProperty.builder()
                         .copyTagsToSnapshots(false)
                         .dataCompressionType("dataCompressionType")
                         .nfsExports(List.of(NfsExportsProperty.builder()
                                 .clientConfigurations(List.of(ClientConfigurationsProperty.builder()
                                         .clients("clients")
                                         .options(List.of("options"))
                                         .build()))
                                 .build()))
                         .readOnly(false)
                         .recordSizeKiB(123)
                         .userAndGroupQuotas(List.of(UserAndGroupQuotasProperty.builder()
                                 .id(123)
                                 .storageCapacityQuotaGiB(123)
                                 .type("type")
                                 .build()))
                         .build())
                 .throughputCapacity(123)
                 .weeklyMaintenanceStartTime("weeklyMaintenanceStartTime")
                 .build())
         .securityGroupIds(List.of("securityGroupIds"))
         .storageCapacity(123)
         .storageType("storageType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .windowsConfiguration(WindowsConfigurationProperty.builder()
                 .throughputCapacity(123)
                 // the properties below are optional
                 .activeDirectoryId("activeDirectoryId")
                 .aliases(List.of("aliases"))
                 .auditLogConfiguration(AuditLogConfigurationProperty.builder()
                         .fileAccessAuditLogLevel("fileAccessAuditLogLevel")
                         .fileShareAccessAuditLogLevel("fileShareAccessAuditLogLevel")
                         // the properties below are optional
                         .auditLogDestination("auditLogDestination")
                         .build())
                 .automaticBackupRetentionDays(123)
                 .copyTagsToBackups(false)
                 .dailyAutomaticBackupStartTime("dailyAutomaticBackupStartTime")
                 .deploymentType("deploymentType")
                 .preferredSubnetId("preferredSubnetId")
                 .selfManagedActiveDirectoryConfiguration(SelfManagedActiveDirectoryConfigurationProperty.builder()
                         .dnsIps(List.of("dnsIps"))
                         .domainName("domainName")
                         .fileSystemAdministratorsGroup("fileSystemAdministratorsGroup")
                         .organizationalUnitDistinguishedName("organizationalUnitDistinguishedName")
                         .password("password")
                         .userName("userName")
                         .build())
                 .weeklyMaintenanceStartTime("weeklyMaintenanceStartTime")
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFileSystem

      protected CfnFileSystem(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFileSystem

      protected CfnFileSystem(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFileSystem

      @Stability(Stable) public CfnFileSystem(@NotNull Construct scope, @NotNull String id, @NotNull CfnFileSystemProps props)
      Create a new `AWS::FSx::FileSystem`.

      Parameters:
      scope - - scope in which this resource is defined. This parameter is required.
      id - - scoped id of the resource. This parameter is required.
      props - - resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDnsName

      @Stability(Stable) @NotNull public String getAttrDnsName()
      Returns the FSx for Windows file system's DNSName.

      Example: amznfsxp1honlek.corp.example.com

    • getAttrLustreMountName

      @Stability(Stable) @NotNull public String getAttrLustreMountName()
      Returns the Lustre file system's `LustreMountName` .

      Example for SCRATCH_1 deployment types: This value is always fsx .

      Example for SCRATCH_2 and PERSISTENT deployment types: 2p3fhbmv

    • getAttrResourceArn

      @Stability(Stable) @NotNull public String getAttrResourceArn()
      Returns the Amazon Resource Name (ARN) for the Amazon FSx file system.

      Example: arn:aws:fsx:us-east-2:111122223333:file-system/fs-0123abcd56789ef0a

    • getAttrRootVolumeId

      @Stability(Stable) @NotNull public String getAttrRootVolumeId()
      Returns the root volume ID of the FSx for OpenZFS file system.

      Example: fsvol-0123456789abcdefa

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getFileSystemType

      @Stability(Stable) @NotNull public String getFileSystemType()
      The type of Amazon FSx file system, which can be `LUSTRE` , `WINDOWS` , `ONTAP` , or `OPENZFS` .

    • setFileSystemType

      @Stability(Stable) public void setFileSystemType(@NotNull String value)
      The type of Amazon FSx file system, which can be `LUSTRE` , `WINDOWS` , `ONTAP` , or `OPENZFS` .

    • getSubnetIds

      @Stability(Stable) @NotNull public List<String> getSubnetIds()
      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.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@NotNull List<String> value)
      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.

    • getBackupId

      @Stability(Stable) @Nullable public String getBackupId()
      The ID of the file system backup that you are using to create a file system.

      For more information, see CreateFileSystemFromBackup .

    • setBackupId

      @Stability(Stable) public void setBackupId(@Nullable String value)
      The ID of the file system backup that you are using to create a file system.

      For more information, see CreateFileSystemFromBackup .

    • getFileSystemTypeVersion

      @Stability(Stable) @Nullable public String getFileSystemTypeVersion()
      (Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.

      Valid values are 2.10 and 2.12 :

      • 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
      • 2.12 is supported by all Lustre deployment types. 2.12 is required when setting FSx for Lustre DeploymentType to PERSISTENT_2 .

      Default value = 2.10 , except when DeploymentType is set to PERSISTENT_2 , then the default is 2.12 .

      If you set FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre deployment type, the CreateFileSystem operation fails.

    • setFileSystemTypeVersion

      @Stability(Stable) public void setFileSystemTypeVersion(@Nullable String value)
      (Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.

      Valid values are 2.10 and 2.12 :

      • 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
      • 2.12 is supported by all Lustre deployment types. 2.12 is required when setting FSx for Lustre DeploymentType to PERSISTENT_2 .

      Default value = 2.10 , except when DeploymentType is set to PERSISTENT_2 , then the default is 2.12 .

      If you set FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre deployment type, the CreateFileSystem operation fails.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The ID of the AWS Key Management Service ( AWS KMS ) 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 KMS key for your account.

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

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The ID of the AWS Key Management Service ( AWS KMS ) 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 KMS key for your account.

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

    • getLustreConfiguration

      @Stability(Stable) @Nullable public Object getLustreConfiguration()
      The Lustre configuration for the file system being created.

      The following parameters are not supported for file systems with the Lustre Persistent_2 deployment type.

      • AutoImportPolicy
      • ExportPath
      • ImportedChunkSize
      • ImportPath

    • setLustreConfiguration

      @Stability(Stable) public void setLustreConfiguration(@Nullable IResolvable value)
      The Lustre configuration for the file system being created.

      The following parameters are not supported for file systems with the Lustre Persistent_2 deployment type.

      • AutoImportPolicy
      • ExportPath
      • ImportedChunkSize
      • ImportPath

    • setLustreConfiguration

      @Stability(Stable) public void setLustreConfiguration(@Nullable CfnFileSystem.LustreConfigurationProperty value)
      The Lustre configuration for the file system being created.

      The following parameters are not supported for file systems with the Lustre Persistent_2 deployment type.

      • AutoImportPolicy
      • ExportPath
      • ImportedChunkSize
      • ImportPath

    • getOntapConfiguration

      @Stability(Stable) @Nullable public Object getOntapConfiguration()
      The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

    • setOntapConfiguration

      @Stability(Stable) public void setOntapConfiguration(@Nullable IResolvable value)
      The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

    • setOntapConfiguration

      @Stability(Stable) public void setOntapConfiguration(@Nullable CfnFileSystem.OntapConfigurationProperty value)
      The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

    • getOpenZfsConfiguration

      @Stability(Stable) @Nullable public Object getOpenZfsConfiguration()
      The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

    • setOpenZfsConfiguration

      @Stability(Stable) public void setOpenZfsConfiguration(@Nullable IResolvable value)
      The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

    • setOpenZfsConfiguration

      @Stability(Stable) public void setOpenZfsConfiguration(@Nullable CfnFileSystem.OpenZFSConfigurationProperty value)
      The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getSecurityGroupIds()
      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.

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      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.

    • getStorageCapacity

      @Stability(Stable) @Nullable public Number getStorageCapacity()
      Sets the storage capacity of the file system that you're creating.

      StorageCapacity is required if you are creating a new file system.

      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 is from 1024 GiB up to 196,608 GiB (192 TiB).

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

    • setStorageCapacity

      @Stability(Stable) public void setStorageCapacity(@Nullable Number value)
      Sets the storage capacity of the file system that you're creating.

      StorageCapacity is required if you are creating a new file system.

      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 is from 1024 GiB up to 196,608 GiB (192 TiB).

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

    • getStorageType

      @Stability(Stable) @Nullable public String getStorageType()
      Sets the storage type for the file system that you're creating. Valid values are `SSD` and `HDD` .

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

      Default value is SSD . For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide .

    • setStorageType

      @Stability(Stable) public void setStorageType(@Nullable String value)
      Sets the storage type for the file system that you're creating. Valid values are `SSD` and `HDD` .

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

      Default value is SSD . For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide .

    • getWindowsConfiguration

      @Stability(Stable) @Nullable public Object getWindowsConfiguration()
      The configuration object for the Microsoft Windows file system you are creating.

      This value is required if FileSystemType is set to WINDOWS .

    • setWindowsConfiguration

      @Stability(Stable) public void setWindowsConfiguration(@Nullable IResolvable value)
      The configuration object for the Microsoft Windows file system you are creating.

      This value is required if FileSystemType is set to WINDOWS .

    • setWindowsConfiguration

      @Stability(Stable) public void setWindowsConfiguration(@Nullable CfnFileSystem.WindowsConfigurationProperty value)
      The configuration object for the Microsoft Windows file system you are creating.

      This value is required if FileSystemType is set to WINDOWS .