software.amazon.awscdk.services.efs

Interface CfnFileSystemProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFileSystemProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:08.108Z")
 @Stability(value=Stable)
public interface CfnFileSystemProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnFileSystem`.

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;
 CfnFileSystemProps cfnFileSystemProps = CfnFileSystemProps.builder()
         .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	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	getAvailabilityZoneName() Used to create a file system that uses One Zone storage classes.
default Object	getBackupPolicy() Use the `BackupPolicy` to turn automatic backups on or off for the file system.
default Object	getBypassPolicyLockoutSafetyCheck() `AWS::EFS::FileSystem.BypassPolicyLockoutSafetyCheck`.
default Object	getEncrypted() A Boolean value that, if true, creates an encrypted file system.
default Object	getFileSystemPolicy() The `FileSystemPolicy` for the EFS file system.
default List<CfnFileSystem.ElasticFileSystemTagProperty>	getFileSystemTags() Use to create one or more tags associated with the file system.
default String	getKmsKeyId() The ID of the AWS KMS key to be used to protect the encrypted file system.
default Object	getLifecyclePolicies() A list of one LifecyclePolicy that tells EFS lifecycle management when to transition files to the Infrequent Access (IA) storage classes.
default String	getPerformanceMode() The performance mode of the file system.
default Number	getProvisionedThroughputInMibps() The throughput, measured in MiB/s, that you want to provision for a file system that you're creating.
default String	getThroughputMode() Specifies the throughput mode for the file system, either `bursting` or `provisioned` .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAvailabilityZoneName

@Stability(value=Stable)
 @Nullable
default 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.

getBackupPolicy

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

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

getBypassPolicyLockoutSafetyCheck

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

`AWS::EFS::FileSystem.BypassPolicyLockoutSafetyCheck`.

getEncrypted

@Stability(value=Stable)
 @Nullable
default 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.

getFileSystemPolicy

@Stability(value=Stable)
 @Nullable
default 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 .

getFileSystemTags

@Stability(value=Stable)
 @Nullable
default List<CfnFileSystem.ElasticFileSystemTagProperty> getFileSystemTags()

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 .

getKmsKeyId

@Stability(value=Stable)
 @Nullable
default 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.

getLifecyclePolicies

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

A list of one LifecyclePolicy that tells EFS lifecycle management when to transition files to the Infrequent Access (IA) storage classes.

getPerformanceMode

@Stability(value=Stable)
 @Nullable
default 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.

getProvisionedThroughputInMibps

@Stability(value=Stable)
 @Nullable
default 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 .

getThroughputMode

@Stability(value=Stable)
 @Nullable
default 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 .

builder

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

Returns:

a CfnFileSystemProps.Builder of CfnFileSystemProps