software.amazon.awscdk.services.fsx

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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.717Z")
 @Stability(value=Stable)
public class CfnFileSystem
extends CfnResource
implements IInspectable

A CloudFormation `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.*;
 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnFileSystem.AuditLogConfigurationProperty Example:
static class	CfnFileSystem.Builder A fluent builder for CfnFileSystem.
static interface	CfnFileSystem.ClientConfigurationsProperty Example:
static interface	CfnFileSystem.DiskIopsConfigurationProperty Example:
static interface	CfnFileSystem.LustreConfigurationProperty Example:
static interface	CfnFileSystem.NfsExportsProperty Example:
static interface	CfnFileSystem.OntapConfigurationProperty Example:
static interface	CfnFileSystem.OpenZFSConfigurationProperty Example:
static interface	CfnFileSystem.RootVolumeConfigurationProperty Example:
static interface	CfnFileSystem.SelfManagedActiveDirectoryConfigurationProperty Example:
static interface	CfnFileSystem.UserAndGroupQuotasProperty Example:
static interface	CfnFileSystem.WindowsConfigurationProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFileSystem(software.constructs.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)

Method Summary

Modifier and Type	Method and Description
String	getAttrDnsName()
String	getAttrLustreMountName()
String	getAttrRootVolumeId()
String	getBackupId() `AWS::FSx::FileSystem.BackupId`.
protected Map<String,Object>	getCfnProperties()
String	getFileSystemType() `AWS::FSx::FileSystem.FileSystemType`.
String	getFileSystemTypeVersion() `AWS::FSx::FileSystem.FileSystemTypeVersion`.
String	getKmsKeyId() `AWS::FSx::FileSystem.KmsKeyId`.
Object	getLustreConfiguration() `AWS::FSx::FileSystem.LustreConfiguration`.
Object	getOntapConfiguration() `AWS::FSx::FileSystem.OntapConfiguration`.
Object	getOpenZfsConfiguration() `AWS::FSx::FileSystem.OpenZFSConfiguration`.
List<String>	getSecurityGroupIds() `AWS::FSx::FileSystem.SecurityGroupIds`.
Number	getStorageCapacity() `AWS::FSx::FileSystem.StorageCapacity`.
String	getStorageType() `AWS::FSx::FileSystem.StorageType`.
List<String>	getSubnetIds() `AWS::FSx::FileSystem.SubnetIds`.
TagManager	getTags() `AWS::FSx::FileSystem.Tags`.
Object	getWindowsConfiguration() `AWS::FSx::FileSystem.WindowsConfiguration`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBackupId(String value) `AWS::FSx::FileSystem.BackupId`.
void	setFileSystemType(String value) `AWS::FSx::FileSystem.FileSystemType`.
void	setFileSystemTypeVersion(String value) `AWS::FSx::FileSystem.FileSystemTypeVersion`.
void	setKmsKeyId(String value) `AWS::FSx::FileSystem.KmsKeyId`.
void	setLustreConfiguration(CfnFileSystem.LustreConfigurationProperty value) `AWS::FSx::FileSystem.LustreConfiguration`.
void	setLustreConfiguration(IResolvable value) `AWS::FSx::FileSystem.LustreConfiguration`.
void	setOntapConfiguration(CfnFileSystem.OntapConfigurationProperty value) `AWS::FSx::FileSystem.OntapConfiguration`.
void	setOntapConfiguration(IResolvable value) `AWS::FSx::FileSystem.OntapConfiguration`.
void	setOpenZfsConfiguration(CfnFileSystem.OpenZFSConfigurationProperty value) `AWS::FSx::FileSystem.OpenZFSConfiguration`.
void	setOpenZfsConfiguration(IResolvable value) `AWS::FSx::FileSystem.OpenZFSConfiguration`.
void	setSecurityGroupIds(List<String> value) `AWS::FSx::FileSystem.SecurityGroupIds`.
void	setStorageCapacity(Number value) `AWS::FSx::FileSystem.StorageCapacity`.
void	setStorageType(String value) `AWS::FSx::FileSystem.StorageType`.
void	setSubnetIds(List<String> value) `AWS::FSx::FileSystem.SubnetIds`.
void	setWindowsConfiguration(CfnFileSystem.WindowsConfigurationProperty value) `AWS::FSx::FileSystem.WindowsConfiguration`.
void	setWindowsConfiguration(IResolvable value) `AWS::FSx::FileSystem.WindowsConfiguration`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnFileSystem

protected CfnFileSystem(software.amazon.jsii.JsiiObjectRef objRef)

CfnFileSystem

protected CfnFileSystem(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnFileSystem

@Stability(value=Stable)
public CfnFileSystem(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnFileSystemProps props)

Create a new `AWS::FSx::FileSystem`.

Parameters:

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.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDnsName

@Stability(value=Stable)
 @NotNull
public String getAttrDnsName()

getAttrLustreMountName

@Stability(value=Stable)
 @NotNull
public String getAttrLustreMountName()

getAttrRootVolumeId

@Stability(value=Stable)
 @NotNull
public String getAttrRootVolumeId()

getBackupId

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

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

setBackupId

@Stability(value=Stable)
public void setBackupId(@Nullable
                                                 String value)

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFileSystemType

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

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

setFileSystemType

@Stability(value=Stable)
public void setFileSystemType(@NotNull
                                                       String value)

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

getFileSystemTypeVersion

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

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

setFileSystemTypeVersion

@Stability(value=Stable)
public void setFileSystemTypeVersion(@Nullable
                                                              String value)

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

getKmsKeyId

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

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

setKmsKeyId

@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)

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

getLustreConfiguration

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

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

setLustreConfiguration

@Stability(value=Stable)
public void setLustreConfiguration(@Nullable
                                                            CfnFileSystem.LustreConfigurationProperty value)

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

setLustreConfiguration

@Stability(value=Stable)
public void setLustreConfiguration(@Nullable
                                                            IResolvable value)

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

getOntapConfiguration

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

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

setOntapConfiguration

@Stability(value=Stable)
public void setOntapConfiguration(@Nullable
                                                           CfnFileSystem.OntapConfigurationProperty value)

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

setOntapConfiguration

@Stability(value=Stable)
public void setOntapConfiguration(@Nullable
                                                           IResolvable value)

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

getOpenZfsConfiguration

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

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

setOpenZfsConfiguration

@Stability(value=Stable)
public void setOpenZfsConfiguration(@Nullable
                                                             CfnFileSystem.OpenZFSConfigurationProperty value)

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

setOpenZfsConfiguration

@Stability(value=Stable)
public void setOpenZfsConfiguration(@Nullable
                                                             IResolvable value)

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

getSecurityGroupIds

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

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

setSecurityGroupIds

@Stability(value=Stable)
public void setSecurityGroupIds(@Nullable
                                                         List<String> value)

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

getStorageCapacity

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

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

setStorageCapacity

@Stability(value=Stable)
public void setStorageCapacity(@Nullable
                                                        Number value)

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

getStorageType

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

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

setStorageType

@Stability(value=Stable)
public void setStorageType(@Nullable
                                                    String value)

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

getSubnetIds

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

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

setSubnetIds

@Stability(value=Stable)
public void setSubnetIds(@NotNull
                                                  List<String> value)

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

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getWindowsConfiguration

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

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

setWindowsConfiguration

@Stability(value=Stable)
public void setWindowsConfiguration(@Nullable
                                                             CfnFileSystem.WindowsConfigurationProperty value)

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

setWindowsConfiguration

@Stability(value=Stable)
public void setWindowsConfiguration(@Nullable
                                                             IResolvable value)

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