Package software.amazon.awscdk.services.ecs

Interface CfnTaskDefinition.HostVolumePropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTaskDefinition.HostVolumePropertiesProperty.Jsii$Proxy

Enclosing class:

CfnTaskDefinition

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

The HostVolumeProperties property specifies details on a container instance bind mount host volume.

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.*;
 HostVolumePropertiesProperty hostVolumePropertiesProperty = HostVolumePropertiesProperty.builder()
         .sourcePath("sourcePath")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTaskDefinition.HostVolumePropertiesProperty.Builder	builder()
default String	getSourcePath()	When the host parameter is used, specify a sourcePath to declare the path on the host container instance that's presented to the container.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSourcePath

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

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that's presented to the container.

If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you're using the Fargate launch type, the sourcePath parameter is not supported.

builder

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

Returns:

a CfnTaskDefinition.HostVolumePropertiesProperty.Builder of CfnTaskDefinition.HostVolumePropertiesProperty