Class: Aws::ECS::Types::ClusterSetting

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

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*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ String

The name of the cluster setting. The value is ‘containerInsights` .

Returns:

  • (String) 


921
922
923
924
925
926
 
# File 'lib/aws-sdk-ecs/types.rb', line 921

class ClusterSetting < Struct.new(
  :name,
  :value)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ String

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].

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html [2]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html

Returns:

  • (String) 


921
922
923
924
925
926
 
# File 'lib/aws-sdk-ecs/types.rb', line 921

class ClusterSetting < Struct.new(
  :name,
  :value)
  SENSITIVE = []
  include Aws::Structure
end