Class EcsSettings

java.lang.Object
software.amazon.awssdk.services.batch.model.EcsSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EcsSettings.Builder,EcsSettings>
@Generated("software.amazon.awssdk:codegen") public final class EcsSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EcsSettings.Builder,EcsSettings>

The Amazon ECS settings for a compute environment, including the CloudWatch Container Insights mode. Use this structure with CreateComputeEnvironment and UpdateComputeEnvironment.

See Also:

  • Method Details

    • containerInsights

      public final ContainerInsights containerInsights()

      Specifies the CloudWatch Container Insights mode for the compute environment. Valid values are:

      ENABLED

      Turns on standard Container Insights, which collects CPU, memory, disk, and network utilization metrics for the compute environment.

      ENHANCED

      Turns on enhanced Container Insights, which collects the standard metrics along with additional per-task observability metrics.

      DISABLED

      Turns off Container Insights for the compute environment.

      If you don't specify a value, the default is DISABLED. For more information, see Container Insights in the Batch User Guide.

      If the service returns an enum value that is not available in the current SDK version, containerInsights will return ContainerInsights.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from containerInsightsAsString().

      Returns:
      Specifies the CloudWatch Container Insights mode for the compute environment. Valid values are:

      ENABLED

      Turns on standard Container Insights, which collects CPU, memory, disk, and network utilization metrics for the compute environment.

      ENHANCED

      Turns on enhanced Container Insights, which collects the standard metrics along with additional per-task observability metrics.

      DISABLED

      Turns off Container Insights for the compute environment.

      If you don't specify a value, the default is DISABLED. For more information, see Container Insights in the Batch User Guide.

      See Also:

    • containerInsightsAsString

      public final String containerInsightsAsString()

      Specifies the CloudWatch Container Insights mode for the compute environment. Valid values are:

      ENABLED

      Turns on standard Container Insights, which collects CPU, memory, disk, and network utilization metrics for the compute environment.

      ENHANCED

      Turns on enhanced Container Insights, which collects the standard metrics along with additional per-task observability metrics.

      DISABLED

      Turns off Container Insights for the compute environment.

      If you don't specify a value, the default is DISABLED. For more information, see Container Insights in the Batch User Guide.

      If the service returns an enum value that is not available in the current SDK version, containerInsights will return ContainerInsights.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from containerInsightsAsString().

      Returns:
      Specifies the CloudWatch Container Insights mode for the compute environment. Valid values are:

      ENABLED

      Turns on standard Container Insights, which collects CPU, memory, disk, and network utilization metrics for the compute environment.

      ENHANCED

      Turns on enhanced Container Insights, which collects the standard metrics along with additional per-task observability metrics.

      DISABLED

      Turns off Container Insights for the compute environment.

      If you don't specify a value, the default is DISABLED. For more information, see Container Insights in the Batch User Guide.

      See Also:

    • toBuilder

      public EcsSettings.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<EcsSettings.Builder,EcsSettings>
      Returns:
      a builder for type T

    • builder

      public static EcsSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EcsSettings.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.