Class: AWSCDK::Lambda::TargetTrackingScalingPolicy

Inherits:
Jsii::Object
  • Object
show all
Defined in:
lambda/target_tracking_scaling_policy.rb

Overview

A target tracking scaling policy that automatically adjusts the capacity provider's compute resources to maintain a specified target value by tracking the required CloudWatch metric.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ TargetTrackingScalingPolicy

Returns a new instance of TargetTrackingScalingPolicy.

Raises:

  • (NoMethodError) 


8
9
10
 
# File 'lambda/target_tracking_scaling_policy.rb', line 8

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_lambda.TargetTrackingScalingPolicy does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.cpu_utilization(target_cpu_utilization) ⇒ AWSCDK::Lambda::TargetTrackingScalingPolicy

Creates a target tracking scaling policy for CPU utilization.

Parameters:

  • target_cpu_utilization (Numeric) —

    The target value for CPU utilization.

Returns:

  • (AWSCDK::Lambda::TargetTrackingScalingPolicy) 


25
26
27
28
 
# File 'lambda/target_tracking_scaling_policy.rb', line 25

def self.cpu_utilization(target_cpu_utilization)
  Jsii::Type.check_type(target_cpu_utilization, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "targetCpuUtilization")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lambda.TargetTrackingScalingPolicy", "cpuUtilization", [target_cpu_utilization])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
18
19
 
# File 'lambda/target_tracking_scaling_policy.rb', line 12

def self.jsii_overridable_methods
  {
    :metric_type => { kind: :property, name: "metricType", is_optional: false },
    :predefined_metric_type => { kind: :property, name: "predefinedMetricType", is_optional: false },
    :target_value => { kind: :property, name: "targetValue", is_optional: false },
    :value => { kind: :property, name: "value", is_optional: false },
  }
end

Instance Method Details

#metric_type ⇒ String

The predefined metric type.

Returns:

  • (String) 


33
34
35
 
# File 'lambda/target_tracking_scaling_policy.rb', line 33

def metric_type()
  jsii_get_property("metricType")
end

#predefined_metric_type ⇒ String

The predefined metric type for this scaling policy.

Returns:

  • (String) 


40
41
42
 
# File 'lambda/target_tracking_scaling_policy.rb', line 40

def predefined_metric_type()
  jsii_get_property("predefinedMetricType")
end

#target_value ⇒ Numeric

The target value for the specified metric as a percentage.

The capacity provider will scale resources to maintain this target value.

Returns:

  • (Numeric) 


49
50
51
 
# File 'lambda/target_tracking_scaling_policy.rb', line 49

def target_value()
  jsii_get_property("targetValue")
end

#value ⇒ Numeric

The target value for the metric.

Returns:

  • (Numeric) 


56
57
58
 
# File 'lambda/target_tracking_scaling_policy.rb', line 56

def value()
  jsii_get_property("value")
end