pulumi-aws-kotlin/com.pulumi.aws.lambda.kotlin/Alias

Alias

class Alias : KotlinCustomResource

Creates a Lambda function alias. Creates an alias that points to the specified Lambda function version. For information about Lambda and how to use it, see What is AWS Lambda? For information about function aliases, see CreateAlias and AliasRoutingConfiguration in the API docs.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const testLambdaAlias = new aws.lambda.Alias("test_lambda_alias", {
    name: "my_alias",
    description: "a sample description",
    functionName: lambdaFunctionTest.arn,
    functionVersion: "1",
    routingConfig: {
        additionalVersionWeights: {
            "2": 0.5,
        },
    },
});

import pulumi
import pulumi_aws as aws
test_lambda_alias = aws.lambda_.Alias("test_lambda_alias",
    name="my_alias",
    description="a sample description",
    function_name=lambda_function_test["arn"],
    function_version="1",
    routing_config={
        "additional_version_weights": {
            "2": 0.5,
        },
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var testLambdaAlias = new Aws.Lambda.Alias("test_lambda_alias", new()
    {
        Name = "my_alias",
        Description = "a sample description",
        FunctionName = lambdaFunctionTest.Arn,
        FunctionVersion = "1",
        RoutingConfig = new Aws.Lambda.Inputs.AliasRoutingConfigArgs
        {
            AdditionalVersionWeights =
            {
                { "2", 0.5 },
            },
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lambda"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := lambda.NewAlias(ctx, "test_lambda_alias", &lambda.AliasArgs{
			Name:            pulumi.String("my_alias"),
			Description:     pulumi.String("a sample description"),
			FunctionName:    pulumi.Any(lambdaFunctionTest.Arn),
			FunctionVersion: pulumi.String("1"),
			RoutingConfig: &lambda.AliasRoutingConfigArgs{
				AdditionalVersionWeights: pulumi.Float64Map{
					"2": pulumi.Float64(0.5),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lambda.Alias;
import com.pulumi.aws.lambda.AliasArgs;
import com.pulumi.aws.lambda.inputs.AliasRoutingConfigArgs;
import java.util.List;
import java.util.ArrayList;
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 testLambdaAlias = new Alias("testLambdaAlias", AliasArgs.builder()
            .name("my_alias")
            .description("a sample description")
            .functionName(lambdaFunctionTest.arn())
            .functionVersion("1")
            .routingConfig(AliasRoutingConfigArgs.builder()
                .additionalVersionWeights(Map.of("2", 0.5))
                .build())
            .build());
    }
}

resources:
  testLambdaAlias:
    type: aws:lambda:Alias
    name: test_lambda_alias
    properties:
      name: my_alias
      description: a sample description
      functionName: ${lambdaFunctionTest.arn}
      functionVersion: '1'
      routingConfig:
        additionalVersionWeights:
          '2': 0.5

Import

Using pulumi import, import Lambda Function Aliases using the function_name/alias. For example:

$ pulumi import aws:lambda/alias:Alias test_lambda_alias my_test_lambda_function/my_alias

Properties

arn

val arn: Output<String>

The Amazon Resource Name (ARN) identifying your Lambda function alias.

description

val description: Output<String>?

Description of the alias.

functionName

val functionName: Output<String>

Lambda Function name or ARN.

functionVersion

val functionVersion: Output<String>

Lambda function version for which you are creating the alias. Pattern: (\$LATEST|[0-9]+).

val id: Output<String>

invokeArn

val invokeArn: Output<String>

The ARN to be used for invoking Lambda Function from API Gateway - to be used in aws.apigateway.Integration's uri

name

val name: Output<String>

Name for the alias you are creating. Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

routingConfig

val routingConfig: Output<AliasRoutingConfig>?

The Lambda alias' route configuration settings. Fields documented below

urn

val urn: Output<String>