class Version (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.Lambda.Version`
Java	`software.amazon.awscdk.services.lambda.Version`
Python	`aws_cdk.aws_lambda.Version`
TypeScript (source)	`@aws-cdk/aws-lambda` » `Version`

Implements IConstruct, IConstruct, IDependable, IResource, IFunction, IConnectable, IGrantable, IClientVpnConnectionHandler, IVersion

Tag the current state of a Function with a Version number.

Avoid using this resource directly. If you need a Version object, use function.currentVersion instead. That will add a Version object to your template, and make sure the Version is invalidated whenever the Function object changes. If you use the Version resource directly, you are responsible for making sure it is invalidated (by changing its logical ID) whenever necessary.

Version resources can then be used in Alias resources to refer to a particular deployment of a Lambda.

If you want to ensure that you're associating the right version with the right deployment, specify the codeSha256 property while creating the `Version.

Example

const lambdaCode = lambda.Code.fromCfnParameters();
const func = new lambda.Function(this, 'Lambda', {
  code: lambdaCode,
  handler: 'index.handler',
  runtime: lambda.Runtime.NODEJS_14_X,
});
// 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,
});

Initializer

new Version(scope: Construct, id: string, props: VersionProps)

Parameters

scope Construct
id string
props VersionProps

Construct Props

Name	Type	Description
lambda	`IFunction`	Function to get the value of.
codeSha256?	`string`	SHA256 of the version of the Lambda source code.
description?	`string`	Description of the version.
maxEventAge?	`Duration`	The maximum age of a request that Lambda sends to a function for processing.
onFailure?	`IDestination`	The destination for failed invocations.
onSuccess?	`IDestination`	The destination for successful invocations.
provisionedConcurrentExecutions?	`number`	Specifies a provisioned concurrency configuration for a function's version.
removalPolicy?	`RemovalPolicy`	Whether to retain old versions of this function when a new version is created.
retryAttempts?	`number`	The maximum number of times to retry when the function returns an error.

lambda

Type: IFunction

Function to get the value of.

codeSha256?

Type: string (optional, default: No validation is performed)

SHA256 of the version of the Lambda source code.

Specify to validate that you're deploying the right version.

description?

Type: string (optional, default: Description of the Lambda)

Description of the version.

maxEventAge?

Type: Duration (optional, default: Duration.hours(6))

The maximum age of a request that Lambda sends to a function for processing.

Minimum: 60 seconds Maximum: 6 hours

onFailure?

Type: IDestination (optional, default: no destination)

The destination for failed invocations.

onSuccess?

Type: IDestination (optional, default: no destination)

The destination for successful invocations.

provisionedConcurrentExecutions?

Type: number (optional, default: No provisioned concurrency)

Specifies a provisioned concurrency configuration for a function's version.

removalPolicy?

Type: RemovalPolicy (optional, default: RemovalPolicy.DESTROY)

Whether to retain old versions of this function when a new version is created.

retryAttempts?

Type: number (optional, default: 2)

The maximum number of times to retry when the function returns an error.

Minimum: 0 Maximum: 2

Properties

Name	Type	Description
architecture	`Architecture`	The architecture of this Lambda Function.
canCreatePermissions	`boolean`	Whether the addPermission() call adds any permissions.
connections	`Connections`	Access the Connections object.
edgeArn	`string`	The ARN of the version for Lambda@Edge.
env	`ResourceEnvironment`	The environment this resource belongs to.
functionArn	`string`	The ARN fo the function.
functionName	`string`	The name of the function.
grantPrincipal	`IPrincipal`	The principal this Lambda Function is running as.
isBoundToVpc	`boolean`	Whether or not this Lambda function was bound to a VPC.
lambda	`IFunction`	The underlying AWS Lambda function.
latestVersion	`IVersion`	The `$LATEST` version of this function.
node	`ConstructNode`	The construct tree node associated with this construct.
permissionsNode	`ConstructNode`	The construct node where permissions are attached.
qualifier	`string`	The qualifier of the version or alias of this function.
resourceArnsForGrantInvoke	`string[]`	The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke().
stack	`Stack`	The stack in which this resource is defined.
version	`string`	The most recently deployed version of this function.
role?	`IRole`	The IAM role associated with this function.

architecture

Type: Architecture

The architecture of this Lambda Function.

canCreatePermissions

Type: boolean

Whether the addPermission() call adds any permissions.

True for new Lambdas, false for version $LATEST and imported Lambdas from different accounts.

connections

Type: Connections

Access the Connections object.

Will fail if not a VPC-enabled Lambda Function

edgeArn

Type: string

The ARN of the version for Lambda@Edge.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

functionArn

Type: string

The ARN fo the function.

functionName

Type: string

The name of the function.

grantPrincipal

Type: IPrincipal

The principal this Lambda Function is running as.

isBoundToVpc

Type: boolean

Whether or not this Lambda function was bound to a VPC.

If this is is false, trying to access the connections object will fail.

lambda

Type: IFunction

The underlying AWS Lambda function.

latestVersion

Type: IVersion

The $LATEST version of this function.

Note that this is reference to a non-specific AWS Lambda version, which means the function this version refers to can return different results in different invocations.

To obtain a reference to an explicit version which references the current function configuration, use lambdaFunction.currentVersion instead.

node

Type: ConstructNode

The construct tree node associated with this construct.

permissionsNode

Type: ConstructNode

The construct node where permissions are attached.

qualifier

Type: string

The qualifier of the version or alias of this function.

A qualifier is the identifier that's appended to a version or alias ARN.

resourceArnsForGrantInvoke

Type: string[]

