Class: AWSCDK::ECS::CfnCluster::ClusterSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ecs/cfn_cluster.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 .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name: nil, value: nil) ⇒ ClusterSettingsProperty

Returns a new instance of ClusterSettingsProperty.

Parameters:

  • name (String, nil) (defaults to: nil) —

    The name of the cluster setting.

  • value (String, nil) (defaults to: nil) —

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



762
763
764
765
766
767
 
# File 'ecs/cfn_cluster.rb', line 762

def initialize(name: nil, value: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value") unless @value.nil?
end

Instance Attribute Details

#name ⇒ String? (readonly)

The name of the cluster setting.

The value is container_insights .

Returns:

  • (String, nil)

See Also:



775
776
777
 
# File 'ecs/cfn_cluster.rb', line 775

def name
  @name
end

#value ⇒ String? (readonly)

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 container_insights account setting to enhanced .

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

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

Returns:

  • (String, nil)

See Also:



786
787
788
 
# File 'ecs/cfn_cluster.rb', line 786

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object 



788
789
790
791
792
793
 
# File 'ecs/cfn_cluster.rb', line 788

def self.jsii_properties
  {
    :name => "name",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



795
796
797
798
799
800
801
802
 
# File 'ecs/cfn_cluster.rb', line 795

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "value" => @value,
  })
  result.compact
end