@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:54.077Z") public class CfnFileSystem extends CfnResource implements IInspectable
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:
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();
Modifier and Type | Class and Description |
---|---|
static interface |
CfnFileSystem.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 class |
CfnFileSystem.Builder
A fluent builder for
CfnFileSystem . |
static interface |
CfnFileSystem.ClientConfigurationsProperty
Specifies who can mount an OpenZFS file system and the options available while mounting the file system.
|
static interface |
CfnFileSystem.DiskIopsConfigurationProperty
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS file system.
|
static interface |
CfnFileSystem.LustreConfigurationProperty
The configuration for the Amazon FSx for Lustre file system.
|
static interface |
CfnFileSystem.NfsExportsProperty
The configuration object for mounting a file system.
|
static interface |
CfnFileSystem.OntapConfigurationProperty
The configuration for this Amazon FSx for NetApp ONTAP file system.
|
static interface |
CfnFileSystem.OpenZFSConfigurationProperty
The OpenZFS configuration for the file system that's being created.
|
static interface |
CfnFileSystem.RootVolumeConfigurationProperty
The configuration of an Amazon FSx for OpenZFS root volume.
|
static interface |
CfnFileSystem.SelfManagedActiveDirectoryConfigurationProperty
The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory.
|
static interface |
CfnFileSystem.UserAndGroupQuotasProperty
The configuration for how much storage a user or group can use on the volume.
|
static interface |
CfnFileSystem.WindowsConfigurationProperty
The Microsoft Windows configuration for the file system that's being created.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnFileSystem(Construct scope,
java.lang.String id,
CfnFileSystemProps props)
Create a new `AWS::FSx::FileSystem`.
|
protected |
CfnFileSystem(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnFileSystem(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrDnsName()
Returns the FSx for Windows file system's DNSName.
|
java.lang.String |
getAttrLustreMountName()
Returns the Lustre file system's `LustreMountName` .
|
java.lang.String |
getAttrResourceArn()
Returns the Amazon Resource Name (ARN) for the Amazon FSx file system.
|
java.lang.String |
getAttrRootVolumeId()
Returns the root volume ID of the FSx for OpenZFS file system.
|
java.lang.String |
getBackupId()
The ID of the file system backup that you are using to create a file system.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getFileSystemType()
The type of Amazon FSx file system, which can be `LUSTRE` , `WINDOWS` , `ONTAP` , or `OPENZFS` .
|
java.lang.String |
getFileSystemTypeVersion()
(Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.
|
java.lang.String |
getKmsKeyId()
The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt Amazon FSx file system data.
|
java.lang.Object |
getLustreConfiguration()
The Lustre configuration for the file system being created.
|
java.lang.Object |
getOntapConfiguration()
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
|
java.lang.Object |
getOpenZfsConfiguration()
The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.
|
java.util.List<java.lang.String> |
getSecurityGroupIds()
A list of IDs specifying the security groups to apply to all network interfaces created for file system access.
|
java.lang.Number |
getStorageCapacity()
Sets the storage capacity of the file system that you're creating.
|
java.lang.String |
getStorageType()
Sets the storage type for the file system that you're creating.
|
java.util.List<java.lang.String> |
getSubnetIds()
Specifies the IDs of the subnets that the file system will be accessible from.
|
TagManager |
getTags()
An array of key-value pairs to apply to this resource.
|
java.lang.Object |
getWindowsConfiguration()
The configuration object for the Microsoft Windows file system you are creating.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setBackupId(java.lang.String value)
The ID of the file system backup that you are using to create a file system.
|
void |
setFileSystemType(java.lang.String value)
The type of Amazon FSx file system, which can be `LUSTRE` , `WINDOWS` , `ONTAP` , or `OPENZFS` .
|
void |
setFileSystemTypeVersion(java.lang.String value)
(Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.
|
void |
setKmsKeyId(java.lang.String value)
The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt Amazon FSx file system data.
|
void |
setLustreConfiguration(CfnFileSystem.LustreConfigurationProperty value)
The Lustre configuration for the file system being created.
|
void |
setLustreConfiguration(IResolvable value)
The Lustre configuration for the file system being created.
|
void |
setOntapConfiguration(CfnFileSystem.OntapConfigurationProperty value)
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
|
void |
setOntapConfiguration(IResolvable value)
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
|
void |
setOpenZfsConfiguration(CfnFileSystem.OpenZFSConfigurationProperty value)
The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.
|
void |
setOpenZfsConfiguration(IResolvable value)
The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.
|
void |
setSecurityGroupIds(java.util.List<java.lang.String> value)
A list of IDs specifying the security groups to apply to all network interfaces created for file system access.
|
void |
setStorageCapacity(java.lang.Number value)
Sets the storage capacity of the file system that you're creating.
|
void |
setStorageType(java.lang.String value)
Sets the storage type for the file system that you're creating.
|
void |
setSubnetIds(java.util.List<java.lang.String> value)
Specifies the IDs of the subnets that the file system will be accessible from.
|
void |
setWindowsConfiguration(CfnFileSystem.WindowsConfigurationProperty value)
The configuration object for the Microsoft Windows file system you are creating.
|
void |
setWindowsConfiguration(IResolvable value)
The configuration object for the Microsoft Windows file system you are creating.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnFileSystem(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnFileSystem(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnFileSystem(Construct scope, java.lang.String id, CfnFileSystemProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrDnsName()
Example: amznfsxp1honlek.corp.example.com
public java.lang.String getAttrLustreMountName()
Example for SCRATCH_1
deployment types: This value is always fsx
.
Example for SCRATCH_2
and PERSISTENT
deployment types: 2p3fhbmv
public java.lang.String getAttrResourceArn()
Example: arn:aws:fsx:us-east-2:111122223333:file-system/fs-0123abcd56789ef0a
public java.lang.String getAttrRootVolumeId()
Example: fsvol-0123456789abcdefa
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.String getFileSystemType()
public void setFileSystemType(java.lang.String value)
public java.util.List<java.lang.String> getSubnetIds()
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.
public void setSubnetIds(java.util.List<java.lang.String> value)
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.
public java.lang.String getBackupId()
For more information, see CreateFileSystemFromBackup .
public void setBackupId(java.lang.String value)
For more information, see CreateFileSystemFromBackup .
public java.lang.String getFileSystemTypeVersion()
Valid values are 2.10
and 2.12
:
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
to2.10
for aPERSISTENT_2
Lustre deployment type, theCreateFileSystem
operation fails.
public void setFileSystemTypeVersion(java.lang.String value)
Valid values are 2.10
and 2.12
:
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
to2.10
for aPERSISTENT_2
Lustre deployment type, theCreateFileSystem
operation fails.
public java.lang.String getKmsKeyId()
Used as follows with Amazon FSx file system types:
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.
public void setKmsKeyId(java.lang.String value)
Used as follows with Amazon FSx file system types:
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.
public java.lang.Object getLustreConfiguration()
The following parameters are not supported for file systems with the Lustre
Persistent_2
deployment type.
AutoImportPolicy
ExportPath
ImportedChunkSize
ImportPath
public void setLustreConfiguration(IResolvable value)
The following parameters are not supported for file systems with the Lustre
Persistent_2
deployment type.
AutoImportPolicy
ExportPath
ImportedChunkSize
ImportPath
public void setLustreConfiguration(CfnFileSystem.LustreConfigurationProperty value)
The following parameters are not supported for file systems with the Lustre
Persistent_2
deployment type.
AutoImportPolicy
ExportPath
ImportedChunkSize
ImportPath
public java.lang.Object getOntapConfiguration()
public void setOntapConfiguration(IResolvable value)
public void setOntapConfiguration(CfnFileSystem.OntapConfigurationProperty value)
public java.lang.Object getOpenZfsConfiguration()
public void setOpenZfsConfiguration(IResolvable value)
public void setOpenZfsConfiguration(CfnFileSystem.OpenZFSConfigurationProperty value)
public java.util.List<java.lang.String> getSecurityGroupIds()
This list isn't returned in later requests to describe the file system.
public void setSecurityGroupIds(java.util.List<java.lang.String> value)
This list isn't returned in later requests to describe the file system.
public java.lang.Number getStorageCapacity()
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:
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.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.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:
public void setStorageCapacity(java.lang.Number value)
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:
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.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.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:
public java.lang.String getStorageType()
SSD
to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types.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 .
public void setStorageType(java.lang.String value)
SSD
to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types.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 .
public java.lang.Object getWindowsConfiguration()
This value is required if FileSystemType
is set to WINDOWS
.
public void setWindowsConfiguration(IResolvable value)
This value is required if FileSystemType
is set to WINDOWS
.
public void setWindowsConfiguration(CfnFileSystem.WindowsConfigurationProperty value)
This value is required if FileSystemType
is set to WINDOWS
.