Package software.amazon.awscdk.services.ecs

Interface CfnDaemonTaskDefinition.VolumeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDaemonTaskDefinition.VolumeProperty.Jsii$Proxy

Enclosing class:

CfnDaemonTaskDefinition

@Stability(Stable)
public static interface CfnDaemonTaskDefinition.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()
         .host(HostVolumePropertiesProperty.builder()
                 .sourcePath("sourcePath")
                 .build())
         .name("name")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDaemonTaskDefinition.VolumeProperty.Builder	builder()
default Object	getHost()	Details on a container instance bind mount host volume.
default String	getName()	The name of the volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHost

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

Details on a container instance bind mount host volume.

Returns union: either IResolvable or CfnDaemonTaskDefinition.HostVolumePropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-daemontaskdefinition-volume.html#cfn-ecs-daemontaskdefinition-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-daemontaskdefinition-volume.html#cfn-ecs-daemontaskdefinition-volume-name

builder

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

Returns:

a CfnDaemonTaskDefinition.VolumeProperty.Builder of CfnDaemonTaskDefinition.VolumeProperty