Package software.amazon.awscdk.services.efs

Class FileSystemProps.Builder

java.lang.Object

software.amazon.awscdk.services.efs.FileSystemProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FileSystemProps>

Enclosing interface:

FileSystemProps

@Stability(Stable)
public static final class FileSystemProps.Builder
extends Object
implements software.amazon.jsii.Builder<FileSystemProps>

A builder for FileSystemProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FileSystemProps	build()	Builds the configured instance.
FileSystemProps.Builder	enableAutomaticBackups(Boolean enableAutomaticBackups)	Sets the value of FileSystemProps.getEnableAutomaticBackups()
FileSystemProps.Builder	encrypted(Boolean encrypted)	Sets the value of FileSystemProps.getEncrypted()
FileSystemProps.Builder	fileSystemName(String fileSystemName)	Sets the value of FileSystemProps.getFileSystemName()
FileSystemProps.Builder	kmsKey(IKey kmsKey)	Sets the value of FileSystemProps.getKmsKey()
FileSystemProps.Builder	lifecyclePolicy(LifecyclePolicy lifecyclePolicy)	Sets the value of FileSystemProps.getLifecyclePolicy()
FileSystemProps.Builder	outOfInfrequentAccessPolicy(OutOfInfrequentAccessPolicy outOfInfrequentAccessPolicy)	Sets the value of FileSystemProps.getOutOfInfrequentAccessPolicy()
FileSystemProps.Builder	performanceMode(PerformanceMode performanceMode)	Sets the value of FileSystemProps.getPerformanceMode()
FileSystemProps.Builder	provisionedThroughputPerSecond(Size provisionedThroughputPerSecond)	Sets the value of FileSystemProps.getProvisionedThroughputPerSecond()
FileSystemProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of FileSystemProps.getRemovalPolicy()
FileSystemProps.Builder	securityGroup(ISecurityGroup securityGroup)	Sets the value of FileSystemProps.getSecurityGroup()
FileSystemProps.Builder	throughputMode(ThroughputMode throughputMode)	Sets the value of FileSystemProps.getThroughputMode()
FileSystemProps.Builder	vpc(IVpc vpc)	Sets the value of FileSystemProps.getVpc()
FileSystemProps.Builder	vpcSubnets(SubnetSelection vpcSubnets)	Sets the value of FileSystemProps.getVpcSubnets()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

vpc

@Stability(Stable)
public FileSystemProps.Builder vpc(IVpc vpc)

Sets the value of FileSystemProps.getVpc()

Parameters:

vpc - VPC to launch the file system in. This parameter is required.

Returns:

this

enableAutomaticBackups

@Stability(Stable)
public FileSystemProps.Builder enableAutomaticBackups(Boolean enableAutomaticBackups)

Sets the value of FileSystemProps.getEnableAutomaticBackups()

Parameters:

enableAutomaticBackups - Whether to enable automatic backups for the file system.

Returns:

this

encrypted

@Stability(Stable)
public FileSystemProps.Builder encrypted(Boolean encrypted)

Sets the value of FileSystemProps.getEncrypted()

Parameters:

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

Returns:

this

fileSystemName

@Stability(Stable)
public FileSystemProps.Builder fileSystemName(String fileSystemName)

Sets the value of FileSystemProps.getFileSystemName()

Parameters:

fileSystemName - The file system's name.

Returns:

this

kmsKey

@Stability(Stable)
public FileSystemProps.Builder kmsKey(IKey kmsKey)

Sets the value of FileSystemProps.getKmsKey()

Parameters:

kmsKey - The KMS key used for encryption. This is required to encrypt the data at rest if @encrypted is set to true.

Returns:

this

lifecyclePolicy

@Stability(Stable)
public FileSystemProps.Builder lifecyclePolicy(LifecyclePolicy lifecyclePolicy)

Sets the value of FileSystemProps.getLifecyclePolicy()

Parameters:

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

Returns:

this

outOfInfrequentAccessPolicy

@Stability(Stable)
public FileSystemProps.Builder outOfInfrequentAccessPolicy(OutOfInfrequentAccessPolicy outOfInfrequentAccessPolicy)

Sets the value of FileSystemProps.getOutOfInfrequentAccessPolicy()

Parameters:

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

Returns:

this

performanceMode

@Stability(Stable)
public FileSystemProps.Builder performanceMode(PerformanceMode performanceMode)

Sets the value of FileSystemProps.getPerformanceMode()

Parameters:

performanceMode - 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.

Returns:

this

provisionedThroughputPerSecond

@Stability(Stable)
public FileSystemProps.Builder provisionedThroughputPerSecond(Size provisionedThroughputPerSecond)

Sets the value of FileSystemProps.getProvisionedThroughputPerSecond()

Parameters:

provisionedThroughputPerSecond - 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.

Returns:

this

removalPolicy

@Stability(Stable)
public FileSystemProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of FileSystemProps.getRemovalPolicy()

Parameters:

removalPolicy - The removal policy to apply to the file system.

Returns:

this

securityGroup

@Stability(Stable)
public FileSystemProps.Builder securityGroup(ISecurityGroup securityGroup)

Sets the value of FileSystemProps.getSecurityGroup()

Parameters:

securityGroup - Security Group to assign to this file system.

Returns:

this

throughputMode

@Stability(Stable)
public FileSystemProps.Builder throughputMode(ThroughputMode throughputMode)

Sets the value of FileSystemProps.getThroughputMode()

Parameters:

throughputMode - Enum to mention the throughput mode of the file system.

Returns:

this

vpcSubnets

@Stability(Stable)
public FileSystemProps.Builder vpcSubnets(SubnetSelection vpcSubnets)

Sets the value of FileSystemProps.getVpcSubnets()

Parameters:

vpcSubnets - Which subnets to place the mount target in the VPC.

Returns:

this

build

@Stability(Stable)
public FileSystemProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<FileSystemProps>

Returns:

a new instance of FileSystemProps

Throws:

NullPointerException - if any required attribute was not provided