software.amazon.awscdk.services.fsx

Class LustreFileSystem.Builder

java.lang.Object

software.amazon.awscdk.services.fsx.LustreFileSystem.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LustreFileSystem>

Enclosing class:

LustreFileSystem

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

A fluent builder for LustreFileSystem.

Method Summary

Modifier and Type	Method and Description
LustreFileSystem.Builder	backupId(String backupId) The ID of the backup.
LustreFileSystem	build()
static LustreFileSystem.Builder	create(software.constructs.Construct scope, String id)
LustreFileSystem.Builder	kmsKey(IKey kmsKey) The KMS key used for encryption to protect your data at rest.
LustreFileSystem.Builder	lustreConfiguration(LustreConfiguration lustreConfiguration) Additional configuration for FSx specific to Lustre.
LustreFileSystem.Builder	removalPolicy(RemovalPolicy removalPolicy) Policy to apply when the file system is removed from the stack.
LustreFileSystem.Builder	securityGroup(ISecurityGroup securityGroup) Security Group to assign to this file system.
LustreFileSystem.Builder	storageCapacityGiB(Number storageCapacityGiB) The storage capacity of the file system being created.
LustreFileSystem.Builder	vpc(IVpc vpc) The VPC to launch the file system in.
LustreFileSystem.Builder	vpcSubnet(ISubnet vpcSubnet) The subnet that the file system will be accessible from.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static LustreFileSystem.Builder create(software.constructs.Construct scope,
                                                                       String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of LustreFileSystem.Builder.

storageCapacityGiB

@Stability(value=Stable)
public LustreFileSystem.Builder storageCapacityGiB(Number storageCapacityGiB)

The storage capacity of the file system being created.

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.

Parameters:

storageCapacityGiB - The storage capacity of the file system being created. This parameter is required.

Returns:

this

vpc

@Stability(value=Stable)
public LustreFileSystem.Builder vpc(IVpc vpc)

The VPC to launch the file system in.

Parameters:

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

Returns:

this

backupId

@Stability(value=Stable)
public LustreFileSystem.Builder backupId(String backupId)

The ID of the backup.

Specifies the backup to use if you're creating a file system from an existing backup.

Default: - no backup will be used.

Parameters:

backupId - The ID of the backup. This parameter is required.

Returns:

this

kmsKey

@Stability(value=Stable)
public LustreFileSystem.Builder kmsKey(IKey kmsKey)

The KMS key used for encryption to protect your data at rest.

Default: - the aws/fsx default KMS key for the AWS account being deployed into.

Parameters:

kmsKey - The KMS key used for encryption to protect your data at rest. This parameter is required.

Returns:

this

removalPolicy

@Stability(value=Stable)
public LustreFileSystem.Builder removalPolicy(RemovalPolicy removalPolicy)

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

Default: RemovalPolicy.RETAIN

Parameters:

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

Returns:

this

securityGroup

@Stability(value=Stable)
public LustreFileSystem.Builder securityGroup(ISecurityGroup securityGroup)

Security Group to assign to this file system.

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

Parameters:

securityGroup - Security Group to assign to this file system. This parameter is required.

Returns:

this

lustreConfiguration

@Stability(value=Stable)
public LustreFileSystem.Builder lustreConfiguration(LustreConfiguration lustreConfiguration)

Additional configuration for FSx specific to Lustre.

Parameters:

lustreConfiguration - Additional configuration for FSx specific to Lustre. This parameter is required.

Returns:

this

vpcSubnet

@Stability(value=Stable)
public LustreFileSystem.Builder vpcSubnet(ISubnet vpcSubnet)

The subnet that the file system will be accessible from.

Parameters:

vpcSubnet - The subnet that the file system will be accessible from. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public LustreFileSystem build()

Specified by:

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