Package software.amazon.awscdk.services.ecs

Interface CfnCluster.ClusterSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCluster.ClusterSettingsProperty.Jsii$Proxy

Enclosing class:

CfnCluster

@Stability(Stable)
public static interface CfnCluster.ClusterSettingsProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 ClusterSettingsProperty clusterSettingsProperty = ClusterSettingsProperty.builder()
         .name("name")
         .value("value")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCluster.ClusterSettingsProperty.Builder	A builder for CfnCluster.ClusterSettingsProperty
static final class	CfnCluster.ClusterSettingsProperty.Jsii$Proxy	An implementation for CfnCluster.ClusterSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnCluster.ClusterSettingsProperty.Builder	builder()
default String	getName()	The name of the cluster setting.
default String	getValue()	The value to set for the cluster setting.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the cluster setting.

The value is containerInsights .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html#cfn-ecs-cluster-clustersettings-name

getValue

@Stability(Stable)
@Nullable
default String getValue()

The value to set for the cluster setting. The supported values are enhanced , enabled , and disabled .

To use Container Insights with enhanced observability, set the containerInsights account setting to enhanced .

To use Container Insights, set the containerInsights account setting to enabled .

If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html#cfn-ecs-cluster-clustersettings-value

builder

@Stability(Stable)
static CfnCluster.ClusterSettingsProperty.Builder builder()

Returns:

a CfnCluster.ClusterSettingsProperty.Builder of CfnCluster.ClusterSettingsProperty