@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)", date="2022-01-04T15:39:09.262Z") @Stability(value=Stable) public class CfnFileSystem extends CfnResource implements IInspectable
The AWS::FSx::FileSystem resource is an Amazon FSx resource type that creates either an Amazon FSx for Windows File Server file system or an Amazon FSx for Lustre file system.
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())
.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)
.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 the file system and the options that can be used 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 FSx for 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.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$ProxyIConstruct.Jsii$Default| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnFileSystem(Construct scope,
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 |
|---|---|
String |
getAttrDnsName()
Use the DNSName value to access the DNS name of your Amazon FSx file system.
|
String |
getAttrLustreMountName()
Use the LustreMountName value when mounting an Amazon FSx for Lustre file system.
|
String |
getAttrRootVolumeId() |
String |
getBackupId()
The ID of the source backup.
|
protected Map<String,Object> |
getCfnProperties() |
String |
getFileSystemType()
The type of Amazon FSx file system, which can be `LUSTRE` , `WINDOWS` , `ONTAP` , or `OPENZFS` .
|
String |
getFileSystemTypeVersion()
(Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.
|
String |
getKmsKeyId()
The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and `PERSISTENT` Amazon FSx for Lustre file systems at rest.
|
Object |
getLustreConfiguration()
The Lustre configuration for the file system being created.
|
Object |
getOntapConfiguration()
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
|
Object |
getOpenZfsConfiguration()
The OpenZFS configuration properties for the file system that you are creating.
|
List<String> |
getSecurityGroupIds()
A list of IDs specifying the security groups to apply to all network interfaces created for file system access.
|
Number |
getStorageCapacity()
Sets the storage capacity of the file system that you're creating.
|
String |
getStorageType()
Sets the storage type for the file system that you're creating.
|
List<String> |
getSubnetIds()
Specifies the IDs of the subnets that the file system will be accessible from.
|
TagManager |
getTags()
The tags to associate with the file system.
|
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 Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setBackupId(String value)
The ID of the source backup.
|
void |
setFileSystemType(String value)
The type of Amazon FSx file system, which can be `LUSTRE` , `WINDOWS` , `ONTAP` , or `OPENZFS` .
|
void |
setFileSystemTypeVersion(String value)
(Optional) 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 the file system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and `PERSISTENT` Amazon FSx for Lustre file systems at rest.
|
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 OpenZFS configuration properties for the file system that you are creating.
|
void |
setOpenZfsConfiguration(IResolvable value)
The 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 |
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, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validatejsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnFileSystem(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnFileSystem(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnFileSystem(@NotNull
Construct scope,
@NotNull
String id,
@NotNull
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.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrDnsName()
The DNS name identifies the file system.
@Stability(value=Stable) @NotNull public String getAttrLustreMountName()
For SCRATCH_1 deployment types, this value is always "fsx". For SCRATCH_2 and PERSISTENT_1 deployment types, this value is a string that is unique within an AWS Region . For more information, see Mounting from an Amazon EC2 Instance .
@Stability(value=Stable) @NotNull public String getAttrRootVolumeId()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
For more information, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide .
@Stability(value=Stable) @NotNull public String getFileSystemType()
@Stability(value=Stable)
public void setFileSystemType(@NotNull
String value)
@Stability(value=Stable) @NotNull public List<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.
@Stability(value=Stable)
public void setSubnetIds(@NotNull
List<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.
@Stability(value=Stable) @Nullable public String getBackupId()
Specifies the backup that you are copying.
@Stability(value=Stable)
public void setBackupId(@Nullable
String value)
Specifies the backup that you are copying.
@Stability(value=Stable) @Nullable public 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
FileSystemTypeVersionto2.10for aPERSISTENT_2Lustre deployment type, theCreateFileSystemoperation fails.
@Stability(value=Stable)
public void setFileSystemTypeVersion(@Nullable
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
FileSystemTypeVersionto2.10for aPERSISTENT_2Lustre deployment type, theCreateFileSystemoperation fails.
@Stability(value=Stable) @Nullable public String getKmsKeyId()
If this ID isn't specified, the Amazon FSx-managed key for your account is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using the Amazon FSx-managed key for your account. For more information, see Encrypt in the AWS Key Management Service API Reference .
@Stability(value=Stable)
public void setKmsKeyId(@Nullable
String value)
If this ID isn't specified, the Amazon FSx-managed key for your account is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using the Amazon FSx-managed key for your account. For more information, see Encrypt in the AWS Key Management Service API Reference .
@Stability(value=Stable) @Nullable public Object getLustreConfiguration()
The following parameters are not supported for file systems with the
Persistent_2deployment type. Instead, useCreateDataRepositoryAssociationto create a data repository association to link your Lustre file system to a data repository.
AutoImportPolicyExportPathImportedChunkSizeImportPath
@Stability(value=Stable)
public void setLustreConfiguration(@Nullable
CfnFileSystem.LustreConfigurationProperty value)
The following parameters are not supported for file systems with the
Persistent_2deployment type. Instead, useCreateDataRepositoryAssociationto create a data repository association to link your Lustre file system to a data repository.
AutoImportPolicyExportPathImportedChunkSizeImportPath
@Stability(value=Stable)
public void setLustreConfiguration(@Nullable
IResolvable value)
The following parameters are not supported for file systems with the
Persistent_2deployment type. Instead, useCreateDataRepositoryAssociationto create a data repository association to link your Lustre file system to a data repository.
AutoImportPolicyExportPathImportedChunkSizeImportPath
@Stability(value=Stable) @Nullable public Object getOntapConfiguration()
@Stability(value=Stable)
public void setOntapConfiguration(@Nullable
CfnFileSystem.OntapConfigurationProperty value)
@Stability(value=Stable)
public void setOntapConfiguration(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Object getOpenZfsConfiguration()
@Stability(value=Stable)
public void setOpenZfsConfiguration(@Nullable
CfnFileSystem.OpenZFSConfigurationProperty value)
@Stability(value=Stable)
public void setOpenZfsConfiguration(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public List<String> getSecurityGroupIds()
This list isn't returned in later requests to describe the file system.
@Stability(value=Stable)
public void setSecurityGroupIds(@Nullable
List<String> value)
This list isn't returned in later requests to describe the file system.
@Stability(value=Stable) @Nullable public Number getStorageCapacity()
StorageCapacity is required if you are creating a new file system. Do not include StorageCapacity if you are creating a file system from a backup.
For Lustre file systems:
@Stability(value=Stable)
public void setStorageCapacity(@Nullable
Number value)
StorageCapacity is required if you are creating a new file system. Do not include StorageCapacity if you are creating a file system from a backup.
For Lustre file systems:
@Stability(value=Stable) @Nullable public 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 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 .
@Stability(value=Stable)
public void setStorageType(@Nullable
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 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 .
@Stability(value=Stable) @Nullable public Object getWindowsConfiguration()
This value is required if FileSystemType is set to WINDOWS .
@Stability(value=Stable)
public void setWindowsConfiguration(@Nullable
CfnFileSystem.WindowsConfigurationProperty value)
This value is required if FileSystemType is set to WINDOWS .
@Stability(value=Stable)
public void setWindowsConfiguration(@Nullable
IResolvable value)
This value is required if FileSystemType is set to WINDOWS .
Copyright © 2022. All rights reserved.