Class: AWSCDK::Lambda::RuntimeManagementMode

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

Overview

Specify the runtime update mode.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(mode, arn = nil) ⇒ RuntimeManagementMode

Returns a new instance of RuntimeManagementMode.

Parameters:

  • mode (String)
  • arn (String, nil) (defaults to: nil) 


10
11
12
13
14
 
# File 'lambda/runtime_management_mode.rb', line 10

def initialize(mode, arn = nil)
  Jsii::Type.check_type(mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mode")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn") unless arn.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(mode, arn)
end

Class Method Details

.AUTO ⇒ AWSCDK::Lambda::RuntimeManagementMode

Automatically update to the most recent and secure runtime version using Two-phase runtime version rollout.

We recommend this mode for most customers so that you always benefit from runtime updates.

Returns:

  • (AWSCDK::Lambda::RuntimeManagementMode) 


42
43
44
 
# File 'lambda/runtime_management_mode.rb', line 42

def self.AUTO()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_lambda.RuntimeManagementMode", "AUTO")
end

.FUNCTION_UPDATE ⇒ AWSCDK::Lambda::RuntimeManagementMode

When you update your function, Lambda updates the runtime of your function to the most recent and secure runtime version.

This approach synchronizes runtime updates with function deployments, giving you control over when Lambda applies runtime updates. With this mode, you can detect and mitigate rare runtime update incompatibilities early. When using this mode, you must regularly update your functions to keep their runtime up to date.

Returns:

  • (AWSCDK::Lambda::RuntimeManagementMode) 


54
55
56
 
# File 'lambda/runtime_management_mode.rb', line 54

def self.FUNCTION_UPDATE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_lambda.RuntimeManagementMode", "FUNCTION_UPDATE")
end

.jsii_overridable_methods ⇒ Object 



16
17
18
19
20
21
22
 
# File 'lambda/runtime_management_mode.rb', line 16

def self.jsii_overridable_methods
  {
    :mode => { kind: :property, name: "mode", is_optional: false },
    :runtime_management_config => { kind: :property, name: "runtimeManagementConfig", is_optional: false },
    :arn => { kind: :property, name: "arn", is_optional: true },
  }
end

.manual(arn) ⇒ AWSCDK::Lambda::RuntimeManagementMode

You specify a runtime version in your function configuration.

The function uses this runtime version indefinitely. In the rare case in which a new runtime version is incompatible with an existing function, you can use this mode to roll back your function to an earlier runtime version.

Parameters:

  • arn (String)

Returns:

  • (AWSCDK::Lambda::RuntimeManagementMode) 


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

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

Instance Method Details

#arn ⇒ String?

Returns:

  • (String, nil) 


71
72
73
 
# File 'lambda/runtime_management_mode.rb', line 71

def arn()
  jsii_get_property("arn")
end

#mode ⇒ String

Returns:

  • (String) 


59
60
61
 
# File 'lambda/runtime_management_mode.rb', line 59

def mode()
  jsii_get_property("mode")
end

#runtime_management_config ⇒ AWSCDK::Lambda::CfnFunction::RuntimeManagementConfigProperty

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html.

Returns:



66
67
68
 
# File 'lambda/runtime_management_mode.rb', line 66

def runtime_management_config()
  jsii_get_property("runtimeManagementConfig")
end