Package software.amazon.awscdk.cfnpropertymixins.services.fsx

Class CfnFileSystemPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.fsx.CfnFileSystemPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:59.523Z")
@Stability(Stable)
public class CfnFileSystemPropsMixin
extends Mixin
implements software.constructs.IMixin

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
• 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.cfnpropertymixins.services.fsx.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnFileSystemPropsMixin cfnFileSystemPropsMixin = CfnFileSystemPropsMixin.Builder.create(CfnFileSystemMixinProps.builder()
         .backupId("backupId")
         .fileSystemType("fileSystemType")
         .fileSystemTypeVersion("fileSystemTypeVersion")
         .kmsKeyId("kmsKeyId")
         .lustreConfiguration(LustreConfigurationProperty.builder()
                 .autoImportPolicy("autoImportPolicy")
                 .automaticBackupRetentionDays(123)
                 .copyTagsToBackups(false)
                 .dailyAutomaticBackupStartTime("dailyAutomaticBackupStartTime")
                 .dataCompressionType("dataCompressionType")
                 .dataReadCacheConfiguration(DataReadCacheConfigurationProperty.builder()
                         .sizeGiB(123)
                         .sizingMode("sizingMode")
                         .build())
                 .deploymentType("deploymentType")
                 .driveCacheType("driveCacheType")
                 .efaEnabled(false)
                 .exportPath("exportPath")
                 .importedFileChunkSize(123)
                 .importPath("importPath")
                 .metadataConfiguration(MetadataConfigurationProperty.builder()
                         .iops(123)
                         .mode("mode")
                         .build())
                 .perUnitStorageThroughput(123)
                 .throughputCapacity(123)
                 .weeklyMaintenanceStartTime("weeklyMaintenanceStartTime")
                 .build())
         .networkType("networkType")
         .ontapConfiguration(OntapConfigurationProperty.builder()
                 .automaticBackupRetentionDays(123)
                 .dailyAutomaticBackupStartTime("dailyAutomaticBackupStartTime")
                 .deploymentType("deploymentType")
                 .diskIopsConfiguration(DiskIopsConfigurationProperty.builder()
                         .iops(123)
                         .mode("mode")
                         .build())
                 .endpointIpAddressRange("endpointIpAddressRange")
                 .endpointIpv6AddressRange("endpointIpv6AddressRange")
                 .fsxAdminPassword("fsxAdminPassword")
                 .haPairs(123)
                 .preferredSubnetId("preferredSubnetId")
                 .routeTableIds(List.of("routeTableIds"))
                 .throughputCapacity(123)
                 .throughputCapacityPerHaPair(123)
                 .weeklyMaintenanceStartTime("weeklyMaintenanceStartTime")
                 .build())
         .openZfsConfiguration(OpenZFSConfigurationProperty.builder()
                 .automaticBackupRetentionDays(123)
                 .copyTagsToBackups(false)
                 .copyTagsToVolumes(false)
                 .dailyAutomaticBackupStartTime("dailyAutomaticBackupStartTime")
                 .deploymentType("deploymentType")
                 .diskIopsConfiguration(DiskIopsConfigurationProperty.builder()
                         .iops(123)
                         .mode("mode")
                         .build())
                 .endpointIpAddressRange("endpointIpAddressRange")
                 .endpointIpv6AddressRange("endpointIpv6AddressRange")
                 .options(List.of("options"))
                 .preferredSubnetId("preferredSubnetId")
                 .readCacheConfiguration(ReadCacheConfigurationProperty.builder()
                         .sizeGiB(123)
                         .sizingMode("sizingMode")
                         .build())
                 .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())
                 .routeTableIds(List.of("routeTableIds"))
                 .throughputCapacity(123)
                 .weeklyMaintenanceStartTime("weeklyMaintenanceStartTime")
                 .build())
         .securityGroupIds(List.of("securityGroupIds"))
         .storageCapacity(123)
         .storageType("storageType")
         .subnetIds(List.of("subnetIds"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .windowsConfiguration(WindowsConfigurationProperty.builder()
                 .activeDirectoryId("activeDirectoryId")
                 .aliases(List.of("aliases"))
                 .auditLogConfiguration(AuditLogConfigurationProperty.builder()
                         .auditLogDestination("auditLogDestination")
                         .fileAccessAuditLogLevel("fileAccessAuditLogLevel")
                         .fileShareAccessAuditLogLevel("fileShareAccessAuditLogLevel")
                         .build())
                 .automaticBackupRetentionDays(123)
                 .copyTagsToBackups(false)
                 .dailyAutomaticBackupStartTime("dailyAutomaticBackupStartTime")
                 .deploymentType("deploymentType")
                 .diskIopsConfiguration(DiskIopsConfigurationProperty.builder()
                         .iops(123)
                         .mode("mode")
                         .build())
                 .preferredSubnetId("preferredSubnetId")
                 .selfManagedActiveDirectoryConfiguration(SelfManagedActiveDirectoryConfigurationProperty.builder()
                         .dnsIps(List.of("dnsIps"))
                         .domainJoinServiceAccountSecret("domainJoinServiceAccountSecret")
                         .domainName("domainName")
                         .fileSystemAdministratorsGroup("fileSystemAdministratorsGroup")
                         .organizationalUnitDistinguishedName("organizationalUnitDistinguishedName")
                         .password("password")
                         .userName("userName")
                         .build())
                 .throughputCapacity(123)
                 .weeklyMaintenanceStartTime("weeklyMaintenanceStartTime")
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnFileSystemPropsMixin.AuditLogConfigurationProperty	The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.
static final class	CfnFileSystemPropsMixin.Builder	A fluent builder for CfnFileSystemPropsMixin.
static interface	CfnFileSystemPropsMixin.ClientConfigurationsProperty	Specifies who can mount an OpenZFS file system and the options available while mounting the file system.
static interface	CfnFileSystemPropsMixin.DataReadCacheConfigurationProperty	The configuration for the optional provisioned SSD read cache on Amazon FSx for Lustre file systems that use the Intelligent-Tiering storage class.
static interface	CfnFileSystemPropsMixin.DiskIopsConfigurationProperty	The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system.
static interface	CfnFileSystemPropsMixin.LustreConfigurationProperty	The configuration for the Amazon FSx for Lustre file system.
static interface	CfnFileSystemPropsMixin.MetadataConfigurationProperty	The configuration that allows you to specify the performance of metadata operations for an FSx for Lustre file system.
static interface	CfnFileSystemPropsMixin.NfsExportsProperty	The configuration object for mounting a file system.
static interface	CfnFileSystemPropsMixin.OntapConfigurationProperty	The configuration for this Amazon FSx for NetApp ONTAP file system.
static interface	CfnFileSystemPropsMixin.OpenZFSConfigurationProperty	The OpenZFS configuration for the file system that's being created.
static interface	CfnFileSystemPropsMixin.ReadCacheConfigurationProperty	The configuration for the optional provisioned SSD read cache on Amazon FSx for OpenZFS file systems that use the Intelligent-Tiering storage class.
static interface	CfnFileSystemPropsMixin.RootVolumeConfigurationProperty	The configuration of an Amazon FSx for OpenZFS root volume.
static interface	CfnFileSystemPropsMixin.SelfManagedActiveDirectoryConfigurationProperty	The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory.
static interface	CfnFileSystemPropsMixin.UserAndGroupQuotasProperty	Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume.
static interface	CfnFileSystemPropsMixin.WindowsConfigurationProperty	The Microsoft Windows configuration for the file system that's being created.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnFileSystemPropsMixin(CfnFileSystemMixinProps props)	Create a mixin to apply properties to AWS::FSx::FileSystem.
	CfnFileSystemPropsMixin(CfnFileSystemMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::FSx::FileSystem.
protected	CfnFileSystemPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFileSystemPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnFileSystemMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnFileSystemPropsMixin

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

CfnFileSystemPropsMixin

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

CfnFileSystemPropsMixin

@Stability(Stable)
public CfnFileSystemPropsMixin(@NotNull
 CfnFileSystemMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::FSx::FileSystem.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnFileSystemPropsMixin

@Stability(Stable)
public CfnFileSystemPropsMixin(@NotNull
 CfnFileSystemMixinProps props)

Create a mixin to apply properties to AWS::FSx::FileSystem.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnFileSystemMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()