Class: AWSCDK::Lambda::UtilizationScalingOptions

Inherits:
ApplicationAutoScaling::BaseTargetTrackingProps
  • Object
show all
Defined in:
lambda/utilization_scaling_options.rb

Overview

Options for enabling Lambda utilization tracking.

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, utilization_target:) ⇒ UtilizationScalingOptions

Returns a new instance of UtilizationScalingOptions.

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.

  • utilization_target (Numeric) —

    Utilization target for the attribute.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lambda/utilization_scaling_options.rb', line 12

def initialize(disable_scale_in: nil, policy_name: nil, scale_in_cooldown: nil, scale_out_cooldown: nil, utilization_target:)
  @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?
  @utilization_target = utilization_target
  Jsii::Type.check_type(@utilization_target, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "utilizationTarget")
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) 


34
35
36
 
# File 'lambda/utilization_scaling_options.rb', line 34

def disable_scale_in
  @disable_scale_in
end

#policy_name ⇒ String? (readonly)

Note:

Default: - Automatically generated name.

A name for the scaling policy.

Returns:

  • (String, nil) 


39
40
41
 
# File 'lambda/utilization_scaling_options.rb', line 39

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:



44
45
46
 
# File 'lambda/utilization_scaling_options.rb', line 44

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:



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

def scale_out_cooldown
  @scale_out_cooldown
end

#utilization_target ⇒ Numeric (readonly)

Utilization target for the attribute.

For example, .5 indicates that 50 percent of allocated provisioned concurrency is in use.

Returns:

  • (Numeric) 


55
56
57
 
# File 'lambda/utilization_scaling_options.rb', line 55

def utilization_target
  @utilization_target
end

Class Method Details

.jsii_properties ⇒ Object 



57
58
59
60
61
62
63
64
65
 
# File 'lambda/utilization_scaling_options.rb', line 57

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

Instance Method Details

#to_jsii ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lambda/utilization_scaling_options.rb', line 67

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