Package software.amazon.awscdk.services.efs

Class CfnFileSystem

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.efs.CfnFileSystem
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.122Z") @Stability(Stable) public class CfnFileSystem extends CfnResource implements IInspectable
A CloudFormation AWS::EFS::FileSystem.

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)
         .fileSystemTags(List.of(ElasticFileSystemTagProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .kmsKeyId("kmsKeyId")
         .lifecyclePolicies(List.of(LifecyclePolicyProperty.builder()
                 .transitionToIa("transitionToIa")
                 .transitionToPrimaryStorageClass("transitionToPrimaryStorageClass")
                 .build()))
         .performanceMode("performanceMode")
         .provisionedThroughputInMibps(123)
         .throughputMode("throughputMode")
         .build();

  • 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 Construct scope, @NotNull String id, @Nullable CfnFileSystemProps props)
      Create a new AWS::EFS::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.

    • CfnFileSystem

      @Stability(Stable) public CfnFileSystem(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::EFS::FileSystem.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Use to create one or more tags associated with the file system.

      Each tag is a user-defined key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}" key-value pair. Each key must be unique. For more information, see Tagging AWS resources in the AWS General Reference Guide .

    • getFileSystemPolicy

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

      A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see Using IAM to control NFS access to Amazon EFS in the Amazon EFS User Guide .

    • setFileSystemPolicy

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

      A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see Using IAM to control NFS access to Amazon EFS in the Amazon EFS User Guide .

    • getAvailabilityZoneName

      @Stability(Stable) @Nullable public String getAvailabilityZoneName()
      Used to create a file system that uses One Zone storage classes.

      It specifies the AWS Availability Zone in which to create the file system. Use the format us-east-1a to specify the Availability Zone. For more information about One Zone storage classes, see Using EFS storage classes in the Amazon EFS User Guide .

      One Zone storage classes are not available in all Availability Zones in AWS Regions where Amazon EFS is available.

    • setAvailabilityZoneName

      @Stability(Stable) public void setAvailabilityZoneName(@Nullable String value)
      Used to create a file system that uses One Zone storage classes.

      It specifies the AWS Availability Zone in which to create the file system. Use the format us-east-1a to specify the Availability Zone. For more information about One Zone storage classes, see Using EFS storage classes in the Amazon EFS User Guide .

      One Zone storage classes are not available in all Availability Zones in AWS Regions where Amazon EFS is available.

    • getBackupPolicy

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

    • 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.

      The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future PutFileSystemPolicy requests on this file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy requests on this file system. The default value is False .

    • setBypassPolicyLockoutSafetyCheck

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

      The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future PutFileSystemPolicy requests on this file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy requests on this file system. The default value is False .

    • setBypassPolicyLockoutSafetyCheck

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

      The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future PutFileSystemPolicy requests on this file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy requests on this file system. The default value is False .

    • getEncrypted

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

      When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing AWS KMS key . If you don't specify a KMS key , then the default KMS key for Amazon EFS , /aws/elasticfilesystem , is used to protect the encrypted file system.

    • setEncrypted

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

      When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing AWS KMS key . If you don't specify a KMS key , then the default KMS key for Amazon EFS , /aws/elasticfilesystem , is used to protect the encrypted file system.

    • setEncrypted

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

      When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing AWS KMS key . If you don't specify a KMS key , then the default KMS key for Amazon EFS , /aws/elasticfilesystem , is used to protect the encrypted 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.

      This parameter is only required if you want to use a nondefault KMS key . If this parameter is not specified, the default KMS key for Amazon EFS is used. This ID can be in one of the following formats:

      • Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab .
      • ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .
      • Key alias - A previously created display name for a key, for example alias/projectKey1 .
      • Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1 .

      If KmsKeyId is specified, the Encrypted parameter must be set to true.

    • 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.

      This parameter is only required if you want to use a nondefault KMS key . If this parameter is not specified, the default KMS key for Amazon EFS is used. This ID can be in one of the following formats:

      • Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab .
      • ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .
      • Key alias - A previously created display name for a key, for example alias/projectKey1 .
      • Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1 .

      If KmsKeyId is specified, the Encrypted parameter must be set to true.

    • getLifecyclePolicies

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

      A LifecycleConfiguration object informs EFS lifecycle management and intelligent tiering of the following:

      • When to move files in the file system from primary storage to the IA storage class.
      • When to move files that are in IA storage to primary storage.

      Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies needs to be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA , TransitionToPrimaryStorageClass . See the example requests in the following section for more information.

    • setLifecyclePolicies

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

      A LifecycleConfiguration object informs EFS lifecycle management and intelligent tiering of the following:

      • When to move files in the file system from primary storage to the IA storage class.
      • When to move files that are in IA storage to primary storage.

      Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies needs to be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA , TransitionToPrimaryStorageClass . See the example requests in the following section for more information.

    • setLifecyclePolicies

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

      A LifecycleConfiguration object informs EFS lifecycle management and intelligent tiering of the following:

      • When to move files in the file system from primary storage to the IA storage class.
      • When to move files that are in IA storage to primary storage.

      Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies needs to be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA , TransitionToPrimaryStorageClass . See the example requests in the following section for more information.

    • getPerformanceMode

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

      We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created.

      The maxIO mode is not supported on file systems using One Zone storage classes.

    • setPerformanceMode

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

      We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created.

      The maxIO mode is not supported on file systems using One Zone storage classes.

    • getProvisionedThroughputInMibps

      @Stability(Stable) @Nullable public Number getProvisionedThroughputInMibps()
      The throughput, measured in MiB/s, that you want to provision for a file system that you're creating.

      Valid values are 1-1024. Required if ThroughputMode is set to provisioned . The upper limit for throughput is 1024 MiB/s. To increase this limit, contact AWS Support . For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide .

    • setProvisionedThroughputInMibps

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

      Valid values are 1-1024. Required if ThroughputMode is set to provisioned . The upper limit for throughput is 1024 MiB/s. To increase this limit, contact AWS Support . For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide .

    • getThroughputMode

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

      The mode can be bursting , provisioned , or elastic . If you set ThroughputMode to provisioned , you must also set a value for ProvisionedThroughputInMibps . After you create the file system, you can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes, with certain time restrictions. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide .

      Default is bursting .

    • setThroughputMode

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

      The mode can be bursting , provisioned , or elastic . If you set ThroughputMode to provisioned , you must also set a value for ProvisionedThroughputInMibps . After you create the file system, you can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes, with certain time restrictions. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide .

      Default is bursting .