Package software.amazon.awscdk.services.ecs

Interface CfnTaskDefinition.VolumeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTaskDefinition.VolumeProperty.Jsii$Proxy

Enclosing class:

CfnTaskDefinition

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

The data volume configuration for tasks launched using this task definition.

Specifying a volume configuration in a task definition is optional. The volume configuration may contain multiple volumes but only one volume configured at launch is supported. Each volume defined in the volume configuration may only specify a name and one of either configuredAtLaunch , dockerVolumeConfiguration , efsVolumeConfiguration , fsxWindowsFileServerVolumeConfiguration , or host . If an empty volume configuration is specified, by default Amazon ECS uses a host volume. For more information, see Using data volumes in tasks .

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.*;
 VolumeProperty volumeProperty = VolumeProperty.builder()
         .configuredAtLaunch(false)
         .dockerVolumeConfiguration(DockerVolumeConfigurationProperty.builder()
                 .autoprovision(false)
                 .driver("driver")
                 .driverOpts(Map.of(
                         "driverOptsKey", "driverOpts"))
                 .labels(Map.of(
                         "labelsKey", "labels"))
                 .scope("scope")
                 .build())
         .efsVolumeConfiguration(EFSVolumeConfigurationProperty.builder()
                 .filesystemId("filesystemId")
                 // the properties below are optional
                 .authorizationConfig(AuthorizationConfigProperty.builder()
                         .accessPointId("accessPointId")
                         .iam("iam")
                         .build())
                 .rootDirectory("rootDirectory")
                 .transitEncryption("transitEncryption")
                 .transitEncryptionPort(123)
                 .build())
         .fSxWindowsFileServerVolumeConfiguration(FSxWindowsFileServerVolumeConfigurationProperty.builder()
                 .fileSystemId("fileSystemId")
                 .rootDirectory("rootDirectory")
                 // the properties below are optional
                 .authorizationConfig(FSxAuthorizationConfigProperty.builder()
                         .credentialsParameter("credentialsParameter")
                         .domain("domain")
                         .build())
                 .build())
         .host(HostVolumePropertiesProperty.builder()
                 .sourcePath("sourcePath")
                 .build())
         .name("name")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTaskDefinition.VolumeProperty.Builder	builder()
default Object	getConfiguredAtLaunch()	Indicates whether the volume should be configured at launch time.
default Object	getDockerVolumeConfiguration()	This parameter is specified when you use Docker volumes.
default Object	getEfsVolumeConfiguration()	This parameter is specified when you use an Amazon Elastic File System file system for task storage.
default Object	getFSxWindowsFileServerVolumeConfiguration()	This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.
default Object	getHost()	This parameter is specified when you use bind mount host volumes.
default String	getName()	The name of the volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfiguredAtLaunch

@Stability(Stable)
@Nullable
default Object getConfiguredAtLaunch()

Indicates whether the volume should be configured at launch time.

This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.

To configure a volume at launch time, use this task definition revision and specify a volumeConfigurations object when calling the CreateService , UpdateService , RunTask or StartTask APIs.

Returns union: either Boolean or IResolvable

See Also:

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

getDockerVolumeConfiguration

@Stability(Stable)
@Nullable
default Object getDockerVolumeConfiguration()

This parameter is specified when you use Docker volumes.

Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.

Docker volumes aren't supported by tasks run on AWS Fargate .

Returns union: either IResolvable or CfnTaskDefinition.DockerVolumeConfigurationProperty

See Also:

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

getEfsVolumeConfiguration

@Stability(Stable)
@Nullable
default Object getEfsVolumeConfiguration()

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

Returns union: either IResolvable or CfnTaskDefinition.EFSVolumeConfigurationProperty

See Also:

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

getFSxWindowsFileServerVolumeConfiguration

@Stability(Stable)
@Nullable
default Object getFSxWindowsFileServerVolumeConfiguration()

This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

Returns union: either IResolvable or CfnTaskDefinition.FSxWindowsFileServerVolumeConfigurationProperty

See Also:

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

getHost

@Stability(Stable)
@Nullable
default Object getHost()

This parameter is specified when you use bind mount host volumes.

The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData . Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\ , but not D:\my\path:C:\my\path or D:\:C:\my\path .

Returns union: either IResolvable or CfnTaskDefinition.HostVolumePropertiesProperty

See Also:

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

getName

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

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

When using a volume configured at launch, the name is required and must also be specified as the volume name in the ServiceVolumeConfiguration or TaskVolumeConfiguration parameter when creating your service or standalone task.

For all other types of volumes, this name is referenced in the sourceVolume parameter of the mountPoints object in the container definition.

When a volume is using the efsVolumeConfiguration , the name is required.

See Also:

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

builder

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

Returns:

a CfnTaskDefinition.VolumeProperty.Builder of CfnTaskDefinition.VolumeProperty