Package software.amazon.awscdk.services.ecs

Interface CfnTaskDefinition.S3FilesVolumeConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTaskDefinition.S3FilesVolumeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnTaskDefinition

@Stability(Stable)
public static interface CfnTaskDefinition.S3FilesVolumeConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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

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.

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.*;
 S3FilesVolumeConfigurationProperty s3FilesVolumeConfigurationProperty = S3FilesVolumeConfigurationProperty.builder()
         .fileSystemArn("fileSystemArn")
         // the properties below are optional
         .accessPointArn("accessPointArn")
         .rootDirectory("rootDirectory")
         .transitEncryptionPort(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTaskDefinition.S3FilesVolumeConfigurationProperty.Builder	builder()
default String	getAccessPointArn()	The full ARN of the S3 Files access point to use.
String	getFileSystemArn()	The full ARN of the S3 Files file system to mount.
default String	getRootDirectory()	The directory within the Amazon S3 Files file system to mount as the root directory.
default Number	getTransitEncryptionPort()	The port to use for sending encrypted data between the ECS host and the S3 Files file system.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFileSystemArn

@Stability(Stable)
@NotNull
String getFileSystemArn()

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

See Also:

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

getAccessPointArn

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

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

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 Also:

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

getRootDirectory

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

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

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.

See Also:

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

getTransitEncryptionPort

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

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

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.

See Also:

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

builder

@Stability(Stable)
static CfnTaskDefinition.S3FilesVolumeConfigurationProperty.Builder builder()

Returns:

a CfnTaskDefinition.S3FilesVolumeConfigurationProperty.Builder of CfnTaskDefinition.S3FilesVolumeConfigurationProperty