Skip to content
v2.274.0

AliasProps Struct ​

Properties for a new Lambda alias.

Example ​

ts
const lambdaCode = lambda.Code.fromCfnParameters();
const func = new lambda.Function(this, 'Lambda', {
  code: lambdaCode,
  handler: 'index.handler',
  runtime: lambda.Runtime.NODEJS_LATEST,
});
// used to make sure each CDK synthesis produces a different Version
const version = func.currentVersion;
const alias = new lambda.Alias(this, 'LambdaAlias', {
  aliasName: 'Prod',
  version,
});

new codedeploy.LambdaDeploymentGroup(this, 'DeploymentGroup', {
  alias,
  deploymentConfig: codedeploy.LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE,
});

Properties ​

additionalVersionsoptionalVersionWeight[]additional_versionsoptionaltyping.List[VersionWeight]additionalVersionsoptionalList<VersionWeight>AdditionalVersionsoptionalVersionWeight[]AdditionalVersionsoptional*[]VersionWeight#
Additional versions with individual weights this alias points to.

Default: No additional versions

notes

Individual additional version weights specified here should add up to (less than) one. All remaining weight is routed to the default version.

For example, the config is

version: "1" additionalVersions: [{ version: "2", weight: 0.05 }]

Then 5% of traffic will be routed to function version 2, while the remaining 95% of traffic will be routed to function version 1.

aliasNamestringalias_namestraliasNameStringAliasNamestringAliasName*stringrequired#
Name of this alias.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
Description for the alias.

Default: No description

maxEventAgeoptionalDurationmax_event_ageoptionalDurationmaxEventAgeoptionalDurationMaxEventAgeoptionalDurationMaxEventAgeoptionalDuration= Duration.hours(6)#
The maximum age of a request that Lambda sends to a function for processing.

Minimum: 60 seconds Maximum: 6 hours

onFailureoptionalIDestinationon_failureoptionalIDestinationonFailureoptionalIDestinationOnFailureoptionalIDestinationOnFailureoptionalIDestination#
The destination for failed invocations.

Default: no destination

onSuccessoptionalIDestinationon_successoptionalIDestinationonSuccessoptionalIDestinationOnSuccessoptionalIDestinationOnSuccessoptionalIDestination#
The destination for successful invocations.

Default: no destination

provisionedConcurrentExecutionsoptionalnumberprovisioned_concurrent_executionsoptionalint | floatprovisionedConcurrentExecutionsoptionalNumberProvisionedConcurrentExecutionsoptionaldoubleProvisionedConcurrentExecutionsoptional*float64#
Specifies a provisioned concurrency configuration for a function's alias.

Default: No provisioned concurrency

retryAttemptsoptionalnumberretry_attemptsoptionalint | floatretryAttemptsoptionalNumberRetryAttemptsoptionaldoubleRetryAttemptsoptional*float64= 2#
The maximum number of times to retry when the function returns an error.

Minimum: 0 Maximum: 2

versionIVersionversionIVersionversionIVersionVersionIVersionVersionIVersionrequired#
Function version this alias refers to.

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