The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke().

stack

Type: Stack

The stack in which this resource is defined.

version

Type: string

The most recently deployed version of this function.

role?

Type: IRole (optional)

The IAM role associated with this function.

Undefined if the function was imported without a role.

Methods

Name	Description
addAlias(aliasName, options?)⚠️	Defines an alias for this version.
addEventSource(source)	Adds an event source to this function.
addEventSourceMapping(id, options)	Adds an event source that maps to this AWS Lambda function.
addFunctionUrl(options?)	Adds a url to this lambda function.
addPermission(id, permission)	Adds a permission to the Lambda resource policy.
addToRolePolicy(statement)	Adds a statement to the IAM role assumed by the instance.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
configureAsyncInvoke(options)	Configures options for asynchronous invocation.
considerWarningOnInvokeFunctionPermissions(_scope, _action)	A warning will be added to functions under the following conditions: - permissions that include `lambda:InvokeFunction` are added to the unqualified function.
grantInvoke(grantee)	Grant the given identity permissions to invoke this Lambda.
grantInvokeUrl(grantee)	Grant the given identity permissions to invoke this Lambda Function URL.
metric(metricName, props?)	Return the given named metric for this Function.
metricDuration(props?)	How long execution of this Lambda takes.
metricErrors(props?)	How many invocations of this Lambda fail.
metricInvocations(props?)	How often this Lambda is invoked.
metricThrottles(props?)	How often this Lambda is throttled.
toString()	Returns a string representation of this construct.
static fromVersionArn(scope, id, versionArn)	Construct a Version object from a Version ARN.
static fromVersionAttributes(scope, id, attrs)

addAlias(aliasName, options?)⚠️

public addAlias(aliasName: string, options?: AliasOptions): Alias

⚠️ Deprecated: Calling addAlias on a Version object will cause the Alias to be replaced on every function update. Call function.addAlias() or new Alias() instead.

Parameters

aliasName string — The name of the alias (e.g. "live").
options AliasOptions — Alias options.

Returns

Alias

Defines an alias for this version.

addEventSource(source)

public addEventSource(source: IEventSource): void

Parameters

source IEventSource

Adds an event source to this function.

Event sources are implemented in the @aws-cdk/aws-lambda-event-sources module.

The following example adds an SQS Queue as an event source:

import { SqsEventSource } from '@aws-cdk/aws-lambda-event-sources';
myFunction.addEventSource(new SqsEventSource(myQueue));

addEventSourceMapping(id, options)

public addEventSourceMapping(id: string, options: EventSourceMappingOptions): EventSourceMapping

Parameters

id string
options EventSourceMappingOptions

Returns

EventSourceMapping

Adds an event source that maps to this AWS Lambda function.

addFunctionUrl(options?)

public addFunctionUrl(options?: FunctionUrlOptions): FunctionUrl

Parameters

options FunctionUrlOptions

Returns

FunctionUrl

Adds a url to this lambda function.

addPermission(id, permission)

public addPermission(id: string, permission: Permission): void

Parameters

id string — The id for the permission construct.
permission Permission — The permission to grant to this Lambda function.

Adds a permission to the Lambda resource policy.

See also: [Permission for details.](Permission for details.)

addToRolePolicy(statement)

public addToRolePolicy(statement: PolicyStatement): void

Parameters

statement PolicyStatement

Adds a statement to the IAM role assumed by the instance.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

configureAsyncInvoke(options)

public configureAsyncInvoke(options: EventInvokeConfigOptions): void

Parameters

options EventInvokeConfigOptions

Configures options for asynchronous invocation.

considerWarningOnInvokeFunctionPermissions(_scope, _action)

public considerWarningOnInvokeFunctionPermissions(_scope: Construct, _action: string): void

Parameters

_scope Construct
_action string

A warning will be added to functions under the following conditions: - permissions that include lambda:InvokeFunction are added to the unqualified function.

function.currentVersion is invoked before or after the permission is created.

This applies only to permissions on Lambda functions, not versions or aliases. This function is overridden as a noOp for QualifiedFunctionBase.

grantInvoke(grantee)

public grantInvoke(grantee: IGrantable): Grant

Parameters

grantee IGrantable

Returns

Grant

Grant the given identity permissions to invoke this Lambda.

grantInvokeUrl(grantee)

public grantInvokeUrl(grantee: IGrantable): Grant

Parameters

grantee IGrantable

Returns

Grant

Grant the given identity permissions to invoke this Lambda Function URL.

metric(metricName, props?)

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

metricName string
props MetricOptions

Returns

Metric

Return the given named metric for this Function.

metricDuration(props?)

public metricDuration(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

How long execution of this Lambda takes.

Average over 5 minutes

metricErrors(props?)

public metricErrors(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

How many invocations of this Lambda fail.

Sum over 5 minutes

metricInvocations(props?)

public metricInvocations(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

How often this Lambda is invoked.

Sum over 5 minutes

metricThrottles(props?)

public metricThrottles(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

How often this Lambda is throttled.

Sum over 5 minutes

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

static fromVersionArn(scope, id, versionArn)

public static fromVersionArn(scope: Construct, id: string, versionArn: string): IVersion

Parameters

scope Construct — The cdk scope creating this resource.
id string — The cdk id of this resource.
versionArn string — The version ARN to create this version from.

Returns

IVersion

Construct a Version object from a Version ARN.

static fromVersionAttributes(scope, id, attrs)

public static fromVersionAttributes(scope: Construct, id: string, attrs: VersionAttributes): IVersion

Parameters

scope Construct
id string
attrs VersionAttributes

Returns

IVersion