software.amazon.awscdk.services.lambda

Interface AliasProps

All Superinterfaces:

AliasOptions, EventInvokeConfigOptions

All Known Implementing Classes:

AliasProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:44.010Z")
public interface AliasProps
extends AliasOptions

Properties for a new Lambda alias.

Example:

 CfnParametersCode lambdaCode = Code.fromCfnParameters();
 Function func = Function.Builder.create(this, "Lambda")
         .code(lambdaCode)
         .handler("index.handler")
         .runtime(Runtime.NODEJS_14_X)
         .build();
 // used to make sure each CDK synthesis produces a different Version
 Version version = func.getCurrentVersion();
 Alias alias = Alias.Builder.create(this, "LambdaAlias")
         .aliasName("Prod")
         .version(version)
         .build();
 LambdaDeploymentGroup.Builder.create(this, "DeploymentGroup")
         .alias(alias)
         .deploymentConfig(LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AliasProps.Builder A builder for AliasProps
static class	AliasProps.Jsii$Proxy An implementation for AliasProps

Method Summary

Modifier and Type	Method and Description
static AliasProps.Builder	builder()
java.lang.String	getAliasName() Name of this alias.
IVersion	getVersion() Function version this alias refers to.

Methods inherited from interface software.amazon.awscdk.services.lambda.AliasOptions

getAdditionalVersions, getDescription, getProvisionedConcurrentExecutions

Methods inherited from interface software.amazon.awscdk.services.lambda.EventInvokeConfigOptions

getMaxEventAge, getOnFailure, getOnSuccess, getRetryAttempts

Method Detail

getAliasName

java.lang.String getAliasName()

Name of this alias.

getVersion

IVersion getVersion()

Function version this alias refers to.

Use lambda.currentVersion to reference a version with your latest changes.

builder

static AliasProps.Builder builder()

Specified by:

builder in interface AliasOptions

Specified by:

builder in interface EventInvokeConfigOptions

Returns:

a AliasProps.Builder of AliasProps