software.amazon.awssdk.services.batch.model

Interface EFSVolumeConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<EFSVolumeConfiguration.Builder,EFSVolumeConfiguration>, SdkBuilder<EFSVolumeConfiguration.Builder,EFSVolumeConfiguration>, SdkPojo

Enclosing class:

EFSVolumeConfiguration

public static interface EFSVolumeConfiguration.Builder
extends SdkPojo, CopyableBuilder<EFSVolumeConfiguration.Builder,EFSVolumeConfiguration>

Method Summary

Modifier and Type	Method and Description
default EFSVolumeConfiguration.Builder	authorizationConfig(Consumer<EFSAuthorizationConfig.Builder> authorizationConfig) The authorization configuration details for the Amazon EFS file system.
EFSVolumeConfiguration.Builder	authorizationConfig(EFSAuthorizationConfig authorizationConfig) The authorization configuration details for the Amazon EFS file system.
EFSVolumeConfiguration.Builder	fileSystemId(String fileSystemId) The Amazon EFS file system ID to use.
EFSVolumeConfiguration.Builder	rootDirectory(String rootDirectory) The directory within the Amazon EFS file system to mount as the root directory inside the host.
EFSVolumeConfiguration.Builder	transitEncryption(EFSTransitEncryption transitEncryption) Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
EFSVolumeConfiguration.Builder	transitEncryption(String transitEncryption) Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
EFSVolumeConfiguration.Builder	transitEncryptionPort(Integer transitEncryptionPort) The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

fileSystemId

EFSVolumeConfiguration.Builder fileSystemId(String fileSystemId)

The Amazon EFS file system ID to use.

Parameters:

fileSystemId - The Amazon EFS file system ID to use.

Returns:

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

rootDirectory

EFSVolumeConfiguration.Builder rootDirectory(String rootDirectory)

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.

Parameters:

rootDirectory - The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.

Returns:

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

transitEncryption

EFSVolumeConfiguration.Builder transitEncryption(String transitEncryption)

Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

Parameters:

transitEncryption - Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

Returns:

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

See Also:

EFSTransitEncryption, EFSTransitEncryption

transitEncryption

EFSVolumeConfiguration.Builder transitEncryption(EFSTransitEncryption transitEncryption)

Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

Parameters:

transitEncryption - Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

Returns:

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

See Also:

EFSTransitEncryption, EFSTransitEncryption

transitEncryptionPort

EFSVolumeConfiguration.Builder transitEncryptionPort(Integer transitEncryptionPort)

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.

Parameters:

transitEncryptionPort - The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.

Returns:

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

authorizationConfig

EFSVolumeConfiguration.Builder authorizationConfig(EFSAuthorizationConfig authorizationConfig)

The authorization configuration details for the Amazon EFS file system.

Parameters:

authorizationConfig - The authorization configuration details for the Amazon EFS file system.

Returns:

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

authorizationConfig

default EFSVolumeConfiguration.Builder authorizationConfig(Consumer<EFSAuthorizationConfig.Builder> authorizationConfig)

The authorization configuration details for the Amazon EFS file system.

This is a convenience method that creates an instance of the EFSAuthorizationConfig.Builder avoiding the need to create one manually via EFSAuthorizationConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authorizationConfig(EFSAuthorizationConfig).

Parameters:

authorizationConfig - a consumer that will call methods on EFSAuthorizationConfig.Builder

Returns:

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

See Also:

authorizationConfig(EFSAuthorizationConfig)