Package software.amazon.awscdk.services.efs

Enum PerformanceMode

java.lang.Object

java.lang.Enum<PerformanceMode>

software.amazon.awscdk.services.efs.PerformanceMode

All Implemented Interfaces:

Serializable, Comparable<PerformanceMode>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:29.526Z")
@Stability(Stable)
public enum PerformanceMode
extends Enum<PerformanceMode>

EFS Performance mode.

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) // files are not transitioned back from (infrequent access) IA to primary storage by default
         .transitionToArchivePolicy(LifecyclePolicy.AFTER_14_DAYS) // files are not transitioned to Archive by default
         .replicationOverwriteProtection(ReplicationOverwriteProtection.ENABLED)
         .build();
 

See Also:

• https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GENERAL_PURPOSE	General Purpose is ideal for latency-sensitive use cases, like web serving environments, content management systems, home directories, and general file serving.
MAX_IO	File systems in the Max I/O mode can scale to higher levels of aggregate throughput and operations per second.

Method Summary

Modifier and Type	Method	Description
static PerformanceMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PerformanceMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GENERAL_PURPOSE

@Stability(Stable)
public static final PerformanceMode GENERAL_PURPOSE

General Purpose is ideal for latency-sensitive use cases, like web serving environments, content management systems, home directories, and general file serving.

Recommended for the majority of Amazon EFS file systems.

MAX_IO

@Stability(Stable)
public static final PerformanceMode MAX_IO

File systems in the Max I/O mode can scale to higher levels of aggregate throughput and operations per second.

This scaling is done with a tradeoff of slightly higher latencies for file metadata operations. Highly parallelized applications and workloads, such as big data analysis, media processing, and genomics analysis, can benefit from this mode.

Method Details

values

public static PerformanceMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PerformanceMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null