Package software.amazon.awscdk.services.efs

Class CfnFileSystem.Builder

java.lang.Object

software.amazon.awscdk.services.efs.CfnFileSystem.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFileSystem>

Enclosing class:

CfnFileSystem

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

A fluent builder for CfnFileSystem.

Method Summary

Modifier and Type	Method	Description
CfnFileSystem.Builder	availabilityZoneName(String availabilityZoneName)	For One Zone file systems, specify the AWS Availability Zone in which to create the file system.
CfnFileSystem.Builder	backupPolicy(IResolvable backupPolicy)	Use the BackupPolicy to turn automatic backups on or off for the file system.
CfnFileSystem.Builder	backupPolicy(CfnFileSystem.BackupPolicyProperty backupPolicy)	Use the BackupPolicy to turn automatic backups on or off for the file system.
CfnFileSystem	build()
CfnFileSystem.Builder	bypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)	(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check.
CfnFileSystem.Builder	bypassPolicyLockoutSafetyCheck(IResolvable bypassPolicyLockoutSafetyCheck)	(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check.
static CfnFileSystem.Builder	create(software.constructs.Construct scope, String id)
CfnFileSystem.Builder	encrypted(Boolean encrypted)	A Boolean value that, if true, creates an encrypted file system.
CfnFileSystem.Builder	encrypted(IResolvable encrypted)	A Boolean value that, if true, creates an encrypted file system.
CfnFileSystem.Builder	fileSystemPolicy(Object fileSystemPolicy)	The FileSystemPolicy for the EFS file system.
CfnFileSystem.Builder	fileSystemProtection(IResolvable fileSystemProtection)	Describes the protection on the file system.
CfnFileSystem.Builder	fileSystemProtection(CfnFileSystem.FileSystemProtectionProperty fileSystemProtection)	Describes the protection on the file system.
CfnFileSystem.Builder	fileSystemTags(List<? extends CfnFileSystem.ElasticFileSystemTagProperty> fileSystemTags)	Use to create one or more tags associated with the file system.
CfnFileSystem.Builder	kmsKeyId(String kmsKeyId)	The ID of the AWS KMS key to be used to protect the encrypted file system.
CfnFileSystem.Builder	lifecyclePolicies(List<? extends Object> lifecyclePolicies)	An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object.
CfnFileSystem.Builder	lifecyclePolicies(IResolvable lifecyclePolicies)	An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object.
CfnFileSystem.Builder	performanceMode(String performanceMode)	The performance mode of the file system.
CfnFileSystem.Builder	provisionedThroughputInMibps(Number provisionedThroughputInMibps)	The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating.
CfnFileSystem.Builder	replicationConfiguration(IResolvable replicationConfiguration)	Describes the replication configuration for a specific file system.
CfnFileSystem.Builder	replicationConfiguration(CfnFileSystem.ReplicationConfigurationProperty replicationConfiguration)	Describes the replication configuration for a specific file system.
CfnFileSystem.Builder	throughputMode(String throughputMode)	Specifies the throughput mode for the file system.

Methods inherited from class java.lang.Object

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

Method Details

create

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

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnFileSystem.Builder.

availabilityZoneName

@Stability(Stable)
public CfnFileSystem.Builder availabilityZoneName(String availabilityZoneName)

For One Zone file systems, specify the AWS Availability Zone in which to create the file system.

Use the format us-east-1a to specify the Availability Zone. For more information about One Zone file systems, see EFS file system types in the Amazon EFS User Guide .

One Zone file systems are not available in all Availability Zones in AWS Regions where Amazon EFS is available.

Parameters:

availabilityZoneName - For One Zone file systems, specify the AWS Availability Zone in which to create the file system. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-availabilityzonename

backupPolicy

@Stability(Stable)
public CfnFileSystem.Builder backupPolicy(IResolvable backupPolicy)

Use the BackupPolicy to turn automatic backups on or off for the file system.

Parameters:

backupPolicy - Use the BackupPolicy to turn automatic backups on or off for the file system. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-backuppolicy

backupPolicy

@Stability(Stable)
public CfnFileSystem.Builder backupPolicy(CfnFileSystem.BackupPolicyProperty backupPolicy)

Use the BackupPolicy to turn automatic backups on or off for the file system.

Parameters:

backupPolicy - Use the BackupPolicy to turn automatic backups on or off for the file system. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-backuppolicy

bypassPolicyLockoutSafetyCheck

@Stability(Stable)
public CfnFileSystem.Builder bypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)

(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check.

The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future PutFileSystemPolicy requests on this file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy requests on this file system. The default value is False .

Parameters:

bypassPolicyLockoutSafetyCheck - (Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-bypasspolicylockoutsafetycheck

bypassPolicyLockoutSafetyCheck

@Stability(Stable)
public CfnFileSystem.Builder bypassPolicyLockoutSafetyCheck(IResolvable bypassPolicyLockoutSafetyCheck)

(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check.

The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future PutFileSystemPolicy requests on this file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy requests on this file system. The default value is False .

Parameters:

bypassPolicyLockoutSafetyCheck - (Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-bypasspolicylockoutsafetycheck

encrypted

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

A Boolean value that, if true, creates an encrypted file system.

When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing AWS KMS key . If you don't specify a KMS key , then the default KMS key for Amazon EFS , /aws/elasticfilesystem , is used to protect the encrypted file system.

Parameters:

encrypted - A Boolean value that, if true, creates an encrypted file system. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-encrypted

encrypted

@Stability(Stable)
public CfnFileSystem.Builder encrypted(IResolvable encrypted)

A Boolean value that, if true, creates an encrypted file system.

When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing AWS KMS key . If you don't specify a KMS key , then the default KMS key for Amazon EFS , /aws/elasticfilesystem , is used to protect the encrypted file system.

Parameters:

encrypted - A Boolean value that, if true, creates an encrypted file system. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-encrypted

fileSystemPolicy

@Stability(Stable)
public CfnFileSystem.Builder fileSystemPolicy(Object fileSystemPolicy)

The FileSystemPolicy for the EFS file system.

A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see Using IAM to control NFS access to Amazon EFS in the Amazon EFS User Guide .

Parameters:

fileSystemPolicy - The FileSystemPolicy for the EFS file system. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-filesystempolicy

fileSystemProtection

@Stability(Stable)
public CfnFileSystem.Builder fileSystemProtection(IResolvable fileSystemProtection)

Describes the protection on the file system.

Parameters:

fileSystemProtection - Describes the protection on the file system. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-filesystemprotection

fileSystemProtection

@Stability(Stable)
public CfnFileSystem.Builder fileSystemProtection(CfnFileSystem.FileSystemProtectionProperty fileSystemProtection)

Describes the protection on the file system.

Parameters:

fileSystemProtection - Describes the protection on the file system. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-filesystemprotection

fileSystemTags

@Stability(Stable)
public CfnFileSystem.Builder fileSystemTags(List<? extends CfnFileSystem.ElasticFileSystemTagProperty> fileSystemTags)

Use to create one or more tags associated with the file system.

Each tag is a user-defined key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}" key-value pair. Each key must be unique. For more information, see Tagging AWS resources in the AWS General Reference Guide .

Parameters:

fileSystemTags - Use to create one or more tags associated with the file system. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-filesystemtags

kmsKeyId

@Stability(Stable)
public CfnFileSystem.Builder kmsKeyId(String kmsKeyId)

The ID of the AWS KMS key to be used to protect the encrypted file system.

This parameter is only required if you want to use a nondefault KMS key . If this parameter is not specified, the default KMS key for Amazon EFS is used. This ID can be in one of the following formats:

• Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab .
• ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .
• Key alias - A previously created display name for a key, for example alias/projectKey1 .
• Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1 .

If KmsKeyId is specified, the Encrypted parameter must be set to true.

Parameters:

kmsKeyId - The ID of the AWS KMS key to be used to protect the encrypted file system. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-kmskeyid

lifecyclePolicies

@Stability(Stable)
public CfnFileSystem.Builder lifecyclePolicies(IResolvable lifecyclePolicies)

An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object.

A LifecycleConfiguration object informs Lifecycle management of the following:

• When to move files in the file system from primary storage to IA storage.
• When to move files in the file system from primary storage or IA storage to Archive storage.
• When to move files that are in IA or Archive storage to primary storage.

Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies needs to be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA , TransitionToArchive TransitionToPrimaryStorageClass . See the example requests in the following section for more information.

Parameters:

lifecyclePolicies - An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-lifecyclepolicies

lifecyclePolicies

@Stability(Stable)
public CfnFileSystem.Builder lifecyclePolicies(List<? extends Object> lifecyclePolicies)

An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object.

A LifecycleConfiguration object informs Lifecycle management of the following:

• When to move files in the file system from primary storage to IA storage.
• When to move files in the file system from primary storage or IA storage to Archive storage.
• When to move files that are in IA or Archive storage to primary storage.

Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies needs to be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA , TransitionToArchive TransitionToPrimaryStorageClass . See the example requests in the following section for more information.

Parameters:

lifecyclePolicies - An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-lifecyclepolicies

performanceMode

@Stability(Stable)
public CfnFileSystem.Builder performanceMode(String performanceMode)

The performance mode of the file system.

We recommend generalPurpose performance mode for all file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The maxIO mode is not supported on One Zone file systems.

Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.

Default is generalPurpose .

Parameters:

performanceMode - The performance mode of the file system. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-performancemode

provisionedThroughputInMibps

@Stability(Stable)
public CfnFileSystem.Builder provisionedThroughputInMibps(Number provisionedThroughputInMibps)

The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating.

Required if ThroughputMode is set to provisioned . Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact Support . For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide .

Parameters:

provisionedThroughputInMibps - The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-provisionedthroughputinmibps

replicationConfiguration

@Stability(Stable)
public CfnFileSystem.Builder replicationConfiguration(IResolvable replicationConfiguration)

Describes the replication configuration for a specific file system.

Parameters:

replicationConfiguration - Describes the replication configuration for a specific file system. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-replicationconfiguration

replicationConfiguration

@Stability(Stable)
public CfnFileSystem.Builder replicationConfiguration(CfnFileSystem.ReplicationConfigurationProperty replicationConfiguration)

Describes the replication configuration for a specific file system.

Parameters:

replicationConfiguration - Describes the replication configuration for a specific file system. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-replicationconfiguration

throughputMode

@Stability(Stable)
public CfnFileSystem.Builder throughputMode(String throughputMode)

Specifies the throughput mode for the file system.

The mode can be bursting , provisioned , or elastic . If you set ThroughputMode to provisioned , you must also set a value for ProvisionedThroughputInMibps . After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide .

Default is bursting .

Parameters:

throughputMode - Specifies the throughput mode for the file system. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-throughputmode

build

@Stability(Stable)
public CfnFileSystem build()

Specified by:

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

Returns:

a newly built instance of CfnFileSystem.