@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
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();
| Modifier and Type | Interface and Description |
|---|---|
static class |
FileSystemProps.Builder
A builder for
FileSystemProps |
static class |
FileSystemProps.Jsii$Proxy
An implementation for
FileSystemProps |
| 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.
|
@Stability(value=Stable) @NotNull IVpc getVpc()
@Stability(value=Stable) @Nullable default Boolean getEnableAutomaticBackups()
Default: false
@Stability(value=Stable) @Nullable default Boolean getEncrypted()
Default: - If your application has the '
@Stability(value=Stable) @Nullable default String getFileSystemName()
Default: - CDK generated name
@Stability(value=Stable) @Nullable default IKey getKmsKey()
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
@Stability(value=Stable) @Nullable default LifecyclePolicy getLifecyclePolicy()
Default: - None. EFS will not transition files to the IA storage class.
@Stability(value=Stable) @Nullable default OutOfInfrequentAccessPolicy getOutOfInfrequentAccessPolicy()
Default: - None. EFS will not transition files from IA storage to primary storage.
@Stability(value=Stable) @Nullable default PerformanceMode getPerformanceMode()
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
@Stability(value=Stable) @Nullable default Size getProvisionedThroughputPerSecond()
This is a required property if the throughput mode is set to PROVISIONED. Must be at least 1MiB/s.
Default: - none, errors out
@Stability(value=Stable) @Nullable default RemovalPolicy getRemovalPolicy()
Default: RemovalPolicy.RETAIN
@Stability(value=Stable) @Nullable default ISecurityGroup getSecurityGroup()
Default: - creates new security group which allows all outbound traffic
@Stability(value=Stable) @Nullable default ThroughputMode getThroughputMode()
Default: ThroughputMode.BURSTING
@Stability(value=Stable) @Nullable default SubnetSelection getVpcSubnets()
Default: - the Vpc default strategy if not specified
@Stability(value=Stable) static FileSystemProps.Builder builder()
FileSystemProps.Builder of FileSystemPropsCopyright © 2022. All rights reserved.