software.amazon.awssdk.services.efs.model

Interface CreateFileSystemRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<CreateFileSystemRequest.Builder,CreateFileSystemRequest>, EfsRequest.Builder, SdkBuilder<CreateFileSystemRequest.Builder,CreateFileSystemRequest>, SdkRequest.Builder

Enclosing class:

CreateFileSystemRequest

public static interface CreateFileSystemRequest.Builder
extends EfsRequest.Builder, CopyableBuilder<CreateFileSystemRequest.Builder,CreateFileSystemRequest>

Method Summary

Modifier and Type	Method and Description
CreateFileSystemRequest.Builder	creationToken(String creationToken) String of up to 64 ASCII characters.
CreateFileSystemRequest.Builder	encrypted(Boolean encrypted) A boolean value that, if true, creates an encrypted file system.
CreateFileSystemRequest.Builder	kmsKeyId(String kmsKeyId) The id of the AWS KMS CMK that will be used to protect the encrypted file system.
CreateFileSystemRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateFileSystemRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateFileSystemRequest.Builder	performanceMode(PerformanceMode performanceMode) The PerformanceMode of the file system.
CreateFileSystemRequest.Builder	performanceMode(String performanceMode) The PerformanceMode of the file system.

Methods inherited from interface software.amazon.awssdk.services.efs.model.EfsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

creationToken

CreateFileSystemRequest.Builder creationToken(String creationToken)

String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

Parameters:

creationToken - String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

Returns:

Returns a reference to this object so that method calls can be chained together.

performanceMode

CreateFileSystemRequest.Builder performanceMode(String performanceMode)

The PerformanceMode 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. This can't be changed after the file system has been created.

Parameters:

performanceMode - The PerformanceMode 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. This can't be changed after the file system has been created.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PerformanceMode, PerformanceMode

performanceMode

CreateFileSystemRequest.Builder performanceMode(PerformanceMode performanceMode)

The PerformanceMode 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. This can't be changed after the file system has been created.

Parameters:

performanceMode - The PerformanceMode 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. This can't be changed after the file system has been created.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PerformanceMode, PerformanceMode

encrypted

CreateFileSystemRequest.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 CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK 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. When creating an encrypted file system, you have the option of specifying a CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

CreateFileSystemRequest.Builder kmsKeyId(String kmsKeyId)

The id of the AWS KMS CMK that will be used to protect the encrypted file system. This parameter is only required if you want to use a non-default CMK. If this parameter is not specified, the default CMK 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 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 Amazon Resource Name for a key alias. For example, arn:aws:kms:us-west-2:444455556666:alias/projectKey1.

Note that if the KmsKeyId is specified, the CreateFileSystemRequest$Encrypted parameter must be set to true.

Parameters:

kmsKeyId - The id of the AWS KMS CMK that will be used to protect the encrypted file system. This parameter is only required if you want to use a non-default CMK. If this parameter is not specified, the default CMK 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 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 Amazon Resource Name for a key alias. For example, arn:aws:kms:us-west-2:444455556666:alias/projectKey1.

Note that if the KmsKeyId is specified, the CreateFileSystemRequest$Encrypted parameter must be set to true.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateFileSystemRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateFileSystemRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.