Package software.amazon.awscdk.services.ecs

Interface EfsVolumeConfiguration

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EfsVolumeConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:16.437Z")
@Stability(Stable)
public interface EfsVolumeConfiguration
extends software.amazon.jsii.JsiiSerializable

The configuration for an Elastic FileSystem volume.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 EfsVolumeConfiguration efsVolumeConfiguration = EfsVolumeConfiguration.builder()
         .fileSystemId("fileSystemId")
         // the properties below are optional
         .authorizationConfig(AuthorizationConfig.builder()
                 .accessPointId("accessPointId")
                 .iam("iam")
                 .build())
         .rootDirectory("rootDirectory")
         .transitEncryption("transitEncryption")
         .transitEncryptionPort(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	EfsVolumeConfiguration.Builder	A builder for EfsVolumeConfiguration
static final class	EfsVolumeConfiguration.Jsii$Proxy	An implementation for EfsVolumeConfiguration

Method Summary

Modifier and Type	Method	Description
static EfsVolumeConfiguration.Builder	builder()
default AuthorizationConfig	getAuthorizationConfig()	The authorization configuration details for the Amazon EFS file system.
String	getFileSystemId()	The Amazon EFS file system ID to use.
default String	getRootDirectory()	The directory within the Amazon EFS file system to mount as the root directory inside the host.
default String	getTransitEncryption()	Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
default Number	getTransitEncryptionPort()	The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFileSystemId

@Stability(Stable)
@NotNull
String getFileSystemId()

The Amazon EFS file system ID to use.

getAuthorizationConfig

@Stability(Stable)
@Nullable
default AuthorizationConfig getAuthorizationConfig()

The authorization configuration details for the Amazon EFS file system.

Default: No configuration.

getRootDirectory

@Stability(Stable)
@Nullable
default String getRootDirectory()

The directory within the Amazon EFS file system to mount as the root directory inside the host.

Specifying / will have the same effect as omitting this parameter.

Default: The root of the Amazon EFS volume

getTransitEncryption

@Stability(Stable)
@Nullable
default String getTransitEncryption()

Whether or not 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.

Valid values: ENABLED | DISABLED

Default: DISABLED

getTransitEncryptionPort

@Stability(Stable)
@Nullable
default Number getTransitEncryptionPort()

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.

EFS mount helper uses.

Default: Port selection strategy that the Amazon EFS mount helper uses.

builder

@Stability(Stable)
static EfsVolumeConfiguration.Builder builder()

Returns:

a EfsVolumeConfiguration.Builder of EfsVolumeConfiguration