CfnFileSystemProps (software.amazon.awscdk:monocdk 1.138.0.DEVPREVIEW API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnFileSystemProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:09.297Z")
 @Stability(value=Stable)
public interface CfnFileSystemProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.fsx.*;
 CfnFileSystemProps cfnFileSystemProps = CfnFileSystemProps.builder()
         .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();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnFileSystemProps.Builder` A builder for `CfnFileSystemProps`
`static class`	`CfnFileSystemProps.Jsii$Proxy` An implementation for `CfnFileSystemProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnFileSystemProps.Builder`	`builder()`
`default String`	`getBackupId()` The ID of the source backup.
`String`	`getFileSystemType()` The type of Amazon FSx file system, which can be `LUSTRE` , `WINDOWS` , `ONTAP` , or `OPENZFS` .
`default String`	`getFileSystemTypeVersion()` (Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.
`default 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.
`default Object`	`getLustreConfiguration()` The Lustre configuration for the file system being created.
`default Object`	`getOntapConfiguration()` The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
`default Object`	`getOpenZfsConfiguration()` The OpenZFS configuration properties for the file system that you are creating.
`default List<String>`	`getSecurityGroupIds()` A list of IDs specifying the security groups to apply to all network interfaces created for file system access.
`default Number`	`getStorageCapacity()` Sets the storage capacity of the file system that you're creating.
`default 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.
`default List<CfnTag>`	`getTags()` The tags to associate with the file system.
`default Object`	`getWindowsConfiguration()` The configuration object for the Microsoft Windows file system you are creating.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getFileSystemType
```
@Stability(value=Stable)
 @NotNull
String getFileSystemType()
```
    The type of Amazon FSx file system, which can be `LUSTRE` , `WINDOWS` , `ONTAP` , or `OPENZFS` .
  - getSubnetIds
```
@Stability(value=Stable)
 @NotNull
List<String> getSubnetIds()
```
    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.
  - getBackupId
```
@Stability(value=Stable)
 @Nullable
default String getBackupId()
```
    The ID of the source backup.
    Specifies the backup that you are copying.
  - getFileSystemTypeVersion
```
@Stability(value=Stable)
 @Nullable
default String getFileSystemTypeVersion()
```
    (Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.
    Valid values are 2.10 and 2.12 :
    - 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
    - 2.12 is supported by all Lustre deployment types. 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 to 2.10 for a PERSISTENT_2 Lustre deployment type, the CreateFileSystem operation fails.
  - getKmsKeyId
```
@Stability(value=Stable)
 @Nullable
default 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.
    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 .
  - getLustreConfiguration
```
@Stability(value=Stable)
 @Nullable
default Object getLustreConfiguration()
```
    The Lustre configuration for the file system being created.
    The following parameters are not supported for file systems with the Persistent_2 deployment type. Instead, use CreateDataRepositoryAssociation to create a data repository association to link your Lustre file system to a data repository.
    
    AutoImportPolicy
    
    ExportPath
    
    ImportedChunkSize
    
    ImportPath
  - getOntapConfiguration
```
@Stability(value=Stable)
 @Nullable
default Object getOntapConfiguration()
```
    The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
  - getOpenZfsConfiguration
```
@Stability(value=Stable)
 @Nullable
default Object getOpenZfsConfiguration()
```
    The OpenZFS configuration properties for the file system that you are creating.
  - getSecurityGroupIds
```
@Stability(value=Stable)
 @Nullable
default List<String> getSecurityGroupIds()
```
    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.
  - getStorageCapacity
```
@Stability(value=Stable)
 @Nullable
default Number getStorageCapacity()
```
    Sets the storage capacity of the file system that you're creating.
    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:
  - getStorageType
```
@Stability(value=Stable)
 @Nullable
default String getStorageType()
```
    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 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 .
  - getTags
```
@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()
```
    The tags to associate with the file system.
    For more information, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide .
  - getWindowsConfiguration
```
@Stability(value=Stable)
 @Nullable
default Object getWindowsConfiguration()
```
    The configuration object for the Microsoft Windows file system you are creating.
    This value is required if FileSystemType is set to WINDOWS .
  - builder
```
@Stability(value=Stable)
static CfnFileSystemProps.Builder builder()
```
    Returns:
    
    a CfnFileSystemProps.Builder of CfnFileSystemProps

Interface CfnFileSystemProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getFileSystemType

getSubnetIds

getBackupId

getFileSystemTypeVersion

getKmsKeyId

getLustreConfiguration

getOntapConfiguration

getOpenZfsConfiguration

getSecurityGroupIds

getStorageCapacity

getStorageType

getTags

getWindowsConfiguration

builder