Package software.amazon.awscdk.services.efs

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.efs.CfnFileSystem
All Implemented Interfaces:
IInspectable, ITaggable, IFileSystemRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:39.430Z") @Stability(Stable) public class CfnFileSystem extends CfnResource implements IInspectable, IFileSystemRef, ITaggable
The AWS::EFS::FileSystem resource creates a new, empty file system in Amazon Elastic File System ( Amazon EFS ).

You must create a mount target ( AWS::EFS::MountTarget ) to mount your EFS file system on an Amazon EC2 or other AWS cloud compute resource.

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.efs.*;
 Object fileSystemPolicy;
 CfnFileSystem cfnFileSystem = CfnFileSystem.Builder.create(this, "MyCfnFileSystem")
         .availabilityZoneName("availabilityZoneName")
         .backupPolicy(BackupPolicyProperty.builder()
                 .status("status")
                 .build())
         .bypassPolicyLockoutSafetyCheck(false)
         .encrypted(false)
         .fileSystemPolicy(fileSystemPolicy)
         .fileSystemProtection(FileSystemProtectionProperty.builder()
                 .replicationOverwriteProtection("replicationOverwriteProtection")
                 .build())
         .fileSystemTags(List.of(ElasticFileSystemTagProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .kmsKeyId("kmsKeyId")
         .lifecyclePolicies(List.of(LifecyclePolicyProperty.builder()
                 .transitionToArchive("transitionToArchive")
                 .transitionToIa("transitionToIa")
                 .transitionToPrimaryStorageClass("transitionToPrimaryStorageClass")
                 .build()))
         .performanceMode("performanceMode")
         .provisionedThroughputInMibps(123)
         .replicationConfiguration(ReplicationConfigurationProperty.builder()
                 .destinations(List.of(ReplicationDestinationProperty.builder()
                         .availabilityZoneName("availabilityZoneName")
                         .fileSystemId("fileSystemId")
                         .kmsKeyId("kmsKeyId")
                         .region("region")
                         .roleArn("roleArn")
                         .status("status")
                         .statusMessage("statusMessage")
                         .build()))
                 .build())
         .throughputMode("throughputMode")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFileSystem

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

    • CfnFileSystem

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

    • CfnFileSystem

      @Stability(Stable) public CfnFileSystem(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnFileSystemProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnFileSystem

      @Stability(Stable) public CfnFileSystem(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • fromFileSystemArn

      @Stability(Stable) @NotNull public static IFileSystemRef fromFileSystemArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IFileSystemRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromFileSystemId

      @Stability(Stable) @NotNull public static IFileSystemRef fromFileSystemId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String fileSystemId)
      Creates a new IFileSystemRef from a fileSystemId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      fileSystemId - This parameter is required.

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the EFS file system.

      Example: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-0123456789abcdef8

    • getAttrFileSystemId

      @Stability(Stable) @NotNull public String getAttrFileSystemId()
      The ID of the EFS file system.

      For example: fs-abcdef0123456789a

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getFileSystemRef

      @Stability(Stable) @NotNull public FileSystemReference getFileSystemRef()
      A reference to a FileSystem resource.
      Specified by:
      getFileSystemRef in interface IFileSystemRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAvailabilityZoneName

      @Stability(Stable) @Nullable public String getAvailabilityZoneName()
      For One Zone file systems, specify the AWS Availability Zone in which to create the file system.

    • setAvailabilityZoneName

      @Stability(Stable) public void setAvailabilityZoneName(@Nullable String value)
      For One Zone file systems, specify the AWS Availability Zone in which to create the file system.

    • getBackupPolicy

      @Stability(Stable) @Nullable public Object getBackupPolicy()
      Use the BackupPolicy to turn automatic backups on or off for the file system.

      Returns union: either IResolvable or CfnFileSystem.BackupPolicyProperty

    • setBackupPolicy

      @Stability(Stable) public void setBackupPolicy(@Nullable IResolvable value)
      Use the BackupPolicy to turn automatic backups on or off for the file system.

    • setBackupPolicy

      @Stability(Stable) public void setBackupPolicy(@Nullable CfnFileSystem.BackupPolicyProperty value)
      Use the BackupPolicy to turn automatic backups on or off for the file system.

    • getBypassPolicyLockoutSafetyCheck

      @Stability(Stable) @Nullable public Object getBypassPolicyLockoutSafetyCheck()
      (Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check.

      Returns union: either Boolean or IResolvable

    • setBypassPolicyLockoutSafetyCheck

      @Stability(Stable) public void setBypassPolicyLockoutSafetyCheck(@Nullable Boolean value)
      (Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check.

    • setBypassPolicyLockoutSafetyCheck

      @Stability(Stable) public void setBypassPolicyLockoutSafetyCheck(@Nullable IResolvable value)
      (Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check.

    • getEncrypted

      @Stability(Stable) @Nullable public Object getEncrypted()
      A Boolean value that, if true, creates an encrypted file system.

      Returns union: either Boolean or IResolvable

    • setEncrypted

      @Stability(Stable) public void setEncrypted(@Nullable Boolean value)
      A Boolean value that, if true, creates an encrypted file system.

    • setEncrypted

      @Stability(Stable) public void setEncrypted(@Nullable IResolvable value)
      A Boolean value that, if true, creates an encrypted file system.

    • getFileSystemPolicy

      @Stability(Stable) @Nullable public Object getFileSystemPolicy()
      The FileSystemPolicy for the EFS file system.

    • setFileSystemPolicy

      @Stability(Stable) public void setFileSystemPolicy(@Nullable Object value)
      The FileSystemPolicy for the EFS file system.

    • getFileSystemProtection

      @Stability(Stable) @Nullable public Object getFileSystemProtection()
      Describes the protection on the file system.

      Returns union: either IResolvable or CfnFileSystem.FileSystemProtectionProperty

    • setFileSystemProtection

      @Stability(Stable) public void setFileSystemProtection(@Nullable IResolvable value)
      Describes the protection on the file system.

    • setFileSystemProtection

      @Stability(Stable) public void setFileSystemProtection(@Nullable CfnFileSystem.FileSystemProtectionProperty value)
      Describes the protection on the file system.

    • getFileSystemTagsRaw

      @Stability(Stable) @Nullable public List<CfnFileSystem.ElasticFileSystemTagProperty> getFileSystemTagsRaw()
      Use to create one or more tags associated with the file system.

    • setFileSystemTagsRaw

      @Stability(Stable) public void setFileSystemTagsRaw(@Nullable List<CfnFileSystem.ElasticFileSystemTagProperty> value)
      Use to create one or more tags associated with the file system.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The ID of the AWS KMS key to be used to protect the encrypted file system.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The ID of the AWS KMS key to be used to protect the encrypted file system.

    • getLifecyclePolicies

      @Stability(Stable) @Nullable public Object getLifecyclePolicies()
      An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnFileSystem.LifecyclePolicyProperty>

    • setLifecyclePolicies

      @Stability(Stable) public void setLifecyclePolicies(@Nullable IResolvable value)
      An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object.

    • setLifecyclePolicies

      @Stability(Stable) public void setLifecyclePolicies(@Nullable List<Object> value)
      An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object.

    • getPerformanceMode

      @Stability(Stable) @Nullable public String getPerformanceMode()
      The performance mode of the file system.

    • setPerformanceMode

      @Stability(Stable) public void setPerformanceMode(@Nullable String value)
      The performance mode of the file system.

    • getProvisionedThroughputInMibps

      @Stability(Stable) @Nullable public Number getProvisionedThroughputInMibps()
      The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating.

    • setProvisionedThroughputInMibps

      @Stability(Stable) public void setProvisionedThroughputInMibps(@Nullable Number value)
      The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating.

    • getReplicationConfiguration

      @Stability(Stable) @Nullable public Object getReplicationConfiguration()
      Describes the replication configuration for a specific file system.

      Returns union: either IResolvable or CfnFileSystem.ReplicationConfigurationProperty

    • setReplicationConfiguration

      @Stability(Stable) public void setReplicationConfiguration(@Nullable IResolvable value)
      Describes the replication configuration for a specific file system.

    • setReplicationConfiguration

      @Stability(Stable) public void setReplicationConfiguration(@Nullable CfnFileSystem.ReplicationConfigurationProperty value)
      Describes the replication configuration for a specific file system.

    • getThroughputMode

      @Stability(Stable) @Nullable public String getThroughputMode()
      Specifies the throughput mode for the file system.

    • setThroughputMode

      @Stability(Stable) public void setThroughputMode(@Nullable String value)
      Specifies the throughput mode for the file system.