software.amazon.awssdk.services.ecs.model

Class HostVolumeProperties

java.lang.Object

software.amazon.awssdk.services.ecs.model.HostVolumeProperties

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HostVolumeProperties.Builder,HostVolumeProperties>

@Generated(value="software.amazon.awssdk:codegen")
public final class HostVolumeProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HostVolumeProperties.Builder,HostVolumeProperties>

Details on a container instance bind mount host volume.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HostVolumeProperties.Builder

Method Summary

Modifier and Type	Method and Description
static HostVolumeProperties.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends HostVolumeProperties.Builder>	serializableBuilderClass()
String	sourcePath() When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container.
HostVolumeProperties.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

sourcePath

public String sourcePath()

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is 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 does not 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 are using the Fargate launch type, the sourcePath parameter is not supported.

Returns:

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is 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 does not 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 are using the Fargate launch type, the sourcePath parameter is not supported.

toBuilder

public HostVolumeProperties.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<HostVolumeProperties.Builder,HostVolumeProperties>

Returns:

a builder for type T

builder

public static HostVolumeProperties.Builder builder()

serializableBuilderClass

public static Class<? extends HostVolumeProperties.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.