software.amazon.awscdk.services.efs

Interface FileSystemProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FileSystemProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.860Z")
 @Stability(value=Stable)
public interface FileSystemProps
extends software.amazon.jsii.JsiiSerializable

Properties of EFS FileSystem.

Example:

 FileSystem fileSystem = FileSystem.Builder.create(this, "MyEfsFileSystem")
         .vpc(new Vpc(this, "VPC"))
         .lifecyclePolicy(LifecyclePolicy.AFTER_14_DAYS) // files are not transitioned to infrequent access (IA) storage by default
         .performanceMode(PerformanceMode.GENERAL_PURPOSE) // default
         .outOfInfrequentAccessPolicy(OutOfInfrequentAccessPolicy.AFTER_1_ACCESS)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FileSystemProps.Builder A builder for FileSystemProps
static class	FileSystemProps.Jsii$Proxy An implementation for FileSystemProps

Method Summary

Modifier and Type	Method and Description
static FileSystemProps.Builder	builder()
default Boolean	getEnableAutomaticBackups() Whether to enable automatic backups for the file system.
default Boolean	getEncrypted() Defines if the data at rest in the file system is encrypted or not.
default String	getFileSystemName() The file system's name.
default IKey	getKmsKey() The KMS key used for encryption.
default LifecyclePolicy	getLifecyclePolicy() A policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class.
default OutOfInfrequentAccessPolicy	getOutOfInfrequentAccessPolicy() A policy used by EFS lifecycle management to transition files from Infrequent Access (IA) storage class to primary storage class.
default PerformanceMode	getPerformanceMode() The performance mode that the file system will operate under.
default Size	getProvisionedThroughputPerSecond() Provisioned throughput for the file system.
default RemovalPolicy	getRemovalPolicy() The removal policy to apply to the file system.
default ISecurityGroup	getSecurityGroup() Security Group to assign to this file system.
default ThroughputMode	getThroughputMode() Enum to mention the throughput mode of the file system.
IVpc	getVpc() VPC to launch the file system in.
default SubnetSelection	getVpcSubnets() Which subnets to place the mount target in the VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getVpc

@Stability(value=Stable)
 @NotNull
IVpc getVpc()

VPC to launch the file system in.

getEnableAutomaticBackups

@Stability(value=Stable)
 @Nullable
default Boolean getEnableAutomaticBackups()

Whether to enable automatic backups for the file system.

Default: false

getEncrypted

@Stability(value=Stable)
 @Nullable
default Boolean getEncrypted()

Defines if the data at rest in the file system is encrypted or not.

Default: - If your application has the '

getFileSystemName

@Stability(value=Stable)
 @Nullable
default String getFileSystemName()

The file system's name.

Default: - CDK generated name

getKmsKey

@Stability(value=Stable)
 @Nullable
default IKey getKmsKey()

The KMS key used for encryption.

This is required to encrypt the data at rest if @encrypted is set to true.

Default: - if 'encrypted' is true, the default key for EFS (/aws/elasticfilesystem) is used

getLifecyclePolicy

@Stability(value=Stable)
 @Nullable
default LifecyclePolicy getLifecyclePolicy()

A policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class.

Default: - None. EFS will not transition files to the IA storage class.

getOutOfInfrequentAccessPolicy

@Stability(value=Stable)
 @Nullable
default OutOfInfrequentAccessPolicy getOutOfInfrequentAccessPolicy()

A policy used by EFS lifecycle management to transition files from Infrequent Access (IA) storage class to primary storage class.

Default: - None. EFS will not transition files from IA storage to primary storage.

getPerformanceMode

@Stability(value=Stable)
 @Nullable
default PerformanceMode getPerformanceMode()

The performance mode that the file system will operate under.

An Amazon EFS file system's performance mode can't be changed after the file system has been created. Updating this property will replace the file system.

Default: PerformanceMode.GENERAL_PURPOSE

getProvisionedThroughputPerSecond

@Stability(value=Stable)
 @Nullable
default Size getProvisionedThroughputPerSecond()

Provisioned throughput for the file system.

This is a required property if the throughput mode is set to PROVISIONED. Must be at least 1MiB/s.

Default: - none, errors out

getRemovalPolicy

@Stability(value=Stable)
 @Nullable
default RemovalPolicy getRemovalPolicy()

The removal policy to apply to the file system.

Default: RemovalPolicy.RETAIN

getSecurityGroup

@Stability(value=Stable)
 @Nullable
default ISecurityGroup getSecurityGroup()

Security Group to assign to this file system.

Default: - creates new security group which allows all outbound traffic

getThroughputMode

@Stability(value=Stable)
 @Nullable
default ThroughputMode getThroughputMode()

Enum to mention the throughput mode of the file system.

Default: ThroughputMode.BURSTING

getVpcSubnets

@Stability(value=Stable)
 @Nullable
default SubnetSelection getVpcSubnets()

Which subnets to place the mount target in the VPC.

Default: - the Vpc default strategy if not specified

builder

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

Returns:

a FileSystemProps.Builder of FileSystemProps