software.amazon.awssdk.services.ecs.model

Class ClusterSetting

java.lang.Object

software.amazon.awssdk.services.ecs.model.ClusterSetting

All Implemented Interfaces:

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

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

The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClusterSetting.Builder

Method Summary

Modifier and Type	Method and Description
static ClusterSetting.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ClusterSettingName	name() The name of the cluster setting.
String	nameAsString() The name of the cluster setting.
List<SdkField<?>>	sdkFields()
static Class<? extends ClusterSetting.Builder>	serializableBuilderClass()
ClusterSetting.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	value() The value to set for the cluster setting.

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

name

public final ClusterSettingName name()

The name of the cluster setting. The only supported value is containerInsights.

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

Returns:

The name of the cluster setting. The only supported value is containerInsights.

See Also:

ClusterSettingName

nameAsString

public final String nameAsString()

The name of the cluster setting. The only supported value is containerInsights.

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

Returns:

The name of the cluster setting. The only supported value is containerInsights.

See Also:

ClusterSettingName

value

public final String value()

The value to set for the cluster setting. The supported values are enabled and disabled . If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the containerInsights account setting is enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

Returns:

The value to set for the cluster setting. The supported values are enabled and disabled. If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the containerInsights account setting is enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

toBuilder

public ClusterSetting.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<ClusterSetting.Builder,ClusterSetting>

Returns:

a builder for type T

builder

public static ClusterSetting.Builder builder()

serializableBuilderClass

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