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:

  • Method Details

    • 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()
      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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.