RuntimeManagementConfig class

Manages an AWS Lambda Runtime Management Config. Use this resource to control how Lambda updates the runtime for your function.

Refer to the AWS Lambda documentation for supported runtimes.

> Note: Deletion of this resource returns the runtime update mode to Auto (the default behavior). To leave the configured runtime management options in-place, use a removed block with the destroy lifecycle set to false.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.lambda.RuntimeManagementConfig("example", {
    functionName: exampleAwsLambdaFunction.functionName,
    updateRuntimeOn: "FunctionUpdate",
});
import pulumi
import pulumi_aws as aws

example = aws.lambda_.RuntimeManagementConfig("example",
    function_name=example_aws_lambda_function["functionName"],
    update_runtime_on="FunctionUpdate")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Lambda.RuntimeManagementConfig("example", new()
    {
        FunctionName = exampleAwsLambdaFunction.FunctionName,
        UpdateRuntimeOn = "FunctionUpdate",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/lambda"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := lambda.NewRuntimeManagementConfig(ctx, "example", &lambda.RuntimeManagementConfigArgs{
			FunctionName:    pulumi.Any(exampleAwsLambdaFunction.FunctionName),
			UpdateRuntimeOn: pulumi.String("FunctionUpdate"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_lambda_runtimemanagementconfig" "example" {
  function_name     = exampleAwsLambdaFunction.functionName
  update_runtime_on = "FunctionUpdate"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lambda.RuntimeManagementConfig;
import com.pulumi.aws.lambda.RuntimeManagementConfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new RuntimeManagementConfig("example", RuntimeManagementConfigArgs.builder()
            .functionName(exampleAwsLambdaFunction.functionName())
            .updateRuntimeOn("FunctionUpdate")
            .build());

    }
}
resources:
  example:
    type: aws:lambda:RuntimeManagementConfig
    properties:
      functionName: ${exampleAwsLambdaFunction.functionName}
      updateRuntimeOn: FunctionUpdate

Manual Update

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.lambda.RuntimeManagementConfig("example", {
    functionName: exampleAwsLambdaFunction.functionName,
    updateRuntimeOn: "Manual",
    runtimeVersionArn: "arn:aws:lambda:us-east-1::runtime:abcd1234",
});
import pulumi
import pulumi_aws as aws

example = aws.lambda_.RuntimeManagementConfig("example",
    function_name=example_aws_lambda_function["functionName"],
    update_runtime_on="Manual",
    runtime_version_arn="arn:aws:lambda:us-east-1::runtime:abcd1234")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Lambda.RuntimeManagementConfig("example", new()
    {
        FunctionName = exampleAwsLambdaFunction.FunctionName,
        UpdateRuntimeOn = "Manual",
        RuntimeVersionArn = "arn:aws:lambda:us-east-1::runtime:abcd1234",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/lambda"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := lambda.NewRuntimeManagementConfig(ctx, "example", &lambda.RuntimeManagementConfigArgs{
			FunctionName:      pulumi.Any(exampleAwsLambdaFunction.FunctionName),
			UpdateRuntimeOn:   pulumi.String("Manual"),
			RuntimeVersionArn: pulumi.String("arn:aws:lambda:us-east-1::runtime:abcd1234"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_lambda_runtimemanagementconfig" "example" {
  function_name       = exampleAwsLambdaFunction.functionName
  update_runtime_on   = "Manual"
  runtime_version_arn = "arn:aws:lambda:us-east-1::runtime:abcd1234"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lambda.RuntimeManagementConfig;
import com.pulumi.aws.lambda.RuntimeManagementConfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new RuntimeManagementConfig("example", RuntimeManagementConfigArgs.builder()
            .functionName(exampleAwsLambdaFunction.functionName())
            .updateRuntimeOn("Manual")
            .runtimeVersionArn("arn:aws:lambda:us-east-1::runtime:abcd1234")
            .build());

    }
}
resources:
  example:
    type: aws:lambda:RuntimeManagementConfig
    properties:
      functionName: ${exampleAwsLambdaFunction.functionName}
      updateRuntimeOn: Manual
      runtimeVersionArn: arn:aws:lambda:us-east-1::runtime:abcd1234

> Note: Once the runtime update mode is set to Manual, the aws.lambda.Function runtime cannot be updated. To upgrade a runtime, the updateRuntimeOn argument must be set to Auto or FunctionUpdate prior to changing the function's runtime argument.

Import

Using pulumi import, import Lambda Runtime Management Config using a comma-delimited string combining functionName and qualifier. For example:

$ pulumi import aws:lambda/runtimeManagementConfig:RuntimeManagementConfig example example,$LATEST

Constructors

RuntimeManagementConfig(String name, {RuntimeManagementConfigArgs? args, CustomResourceOptions? options})
Creates a new RuntimeManagementConfig. name The Pulumi resource name. args Arguments used to configure this RuntimeManagementConfig. The set of arguments for RuntimeManagementConfig. options Resource options controlling this resource's behavior.
RuntimeManagementConfig.reference(String urn)
Creates a typed reference to an existing RuntimeManagementConfig resource.

Properties

childResources Set<Resource>
finalinherited
completionSources Map<String, IOutputCompletionSource>
latefinalinherited
functionArn ↔ Output<String>
ARN of the function.
latefinal
functionName ↔ Output<String>
Name or ARN of the Lambda function.
latefinal
hashCode int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference bool
Whether this instance represents a resource value returned over RPC.
finalinherited
qualifier ↔ Output<String?>
Version of the function. This can be $LATEST or a published version number. If omitted, this resource will manage the runtime configuration for $LATEST.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
runtimeVersionArn ↔ Output<String?>
ARN of the runtime version. Only required when updateRuntimeOn is Manual.
latefinal
transformations List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
updateRuntimeOn ↔ Output<String?>
Runtime update mode. Valid values are Auto, FunctionUpdate, and Manual. When a function is created, the default mode is Auto.
latefinal
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() String
Returns this resource's logical name.
inherited
getResourceType() String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {RuntimeManagementConfigState? state, CustomResourceOptions? options}) RuntimeManagementConfig
Gets an existing RuntimeManagementConfig resource's state with the given name and id.