Interface IEfsVolumeConfiguration

The configuration for an Elastic FileSystem volume.

Namespace: Amazon.CDK.AWS.ECS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IEfsVolumeConfiguration

Syntax (vb)

Public Interface IEfsVolumeConfiguration

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ECS;

var efsVolumeConfiguration = new EfsVolumeConfiguration {
    FileSystemId = "fileSystemId",

    // the properties below are optional
    AuthorizationConfig = new AuthorizationConfig {
        AccessPointId = "accessPointId",
        Iam = "iam"
    },
    RootDirectory = "rootDirectory",
    TransitEncryption = "transitEncryption",
    TransitEncryptionPort = 123
};

Synopsis

Properties

AuthorizationConfig	The authorization configuration details for the Amazon EFS file system.
FileSystemId	The Amazon EFS file system ID to use.
RootDirectory	The directory within the Amazon EFS file system to mount as the root directory inside the host.
TransitEncryption	Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
TransitEncryptionPort	The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.

Properties

AuthorizationConfig

The authorization configuration details for the Amazon EFS file system.

virtual IAuthorizationConfig AuthorizationConfig { get; }

Property Value

IAuthorizationConfig

Remarks

Default: No configuration.

FileSystemId

The Amazon EFS file system ID to use.

string FileSystemId { get; }

Property Value

System.String

RootDirectory

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

virtual string RootDirectory { get; }

Property Value

System.String

Remarks

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

Default: The root of the Amazon EFS volume

TransitEncryption

Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.

virtual string TransitEncryption { get; }

Property Value

System.String

Remarks

Transit encryption must be enabled if Amazon EFS IAM authorization is used.

Valid values: ENABLED | DISABLED

Default: DISABLED

TransitEncryptionPort

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

virtual Nullable<double> TransitEncryptionPort { get; }

Property Value

System.Nullable<System.Double>

Remarks

EFS mount helper uses.

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