Package 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("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	Description
static interface	HostVolumeProperties.Builder

Method Summary

Modifier and Type	Method	Description
static HostVolumeProperties.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(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's presented to the container.
HostVolumeProperties.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

sourcePath

public final String sourcePath()

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.

Returns:

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.

toBuilder

public HostVolumeProperties.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HostVolumeProperties.Builder,HostVolumeProperties>

builder

public static HostVolumeProperties.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo