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(value=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 and Description
CfnFileSystem.Builder	availabilityZoneName(String availabilityZoneName) Used to create a file system that uses One Zone storage classes.
CfnFileSystem.Builder	backupPolicy(CfnFileSystem.BackupPolicyProperty backupPolicy) Use the `BackupPolicy` to turn automatic backups on or off for the file system.
CfnFileSystem.Builder	backupPolicy(IResolvable 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	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(IResolvable lifecyclePolicies) An array of `LifecyclePolicy` objects that define the file system's `LifecycleConfiguration` object.
CfnFileSystem.Builder	lifecyclePolicies(List<? extends Object> 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 MiB/s, that you want to provision for a file system that you're creating.
CfnFileSystem.Builder	throughputMode(String throughputMode) Specifies the throughput mode for the file system, either `bursting` or `provisioned` .

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 CfnFileSystem.Builder create(software.constructs.Construct scope,
                                                                    String id)

Parameters:

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

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnFileSystem.BackupPolicyProperty.Builder.

availabilityZoneName

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

Used to create a file system that uses One Zone storage classes.

It specifies 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 storage classes, see Using EFS storage classes in the Amazon EFS User Guide .

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

Parameters:

availabilityZoneName - Used to create a file system that uses One Zone storage classes. This parameter is required.

Returns:

this

backupPolicy

@Stability(value=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

backupPolicy

@Stability(value=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

bypassPolicyLockoutSafetyCheck

@Stability(value=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

bypassPolicyLockoutSafetyCheck

@Stability(value=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

encrypted

@Stability(value=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

encrypted

@Stability(value=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

fileSystemPolicy

@Stability(value=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

fileSystemTags

@Stability(value=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

kmsKeyId

@Stability(value=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

lifecyclePolicies

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

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

A LifecycleConfiguration object informs EFS lifecycle management and intelligent tiering of the following:

• When to move files in the file system from primary storage to the IA storage class.
• When to move files that are in IA 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 , 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

lifecyclePolicies

@Stability(value=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 EFS lifecycle management and intelligent tiering of the following:

• When to move files in the file system from primary storage to the IA storage class.
• When to move files that are in IA 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 , 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

performanceMode

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

The performance mode of the file system.

We recommend generalPurpose performance mode for most 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 file systems using One Zone storage classes.

Parameters:

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

Returns:

this

provisionedThroughputInMibps

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

The throughput, measured in MiB/s, that you want to provision for a file system that you're creating.

Valid values are 1-1024. Required if ThroughputMode is set to provisioned . The upper limit for throughput is 1024 MiB/s. To increase this limit, contact AWS Support . For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide .

Parameters:

provisionedThroughputInMibps - The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. This parameter is required.

Returns:

this

throughputMode

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

Specifies the throughput mode for the file system, either `bursting` or `provisioned` .

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 throughput in Provisioned Throughput mode or change between the throughput modes, as long as it’s been more than 24 hours since the last decrease or throughput mode change. 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, either `bursting` or `provisioned` . This parameter is required.

Returns:

this

build

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

Specified by:

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