Interface CfnTaskDefinition.IEFSVolumeConfigurationProperty

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

Namespace: Amazon.CDK.AWS.ECS

Assembly: Amazon.CDK.AWS.ECS.dll

Syntax (csharp)

public interface IEFSVolumeConfigurationProperty

Syntax (vb)

Public Interface IEFSVolumeConfigurationProperty

Remarks

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html

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 eFSVolumeConfigurationProperty = new EFSVolumeConfigurationProperty {
    FilesystemId = "filesystemId",

    // the properties below are optional
    AuthorizationConfig = new AuthorizationConfigProperty {
        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	Determines whether to use 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 object AuthorizationConfig { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-authorizationconfig

FilesystemId

The Amazon EFS file system ID to use.

string FilesystemId { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-filesystemid

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

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-rootdirectory

TransitEncryption

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-transitencryption

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

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html#cfn-ecs-taskdefinition-efsvolumeconfiguration-transitencryptionport