AliasOptions Struct
Options for lambda.Alias.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_lambda as lambda } from 'aws-cdk-lib';
declare const destination: lambda.IDestination;
declare const version: lambda.Version;
const aliasOptions: lambda.AliasOptions = {
additionalVersions: [{
version: version,
weight: 123,
}],
description: 'description',
maxEventAge: cdk.Duration.minutes(30),
onFailure: destination,
onSuccess: destination,
provisionedConcurrentExecutions: 123,
retryAttempts: 123,
};
Properties
additionalVersionsVersionWeight[]additional_versionstyping.List[VersionWeight]additionalVersionsList<VersionWeight>AdditionalVersionsVersionWeight[]AdditionalVersions*[]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.
Description for the alias.
Default: No description
maxEventAgeDurationmax_event_ageDurationmaxEventAgeDurationMaxEventAgeDurationMaxEventAgeDuration= Duration.hours(6)#The maximum age of a request that Lambda sends to a function for processing.
Minimum: 60 seconds Maximum: 6 hours
onFailureIDestinationon_failureIDestinationonFailureIDestinationOnFailureIDestinationOnFailureIDestination#The destination for failed invocations.
Default: no destination
onSuccessIDestinationon_successIDestinationonSuccessIDestinationOnSuccessIDestinationOnSuccessIDestination#The destination for successful invocations.
Default: no destination
provisionedConcurrentExecutionsnumberprovisioned_concurrent_executionsint | floatprovisionedConcurrentExecutionsNumberProvisionedConcurrentExecutionsdoubleProvisionedConcurrentExecutions*float64#Specifies a provisioned concurrency configuration for a function's alias.
Default: No provisioned concurrency
retryAttemptsnumberretry_attemptsint | floatretryAttemptsNumberRetryAttemptsdoubleRetryAttempts*float64= 2#The maximum number of times to retry when the function returns an error.
Minimum: 0 Maximum: 2