Class: AWSCDK::ECS::TrackCustomMetricProps

Inherits:
ApplicationAutoScaling::BaseTargetTrackingProps
  • Object
show all
Defined in:
ecs/track_custom_metric_props.rb

Overview

The properties for enabling target tracking scaling based on a custom CloudWatch metric.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(disable_scale_in: nil, policy_name: nil, scale_in_cooldown: nil, scale_out_cooldown: nil, metric:, target_value:) ⇒ TrackCustomMetricProps

Returns a new instance of TrackCustomMetricProps.

Parameters:

  • disable_scale_in (Boolean, nil) (defaults to: nil) —

    Indicates whether scale in by the target tracking policy is disabled.

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

    A name for the scaling policy.

  • scale_in_cooldown (AWSCDK::Duration, nil) (defaults to: nil) —

    Period after a scale in activity completes before another scale in activity can start.

  • scale_out_cooldown (AWSCDK::Duration, nil) (defaults to: nil) —

    Period after a scale out activity completes before another scale out activity can start.

  • metric (AWSCDK::CloudWatch::IMetric) —

    The custom CloudWatch metric to track.

  • target_value (Numeric) —

    The target value for the custom CloudWatch metric.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'ecs/track_custom_metric_props.rb', line 13

def initialize(disable_scale_in: nil, policy_name: nil, scale_in_cooldown: nil, scale_out_cooldown: nil, metric:, target_value:)
  @disable_scale_in = disable_scale_in
  Jsii::Type.check_type(@disable_scale_in, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "disableScaleIn") unless @disable_scale_in.nil?
  @policy_name = policy_name
  Jsii::Type.check_type(@policy_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "policyName") unless @policy_name.nil?
  @scale_in_cooldown = scale_in_cooldown
  Jsii::Type.check_type(@scale_in_cooldown, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "scaleInCooldown") unless @scale_in_cooldown.nil?
  @scale_out_cooldown = scale_out_cooldown
  Jsii::Type.check_type(@scale_out_cooldown, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "scaleOutCooldown") unless @scale_out_cooldown.nil?
  @metric = metric
  Jsii::Type.check_type(@metric, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5JTWV0cmljIn0=")), "metric")
  @target_value = target_value
  Jsii::Type.check_type(@target_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "targetValue")
end

Instance Attribute Details

#disable_scale_in ⇒ Boolean? (readonly)

Note:

Default: false

Indicates whether scale in by the target tracking policy is disabled.

If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource.

Returns:

  • (Boolean, nil) 


37
38
39
 
# File 'ecs/track_custom_metric_props.rb', line 37

def disable_scale_in
  @disable_scale_in
end

#metric ⇒ AWSCDK::CloudWatch::IMetric (readonly)

The custom CloudWatch metric to track.

The metric must represent utilization; that is, you will always get the following behavior:

  • metric > targetValue => scale out
  • metric < targetValue => scale in

Returns:



61
62
63
 
# File 'ecs/track_custom_metric_props.rb', line 61

def metric
  @metric
end

#policy_name ⇒ String? (readonly)

Note:

Default: - Automatically generated name.

A name for the scaling policy.

Returns:

  • (String, nil) 


42
43
44
 
# File 'ecs/track_custom_metric_props.rb', line 42

def policy_name
  @policy_name
end

#scale_in_cooldown ⇒ AWSCDK::Duration? (readonly)

Note:

Default: Duration.seconds(300) for the following scalable targets: ECS services, Spot Fleet requests, EMR clusters, AppStream 2.0 fleets, Aurora DB clusters, Amazon SageMaker endpoint variants, Custom resources. For all other scalable targets, the default value is Duration.seconds(0): DynamoDB tables, DynamoDB global secondary indexes, Amazon Comprehend document classification endpoints, Lambda provisioned concurrency

Period after a scale in activity completes before another scale in activity can start.

Returns:



47
48
49
 
# File 'ecs/track_custom_metric_props.rb', line 47

def scale_in_cooldown
  @scale_in_cooldown
end

#scale_out_cooldown ⇒ AWSCDK::Duration? (readonly)

Note:

Default: Duration.seconds(300) for the following scalable targets: ECS services, Spot Fleet requests, EMR clusters, AppStream 2.0 fleets, Aurora DB clusters, Amazon SageMaker endpoint variants, Custom resources. For all other scalable targets, the default value is Duration.seconds(0): DynamoDB tables, DynamoDB global secondary indexes, Amazon Comprehend document classification endpoints, Lambda provisioned concurrency

Period after a scale out activity completes before another scale out activity can start.

Returns:



52
53
54
 
# File 'ecs/track_custom_metric_props.rb', line 52

def scale_out_cooldown
  @scale_out_cooldown
end

#target_value ⇒ Numeric (readonly)

The target value for the custom CloudWatch metric.

Returns:

  • (Numeric) 


65
66
67
 
# File 'ecs/track_custom_metric_props.rb', line 65

def target_value
  @target_value
end

Class Method Details

.jsii_properties ⇒ Object 



67
68
69
70
71
72
73
74
75
76
 
# File 'ecs/track_custom_metric_props.rb', line 67

def self.jsii_properties
  {
    :disable_scale_in => "disableScaleIn",
    :policy_name => "policyName",
    :scale_in_cooldown => "scaleInCooldown",
    :scale_out_cooldown => "scaleOutCooldown",
    :metric => "metric",
    :target_value => "targetValue",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'ecs/track_custom_metric_props.rb', line 78

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "disableScaleIn" => @disable_scale_in,
    "policyName" => @policy_name,
    "scaleInCooldown" => @scale_in_cooldown,
    "scaleOutCooldown" => @scale_out_cooldown,
    "metric" => @metric,
    "targetValue" => @target_value,
  })
  result.compact
end