Class ClusterSetting
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ClusterSetting.Builder,
ClusterSetting>
The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights with enhanced observability or CloudWatch Container Insights for a cluster.
Container Insights with enhanced observability provides all the Container Insights metrics, plus additional task and container metrics. This version supports enhanced observability for Amazon ECS clusters using the Amazon EC2 and Fargate launch types. After you configure Container Insights with enhanced observability on Amazon ECS, Container Insights auto-collects detailed infrastructure telemetry from the cluster level down to the container level in your environment and displays these critical performance data in curated dashboards removing the heavy lifting in observability set-up.
For more information, see Monitor Amazon ECS containers using Container Insights with enhanced observability in the Amazon Elastic Container Service Developer Guide.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic ClusterSetting.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final ClusterSettingName
name()
The name of the cluster setting.final String
The name of the cluster setting.static Class
<? extends ClusterSetting.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
value()
The value to set for the cluster setting.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the cluster setting. The value is
containerInsights
.If the service returns an enum value that is not available in the current SDK version,
name
will returnClusterSettingName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The name of the cluster setting. The value is
containerInsights
. - See Also:
-
nameAsString
The name of the cluster setting. The value is
containerInsights
.If the service returns an enum value that is not available in the current SDK version,
name
will returnClusterSettingName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The name of the cluster setting. The value is
containerInsights
. - See Also:
-
value
The value to set for the cluster setting. The supported values are
enhanced
,enabled
, anddisabled
.To use Container Insights with enhanced observability, set the
containerInsights
account setting toenhanced
.To use Container Insights, set the
containerInsights
account setting toenabled
.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
enhanced
,enabled
, anddisabled
.To use Container Insights with enhanced observability, set the
containerInsights
account setting toenhanced
.To use Container Insights, set the
containerInsights
account setting toenabled
.If a cluster value is specified, it will override the
containerInsights
value set with PutAccountSetting or PutAccountSettingDefault.
-
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 interfaceToCopyableBuilder<ClusterSetting.Builder,
ClusterSetting> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-