interface CfnFileSystemProps

Language	Type name
.NET	`Amazon.CDK.AWS.FSx.CfnFileSystemProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsfsx#CfnFileSystemProps`
Java	`software.amazon.awscdk.services.fsx.CfnFileSystemProps`
Python	`aws_cdk.aws_fsx.CfnFileSystemProps`
TypeScript	`aws-cdk-lib` » `aws_fsx` » `CfnFileSystemProps`

Properties for defining a CfnFileSystem.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_fsx as fsx } from 'aws-cdk-lib';
const cfnFileSystemProps: fsx.CfnFileSystemProps = {
  fileSystemType: 'fileSystemType',
  subnetIds: ['subnetIds'],

  // the properties below are optional
  backupId: 'backupId',
  fileSystemTypeVersion: 'fileSystemTypeVersion',
  kmsKeyId: 'kmsKeyId',
  lustreConfiguration: {
    autoImportPolicy: 'autoImportPolicy',
    automaticBackupRetentionDays: 123,
    copyTagsToBackups: false,
    dailyAutomaticBackupStartTime: 'dailyAutomaticBackupStartTime',
    dataCompressionType: 'dataCompressionType',
    deploymentType: 'deploymentType',
    driveCacheType: 'driveCacheType',
    exportPath: 'exportPath',
    importedFileChunkSize: 123,
    importPath: 'importPath',
    metadataConfiguration: {
      iops: 123,
      mode: 'mode',
    },
    perUnitStorageThroughput: 123,
    weeklyMaintenanceStartTime: 'weeklyMaintenanceStartTime',
  },
  ontapConfiguration: {
    deploymentType: 'deploymentType',

    // the properties below are optional
    automaticBackupRetentionDays: 123,
    dailyAutomaticBackupStartTime: 'dailyAutomaticBackupStartTime',
    diskIopsConfiguration: {
      iops: 123,
      mode: 'mode',
    },
    endpointIpAddressRange: 'endpointIpAddressRange',
    fsxAdminPassword: 'fsxAdminPassword',
    haPairs: 123,
    preferredSubnetId: 'preferredSubnetId',
    routeTableIds: ['routeTableIds'],
    throughputCapacity: 123,
    throughputCapacityPerHaPair: 123,
    weeklyMaintenanceStartTime: 'weeklyMaintenanceStartTime',
  },
  openZfsConfiguration: {
    deploymentType: 'deploymentType',

    // the properties below are optional
    automaticBackupRetentionDays: 123,
    copyTagsToBackups: false,
    copyTagsToVolumes: false,
    dailyAutomaticBackupStartTime: 'dailyAutomaticBackupStartTime',
    diskIopsConfiguration: {
      iops: 123,
      mode: 'mode',
    },
    endpointIpAddressRange: 'endpointIpAddressRange',
    options: ['options'],
    preferredSubnetId: 'preferredSubnetId',
    rootVolumeConfiguration: {
      copyTagsToSnapshots: false,
      dataCompressionType: 'dataCompressionType',
      nfsExports: [{
        clientConfigurations: [{
          clients: 'clients',
          options: ['options'],
        }],
      }],
      readOnly: false,
      recordSizeKiB: 123,
      userAndGroupQuotas: [{
        id: 123,
        storageCapacityQuotaGiB: 123,
        type: 'type',
      }],
    },
    routeTableIds: ['routeTableIds'],
    throughputCapacity: 123,
    weeklyMaintenanceStartTime: 'weeklyMaintenanceStartTime',
  },
  securityGroupIds: ['securityGroupIds'],
  storageCapacity: 123,
  storageType: 'storageType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  windowsConfiguration: {
    throughputCapacity: 123,

    // the properties below are optional
    activeDirectoryId: 'activeDirectoryId',
    aliases: ['aliases'],
    auditLogConfiguration: {
      fileAccessAuditLogLevel: 'fileAccessAuditLogLevel',
      fileShareAccessAuditLogLevel: 'fileShareAccessAuditLogLevel',

      // the properties below are optional
      auditLogDestination: 'auditLogDestination',
    },
    automaticBackupRetentionDays: 123,
    copyTagsToBackups: false,
    dailyAutomaticBackupStartTime: 'dailyAutomaticBackupStartTime',
    deploymentType: 'deploymentType',
    diskIopsConfiguration: {
      iops: 123,
      mode: 'mode',
    },
    preferredSubnetId: 'preferredSubnetId',
    selfManagedActiveDirectoryConfiguration: {
      dnsIps: ['dnsIps'],
      domainName: 'domainName',
      fileSystemAdministratorsGroup: 'fileSystemAdministratorsGroup',
      organizationalUnitDistinguishedName: 'organizationalUnitDistinguishedName',
      password: 'password',
      userName: 'userName',
    },
    weeklyMaintenanceStartTime: 'weeklyMaintenanceStartTime',
  },
};

Properties

Name	Type	Description
fileSystemType	`string`	The type of Amazon FSx file system, which can be `LUSTRE` , `WINDOWS` , `ONTAP` , or `OPENZFS` .
subnetIds	`string[]`	Specifies the IDs of the subnets that the file system will be accessible from.
backupId?	`string`	The ID of the file system backup that you are using to create a file system.
fileSystemTypeVersion?	`string`	For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.
kmsKeyId?	`string`	The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt Amazon FSx file system data.
lustreConfiguration?	`IResolvable` `\|` `LustreConfigurationProperty`	The Lustre configuration for the file system being created.
ontapConfiguration?	`IResolvable` `\|` `OntapConfigurationProperty`	The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
openZfsConfiguration?	`IResolvable` `\|` `OpenZFSConfigurationProperty`	The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.
securityGroupIds?	`string[]`	A list of IDs specifying the security groups to apply to all network interfaces created for file system access.
storageCapacity?	`number`	Sets the storage capacity of the file system that you're creating.
storageType?	`string`	Sets the storage type for the file system that you're creating. Valid values are `SSD` and `HDD` .
tags?	`CfnTag[]`	The tags to associate with the file system.
windowsConfiguration?	`IResolvable` `\|` `WindowsConfigurationProperty`	The configuration object for the Microsoft Windows file system you are creating.

fileSystemType

Type: string

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

subnetIds

Type: string[]

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.

backupId?

Type: string (optional)

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

For more information, see CreateFileSystemFromBackup .

fileSystemTypeVersion?

Type: string (optional)

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.

kmsKeyId?

Type: string (optional)

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

lustreConfiguration?

Type: IResolvable | LustreConfigurationProperty (optional)

The Lustre configuration for the file system being created.

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

AutoImportPolicy

ExportPath

ImportedChunkSize

ImportPath

ontapConfiguration?

Type: IResolvable | OntapConfigurationProperty (optional)

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

openZfsConfiguration?

Type: IResolvable | OpenZFSConfigurationProperty (optional)

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

securityGroupIds?

Type: string[] (optional)

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.

storageCapacity?

Type: number (optional)

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

storageType?

Type: string (optional)

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 .

tags?

Type: CfnTag[] (optional)

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 .

windowsConfiguration?

Type: IResolvable | WindowsConfigurationProperty (optional)

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

This value is required if FileSystemType is set to WINDOWS .