software.amazon.awscdk.services.ecs

Interface CfnTaskDefinition.EFSVolumeConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTaskDefinition.EFSVolumeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnTaskDefinition

@Stability(value=Stable)
public static interface CfnTaskDefinition.EFSVolumeConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

This parameter is specified when you're using an Amazon Elastic File System file system for task storage.

For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide .

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.*;
 EFSVolumeConfigurationProperty eFSVolumeConfigurationProperty = EFSVolumeConfigurationProperty.builder()
         .filesystemId("filesystemId")
         // the properties below are optional
         .authorizationConfig(AuthorizationConfigProperty.builder()
                 .accessPointId("accessPointId")
                 .iam("iam")
                 .build())
         .rootDirectory("rootDirectory")
         .transitEncryption("transitEncryption")
         .transitEncryptionPort(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnTaskDefinition.EFSVolumeConfigurationProperty.Builder	builder()
default Object	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() Determines whether to use 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 Detail

getFilesystemId

@Stability(value=Stable)
 @NotNull
String getFilesystemId()

The Amazon EFS file system ID to use.

getAuthorizationConfig

@Stability(value=Stable)
 @Nullable
default Object getAuthorizationConfig()

The authorization configuration details for the Amazon EFS file system.

getRootDirectory

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

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 will be used. Specifying / will have the same effect as omitting this parameter.

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

getTransitEncryption

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

Determines whether to use 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 .

getTransitEncryptionPort

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

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

If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide .

builder

@Stability(value=Stable)
static CfnTaskDefinition.EFSVolumeConfigurationProperty.Builder builder()

Returns:

a CfnTaskDefinition.EFSVolumeConfigurationProperty.Builder of CfnTaskDefinition.EFSVolumeConfigurationProperty