Package software.amazon.awscdk.services.fsx

Class FileSystemProps.Builder

java.lang.Object

software.amazon.awscdk.services.fsx.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.Builder	backupId(String backupId)	Sets the value of FileSystemProps.getBackupId()
FileSystemProps	build()	Builds the configured instance.
FileSystemProps.Builder	kmsKey(IKey kmsKey)	Sets the value of FileSystemProps.getKmsKey()
FileSystemProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of FileSystemProps.getRemovalPolicy()
FileSystemProps.Builder	securityGroup(ISecurityGroup securityGroup)	Sets the value of FileSystemProps.getSecurityGroup()
FileSystemProps.Builder	storageCapacityGiB(Number storageCapacityGiB)	Sets the value of FileSystemProps.getStorageCapacityGiB()
FileSystemProps.Builder	vpc(IVpc vpc)	Sets the value of FileSystemProps.getVpc()

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

storageCapacityGiB

@Stability(Stable)
public FileSystemProps.Builder storageCapacityGiB(Number storageCapacityGiB)

Sets the value of FileSystemProps.getStorageCapacityGiB()

Parameters:

storageCapacityGiB - The storage capacity of the file system being created. This parameter is required. For Windows file systems, valid values are 32 GiB to 65,536 GiB. For SCRATCH_1 deployment types, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3,600 GiB. For SCRATCH_2 and PERSISTENT_1 types, valid values are 1,200, 2,400, then continuing in increments of 2,400 GiB.

Returns:

this

vpc

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

Sets the value of FileSystemProps.getVpc()

Parameters:

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

Returns:

this

backupId

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

Sets the value of FileSystemProps.getBackupId()

Parameters:

backupId - The ID of the backup. Specifies the backup to use if you're creating a file system from an existing backup.

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 to protect your data at rest.

Returns:

this

removalPolicy

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

Sets the value of FileSystemProps.getRemovalPolicy()

Parameters:

removalPolicy - Policy to apply when the file system is removed from the stack.

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

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