Class: AWSCDK::Lambda::ScalingOptions

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

Overview

Configuration options for scaling a capacity provider, including scaling mode and policies.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ ScalingOptions

Returns a new instance of ScalingOptions.

Raises:

  • (NoMethodError) 


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

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

Class Method Details

.auto ⇒ AWSCDK::Lambda::ScalingOptions

Creates scaling options where the capacity provider manages scaling automatically.

Returns:

  • (AWSCDK::Lambda::ScalingOptions) 


22
23
24
 
# File 'lambda/scaling_options.rb', line 22

def self.auto()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lambda.ScalingOptions", "auto", [])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
 
# File 'lambda/scaling_options.rb', line 12

def self.jsii_overridable_methods
  {
    :scaling_mode => { kind: :property, name: "scalingMode", is_optional: false },
    :scaling_policies => { kind: :property, name: "scalingPolicies", is_optional: true },
  }
end

.manual(scaling_policies) ⇒ AWSCDK::Lambda::ScalingOptions

Creates manual scaling options with custom target tracking scaling policies.

At least one policy is required.

Parameters:

Returns:

  • (AWSCDK::Lambda::ScalingOptions) 


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

def self.manual(scaling_policies)
  Jsii::Type.check_type(scaling_policies, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuVGFyZ2V0VHJhY2tpbmdTY2FsaW5nUG9saWN5In0sImtpbmQiOiJhcnJheSJ9fQ==")), "scalingPolicies")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lambda.ScalingOptions", "manual", [scaling_policies])
end

Instance Method Details

#scaling_mode ⇒ String

The scaling mode for the capacity provider.

Returns:

  • (String) 


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

def scaling_mode()
  jsii_get_property("scalingMode")
end

#scaling_policies ⇒ Array<AWSCDK::Lambda::TargetTrackingScalingPolicy>?

The target tracking scaling policies used when scaling mode is 'Manual'.

Returns:



47
48
49
 
# File 'lambda/scaling_options.rb', line 47

def scaling_policies()
  jsii_get_property("scalingPolicies")
end