Class CfnFileSystem
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.fsx.CfnFileSystem
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-10-31T19:12:58.722Z")
@Stability(Stable)
public class CfnFileSystem
extends CfnResource
implements IInspectable, ITaggable
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.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") .metadataConfiguration(MetadataConfigurationProperty.builder() .iops(123) .mode("mode") .build()) .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") .haPairs(123) .preferredSubnetId("preferredSubnetId") .routeTableIds(List.of("routeTableIds")) .throughputCapacity(123) .throughputCapacityPerHaPair(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()) .endpointIpAddressRange("endpointIpAddressRange") .options(List.of("options")) .preferredSubnetId("preferredSubnetId") .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") .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") .diskIopsConfiguration(DiskIopsConfigurationProperty.builder() .iops(123) .mode("mode") .build()) .preferredSubnetId("preferredSubnetId") .selfManagedActiveDirectoryConfiguration(SelfManagedActiveDirectoryConfigurationProperty.builder() .dnsIps(List.of("dnsIps")) .domainName("domainName") .fileSystemAdministratorsGroup("fileSystemAdministratorsGroup") .organizationalUnitDistinguishedName("organizationalUnitDistinguishedName") .password("password") .userName("userName") .build()) .weeklyMaintenanceStartTime("weeklyMaintenanceStartTime") .build()) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
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
A fluent builder forCfnFileSystem
.static interface
Specifies who can mount an OpenZFS file system and the options available while mounting the file system.static interface
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
The configuration for the Amazon FSx for Lustre file system.static interface
Example:static interface
The configuration object for mounting a file system.static interface
The configuration for this Amazon FSx for NetApp ONTAP file system.static interface
The OpenZFS configuration for the file system that's being created.static interface
The configuration of an Amazon FSx for OpenZFS root volume.static interface
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
Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume.static interface
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.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnFileSystem
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnFileSystem
(software.amazon.jsii.JsiiObjectRef objRef) CfnFileSystem
(software.constructs.Construct scope, String id, CfnFileSystemProps props) -
Method Summary
Modifier and TypeMethodDescriptionReturns the FSx for Windows file system's DNSName.Returns the Lustre file system'sLustreMountName
.Returns the Amazon Resource Name (ARN) for the Amazon FSx file system.Returns the root volume ID of the FSx for OpenZFS file system.The ID of the file system backup that you are using to create a file system.The type of Amazon FSx file system, which can beLUSTRE
,WINDOWS
,ONTAP
, orOPENZFS
.For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt Amazon FSx file system data.The Lustre configuration for the file system being created.The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.A list of IDs specifying the security groups to apply to all network interfaces created for file system access.Sets the storage capacity of the file system that you're creating.Sets the storage type for the file system that you're creating.Specifies the IDs of the subnets that the file system will be accessible from.getTags()
Tag Manager which manages the tags for this resource.The tags to associate with the file system.The configuration object for the Microsoft Windows file system you are creating.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setBackupId
(String value) The ID of the file system backup that you are using to create a file system.void
setFileSystemType
(String value) The type of Amazon FSx file system, which can beLUSTRE
,WINDOWS
,ONTAP
, orOPENZFS
.void
setFileSystemTypeVersion
(String value) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.void
setKmsKeyId
(String value) The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt Amazon FSx file system data.void
The Lustre configuration for the file system being created.void
The Lustre configuration for the file system being created.void
setOntapConfiguration
(IResolvable value) The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.void
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.void
The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.void
The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.void
setSecurityGroupIds
(List<String> value) A list of IDs specifying the security groups to apply to all network interfaces created for file system access.void
setStorageCapacity
(Number value) Sets the storage capacity of the file system that you're creating.void
setStorageType
(String value) Sets the storage type for the file system that you're creating.void
setSubnetIds
(List<String> value) Specifies the IDs of the subnets that the file system will be accessible from.void
setTagsRaw
(List<CfnTag> value) The tags to associate with the file system.void
The configuration object for the Microsoft Windows file system you are creating.void
The configuration object for the Microsoft Windows file system you are creating.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
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, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnFileSystemProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrDnsName
Returns the FSx for Windows file system's DNSName.Example:
amznfsxp1honlek.corp.example.com
-
getAttrId
-
getAttrLustreMountName
Returns the Lustre file system'sLustreMountName
.Example for
SCRATCH_1
deployment types: This value is alwaysfsx
.Example for
SCRATCH_2
andPERSISTENT
deployment types:2p3fhbmv
-
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
Returns the root volume ID of the FSx for OpenZFS file system.Example:
fsvol-0123456789abcdefa
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getFileSystemType
The type of Amazon FSx file system, which can beLUSTRE
,WINDOWS
,ONTAP
, orOPENZFS
. -
setFileSystemType
The type of Amazon FSx file system, which can beLUSTRE
,WINDOWS
,ONTAP
, orOPENZFS
. -
getSubnetIds
Specifies the IDs of the subnets that the file system will be accessible from. -
setSubnetIds
Specifies the IDs of the subnets that the file system will be accessible from. -
getBackupId
The ID of the file system backup that you are using to create a file system. -
setBackupId
The ID of the file system backup that you are using to create a file system. -
getFileSystemTypeVersion
For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. -
setFileSystemTypeVersion
For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. -
getKmsKeyId
The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt Amazon FSx file system data. -
setKmsKeyId
The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt Amazon FSx file system data. -
getLustreConfiguration
The Lustre configuration for the file system being created. -
setLustreConfiguration
The Lustre configuration for the file system being created. -
setLustreConfiguration
@Stability(Stable) public void setLustreConfiguration(@Nullable CfnFileSystem.LustreConfigurationProperty value) The Lustre configuration for the file system being created. -
getOntapConfiguration
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating. -
setOntapConfiguration
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
The Amazon FSx for OpenZFS configuration properties for the file system that you are creating. -
setOpenZfsConfiguration
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
A list of IDs specifying the security groups to apply to all network interfaces created for file system access. -
setSecurityGroupIds
A list of IDs specifying the security groups to apply to all network interfaces created for file system access. -
getStorageCapacity
Sets the storage capacity of the file system that you're creating. -
setStorageCapacity
Sets the storage capacity of the file system that you're creating. -
getStorageType
Sets the storage type for the file system that you're creating.Valid values are
SSD
andHDD
. -
setStorageType
Sets the storage type for the file system that you're creating.Valid values are
SSD
andHDD
. -
getTagsRaw
The tags to associate with the file system. -
setTagsRaw
The tags to associate with the file system. -
getWindowsConfiguration
The configuration object for the Microsoft Windows file system you are creating. -
setWindowsConfiguration
The configuration object for the Microsoft Windows file system you are creating. -
setWindowsConfiguration
@Stability(Stable) public void setWindowsConfiguration(@Nullable CfnFileSystem.WindowsConfigurationProperty value) The configuration object for the Microsoft Windows file system you are creating.
-