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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.852Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnFileSystem.BackupPolicyProperty The backup policy turns automatic backups for the file system on or off.
static class	CfnFileSystem.Builder A fluent builder for CfnFileSystem.
static interface	CfnFileSystem.ElasticFileSystemTagProperty A tag is a key-value pair attached to a file system.
static interface	CfnFileSystem.LifecyclePolicyProperty Describes a policy used by EFS lifecycle management and EFS Intelligent-Tiering that specifies when to transition files into and out of the file system's Infrequent Access (IA) storage class.

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) Create a new `AWS::EFS::FileSystem`.
	CfnFileSystem(software.constructs.Construct scope, String id, CfnFileSystemProps props) Create a new `AWS::EFS::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	getAttrArn() The Amazon Resource Name (ARN) of the EFS file system.
String	getAttrFileSystemId() The ID of the EFS file system.
String	getAvailabilityZoneName() Used to create a file system that uses One Zone storage classes.
Object	getBackupPolicy() Use the `BackupPolicy` to turn automatic backups on or off for the file system.
Object	getBypassPolicyLockoutSafetyCheck() (Optional) A boolean that specifies whether or not to bypass the `FileSystemPolicy` lockout safety check.
protected Map<String,Object>	getCfnProperties()
Object	getEncrypted() A Boolean value that, if true, creates an encrypted file system.
Object	getFileSystemPolicy() The `FileSystemPolicy` for the EFS file system.
String	getKmsKeyId() The ID of the AWS KMS key to be used to protect the encrypted file system.
Object	getLifecyclePolicies() An array of `LifecyclePolicy` objects that define the file system's `LifecycleConfiguration` object.
String	getPerformanceMode() The performance mode of the file system.
Number	getProvisionedThroughputInMibps() The throughput, measured in MiB/s, that you want to provision for a file system that you're creating.
TagManager	getTags() Use to create one or more tags associated with the file system.
String	getThroughputMode() Specifies the throughput mode for the file system, either `bursting` or `provisioned` .
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAvailabilityZoneName(String value) Used to create a file system that uses One Zone storage classes.
void	setBackupPolicy(CfnFileSystem.BackupPolicyProperty value) Use the `BackupPolicy` to turn automatic backups on or off for the file system.
void	setBackupPolicy(IResolvable value) Use the `BackupPolicy` to turn automatic backups on or off for the file system.
void	setBypassPolicyLockoutSafetyCheck(Boolean value) (Optional) A boolean that specifies whether or not to bypass the `FileSystemPolicy` lockout safety check.
void	setBypassPolicyLockoutSafetyCheck(IResolvable value) (Optional) A boolean that specifies whether or not to bypass the `FileSystemPolicy` lockout safety check.
void	setEncrypted(Boolean value) A Boolean value that, if true, creates an encrypted file system.
void	setEncrypted(IResolvable value) A Boolean value that, if true, creates an encrypted file system.
void	setFileSystemPolicy(Object value) The `FileSystemPolicy` for the EFS file system.
void	setKmsKeyId(String value) The ID of the AWS KMS key to be used to protect the encrypted file system.
void	setLifecyclePolicies(IResolvable value) An array of `LifecyclePolicy` objects that define the file system's `LifecycleConfiguration` object.
void	setLifecyclePolicies(List<Object> value) An array of `LifecyclePolicy` objects that define the file system's `LifecycleConfiguration` object.
void	setPerformanceMode(String value) The performance mode of the file system.
void	setProvisionedThroughputInMibps(Number value) The throughput, measured in MiB/s, that you want to provision for a file system that you're creating.
void	setThroughputMode(String value) Specifies the throughput mode for the file system, either `bursting` or `provisioned` .

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, 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,
                                              @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(value=Stable)
public CfnFileSystem(@NotNull
                                              software.constructs.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 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.

getAttrArn

@Stability(value=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(value=Stable)
 @NotNull
public String getAttrFileSystemId()

The ID of the EFS file system.

For example: fs-abcdef0123456789a

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=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(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
public Object getBackupPolicy()

Use the `BackupPolicy` to turn automatic backups on or off for the file system.

setBackupPolicy

@Stability(value=Stable)
public void setBackupPolicy(@Nullable
                                                     CfnFileSystem.BackupPolicyProperty value)

Use the `BackupPolicy` to turn automatic backups on or off for the file system.

setBackupPolicy

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

Use the `BackupPolicy` to turn automatic backups on or off for the file system.

getBypassPolicyLockoutSafetyCheck

@Stability(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
public String getThroughputMode()

Specifies the throughput mode for the file system, either `bursting` or `provisioned` .

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, as long as it’s been more than 24 hours since the last decrease or throughput mode change. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide .

Default is bursting .

setThroughputMode

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

Specifies the throughput mode for the file system, either `bursting` or `provisioned` .

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, as long as it’s been more than 24 hours since the last decrease or throughput mode change. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide .

Default is bursting .