Class CfnTaskDefinitionPropsMixin.S3FilesVolumeConfigurationProperty

This parameter is specified when you're using an Amazon S3 Files file system for task storage.

Inheritance

object

CfnTaskDefinitionPropsMixin.S3FilesVolumeConfigurationProperty

Implements

CfnTaskDefinitionPropsMixin.IS3FilesVolumeConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.ECS

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnTaskDefinitionPropsMixin.S3FilesVolumeConfigurationProperty : CfnTaskDefinitionPropsMixin.IS3FilesVolumeConfigurationProperty

Syntax (vb)

Public Class CfnTaskDefinitionPropsMixin.S3FilesVolumeConfigurationProperty Implements CfnTaskDefinitionPropsMixin.IS3FilesVolumeConfigurationProperty

Remarks

For more information, see Amazon S3 Files volumes in the Amazon Elastic Container Service Developer Guide. Your task definition must include a Task IAM Role. See IAM role for attaching your file system to compute resources for required permissions.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-s3filesvolumeconfiguration.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.CfnPropertyMixins.AWS.ECS;

             var s3FilesVolumeConfigurationProperty = new S3FilesVolumeConfigurationProperty {
                 AccessPointArn = "accessPointArn",
                 FileSystemArn = "fileSystemArn",
                 RootDirectory = "rootDirectory",
                 TransitEncryptionPort = 123
             };

Synopsis

Constructors

S3FilesVolumeConfigurationProperty()

This parameter is specified when you're using an Amazon S3 Files file system for task storage.

Properties

AccessPointArn	The full ARN of the S3 Files access point to use.
FileSystemArn	The full ARN of the S3 Files file system to mount.
RootDirectory	The directory within the Amazon S3 Files file system to mount as the root directory.
TransitEncryptionPort	The port to use for sending encrypted data between the ECS host and the S3 Files file system.

Constructors

S3FilesVolumeConfigurationProperty()

This parameter is specified when you're using an Amazon S3 Files file system for task storage.

public S3FilesVolumeConfigurationProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-s3filesvolumeconfiguration.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.CfnPropertyMixins.AWS.ECS;

             var s3FilesVolumeConfigurationProperty = new S3FilesVolumeConfigurationProperty {
                 AccessPointArn = "accessPointArn",
                 FileSystemArn = "fileSystemArn",
                 RootDirectory = "rootDirectory",
                 TransitEncryptionPort = 123
             };

Properties

AccessPointArn

The full ARN of the S3 Files access point to use.

public string? AccessPointArn { get; set; }

Property Value

string

Remarks

If an access point is specified, the root directory value specified in the S3FilesVolumeConfiguration must either be omitted or set to / which will enforce the path set on the S3 Files access point. For more information, see Creating S3 Files access points.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-s3filesvolumeconfiguration.html#cfn-ecs-taskdefinition-s3filesvolumeconfiguration-accesspointarn

FileSystemArn

The full ARN of the S3 Files file system to mount.

public string? FileSystemArn { get; set; }

Property Value

string

Remarks

RootDirectory

The directory within the Amazon S3 Files file system to mount as the root directory.

public string? RootDirectory { get; set; }

Property Value

string

Remarks

If this parameter is omitted, the root of the Amazon S3 Files file system will be used. Specifying / will have the same effect as omitting this parameter. If a S3 Files access point is specified in the accessPointArn, the root directory parameter must either be omitted or set to / which will enforce the path set on the S3 Files access point.

TransitEncryptionPort

The port to use for sending encrypted data between the ECS host and the S3 Files file system.

public double? TransitEncryptionPort { get; set; }

Property Value

double?

Remarks

If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon S3 Files mount helper uses. For more information, see S3 Files mount helper.

Implements

CfnTaskDefinitionPropsMixin.IS3FilesVolumeConfigurationProperty