software.amazon.awscdk.services.fsx

Interface CfnFileSystemProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFileSystemProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.734Z")
 @Stability(value=Stable)
public interface CfnFileSystemProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::FSx::FileSystem`.

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

Modifier and Type	Method and Description
static CfnFileSystemProps.Builder	builder()
default String	getBackupId() `AWS::FSx::FileSystem.BackupId`.
String	getFileSystemType() `AWS::FSx::FileSystem.FileSystemType`.
default String	getFileSystemTypeVersion() `AWS::FSx::FileSystem.FileSystemTypeVersion`.
default String	getKmsKeyId() `AWS::FSx::FileSystem.KmsKeyId`.
default Object	getLustreConfiguration() `AWS::FSx::FileSystem.LustreConfiguration`.
default Object	getOntapConfiguration() `AWS::FSx::FileSystem.OntapConfiguration`.
default Object	getOpenZfsConfiguration() `AWS::FSx::FileSystem.OpenZFSConfiguration`.
default List<String>	getSecurityGroupIds() `AWS::FSx::FileSystem.SecurityGroupIds`.
default Number	getStorageCapacity() `AWS::FSx::FileSystem.StorageCapacity`.
default String	getStorageType() `AWS::FSx::FileSystem.StorageType`.
List<String>	getSubnetIds() `AWS::FSx::FileSystem.SubnetIds`.
default List<CfnTag>	getTags() `AWS::FSx::FileSystem.Tags`.
default Object	getWindowsConfiguration() `AWS::FSx::FileSystem.WindowsConfiguration`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBackupId

@Stability(value=Stable)
 @Nullable
default String getBackupId()

`AWS::FSx::FileSystem.BackupId`.

getFileSystemType

@Stability(value=Stable)
 @NotNull
String getFileSystemType()

`AWS::FSx::FileSystem.FileSystemType`.

getFileSystemTypeVersion

@Stability(value=Stable)
 @Nullable
default String getFileSystemTypeVersion()

`AWS::FSx::FileSystem.FileSystemTypeVersion`.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
default String getKmsKeyId()

`AWS::FSx::FileSystem.KmsKeyId`.

getLustreConfiguration

@Stability(value=Stable)
 @Nullable
default Object getLustreConfiguration()

`AWS::FSx::FileSystem.LustreConfiguration`.

getOntapConfiguration

@Stability(value=Stable)
 @Nullable
default Object getOntapConfiguration()

`AWS::FSx::FileSystem.OntapConfiguration`.

getOpenZfsConfiguration

@Stability(value=Stable)
 @Nullable
default Object getOpenZfsConfiguration()

`AWS::FSx::FileSystem.OpenZFSConfiguration`.

getSecurityGroupIds

@Stability(value=Stable)
 @Nullable
default List<String> getSecurityGroupIds()

`AWS::FSx::FileSystem.SecurityGroupIds`.

getStorageCapacity

@Stability(value=Stable)
 @Nullable
default Number getStorageCapacity()

`AWS::FSx::FileSystem.StorageCapacity`.

getStorageType

@Stability(value=Stable)
 @Nullable
default String getStorageType()

`AWS::FSx::FileSystem.StorageType`.

getSubnetIds

@Stability(value=Stable)
 @NotNull
List<String> getSubnetIds()

`AWS::FSx::FileSystem.SubnetIds`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::FSx::FileSystem.Tags`.

getWindowsConfiguration

@Stability(value=Stable)
 @Nullable
default Object getWindowsConfiguration()

`AWS::FSx::FileSystem.WindowsConfiguration`.

builder

@Stability(value=Stable)
static CfnFileSystemProps.Builder builder()

Returns:

a CfnFileSystemProps.Builder of CfnFileSystemProps