software.amazon.awscdk.services.lambda

Class Version

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.lambda.FunctionBase

software.amazon.awscdk.services.lambda.QualifiedFunctionBase

software.amazon.awscdk.services.lambda.Version

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:42.108Z")
public class Version
extends QualifiedFunctionBase
implements 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:

 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	Class and Description
static class	Version.Builder A fluent builder for Version.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.IVersion

IVersion.Jsii$Default, IVersion.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IClientVpnConnectionHandler

IClientVpnConnectionHandler.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Version(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Version(software.amazon.jsii.JsiiObjectRef objRef)
	Version(software.constructs.Construct scope, java.lang.String id, VersionProps props)

Method Summary

Modifier and Type	Method and Description
Alias	addAlias(java.lang.String aliasName) 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.
Alias	addAlias(java.lang.String aliasName, AliasOptions options) 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.
static IVersion	fromVersionArn(software.constructs.Construct scope, java.lang.String id, java.lang.String versionArn) Construct a Version object from a Version ARN.
static IVersion	fromVersionAttributes(software.constructs.Construct scope, java.lang.String id, VersionAttributes attrs)
Architecture	getArchitecture() The architecture of this Lambda Function.
protected java.lang.Boolean	getCanCreatePermissions() Whether the addPermission() call adds any permissions.
java.lang.String	getEdgeArn() The ARN of the version for Lambda@Edge.
java.lang.String	getFunctionArn() The ARN fo the function.
java.lang.String	getFunctionName() The name of the function.
IPrincipal	getGrantPrincipal() The principal this Lambda Function is running as.
IFunction	getLambda() The underlying AWS Lambda function.
protected java.lang.String	getQualifier() The qualifier of the version or alias of this function.
IRole	getRole() The IAM role associated with this function.
java.lang.String	getVersion() The most recently deployed version of this function.
Metric	metric(java.lang.String metricName) Return the given named metric for this Function.
Metric	metric(java.lang.String metricName, MetricOptions props) Return the given named metric for this Function.

Methods inherited from class software.amazon.awscdk.services.lambda.QualifiedFunctionBase

configureAsyncInvoke, considerWarningOnInvokeFunctionPermissions, getLatestVersion, getPermissionsNode, getResourceArnsForGrantInvoke

Methods inherited from class software.amazon.awscdk.services.lambda.FunctionBase

addEventSource, addEventSourceMapping, addFunctionUrl, addFunctionUrl, addPermission, addToRolePolicy, getConnections, getIsBoundToVpc, grantInvoke, grantInvokeUrl, metricDuration, metricDuration, metricErrors, metricErrors, metricInvocations, metricInvocations, metricThrottles, metricThrottles, warnInvokeFunctionPermissions

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

addEventSource, addEventSourceMapping, addFunctionUrl, addFunctionUrl, addPermission, addToRolePolicy, configureAsyncInvoke, getIsBoundToVpc, getLatestVersion, getPermissionsNode, getResourceArnsForGrantInvoke, grantInvoke, grantInvokeUrl, metricDuration, metricDuration, metricErrors, metricErrors, metricInvocations, metricInvocations, metricThrottles, metricThrottles

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.services.ec2.IConnectable

getConnections

Constructor Detail

Version

protected Version(software.amazon.jsii.JsiiObjectRef objRef)

Version

protected Version(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Version

public Version(software.constructs.Construct scope,
               java.lang.String id,
               VersionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromVersionArn

public static IVersion fromVersionArn(software.constructs.Construct scope,
                                      java.lang.String id,
                                      java.lang.String versionArn)

Construct a Version object from a Version ARN.

Parameters:

scope - The cdk scope creating this resource. This parameter is required.

id - The cdk id of this resource. This parameter is required.

versionArn - The version ARN to create this version from. This parameter is required.

fromVersionAttributes

public static IVersion fromVersionAttributes(software.constructs.Construct scope,
                                             java.lang.String id,
                                             VersionAttributes attrs)

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addAlias

@Deprecated
public Alias addAlias(java.lang.String aliasName,
                                  AliasOptions options)

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.

(deprecated) Defines an alias for this version.

Specified by:

addAlias in interface IVersion

Parameters:

aliasName - The name of the alias (e.g. "live"). This parameter is required.

options - Alias options.

addAlias

@Deprecated
public Alias addAlias(java.lang.String aliasName)

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.

(deprecated) Defines an alias for this version.

Specified by:

addAlias in interface IVersion

Parameters:

aliasName - The name of the alias (e.g. "live"). This parameter is required.

metric

public Metric metric(java.lang.String metricName,
                     MetricOptions props)

Return the given named metric for this Function.

Specified by:

metric in interface IFunction

Overrides:

metric in class FunctionBase

Parameters:

metricName - This parameter is required.

props -

metric

public Metric metric(java.lang.String metricName)

Return the given named metric for this Function.

Specified by:

metric in interface IFunction

Overrides:

metric in class FunctionBase

Parameters:

metricName - This parameter is required.

getArchitecture

public Architecture getArchitecture()

The architecture of this Lambda Function.

Specified by:

getArchitecture in interface IFunction

Specified by:

getArchitecture in class FunctionBase

getCanCreatePermissions

protected java.lang.Boolean getCanCreatePermissions()

Whether the addPermission() call adds any permissions.

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

Specified by:

getCanCreatePermissions in class FunctionBase

getEdgeArn

public java.lang.String getEdgeArn()

The ARN of the version for Lambda@Edge.

Specified by:

getEdgeArn in interface IVersion

getFunctionArn

public java.lang.String getFunctionArn()

The ARN fo the function.

Specified by:

getFunctionArn in interface IClientVpnConnectionHandler

Specified by:

getFunctionArn in interface IFunction

Specified by:

getFunctionArn in class FunctionBase

getFunctionName

public java.lang.String getFunctionName()

The name of the function.

Specified by:

getFunctionName in interface IClientVpnConnectionHandler

Specified by:

getFunctionName in interface IFunction

Specified by:

getFunctionName in class FunctionBase

getGrantPrincipal

public IPrincipal getGrantPrincipal()

The principal this Lambda Function is running as.

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in class FunctionBase

getLambda

public IFunction getLambda()

The underlying AWS Lambda function.

Specified by:

getLambda in interface IVersion

Specified by:

getLambda in class QualifiedFunctionBase

getQualifier

protected java.lang.String getQualifier()

The qualifier of the version or alias of this function.

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

Specified by:

getQualifier in class QualifiedFunctionBase

See Also:

https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#API_GetFunctionConfiguration_RequestParameters

getVersion

public java.lang.String getVersion()

The most recently deployed version of this function.

Specified by:

getVersion in interface IVersion

getRole

public IRole getRole()

The IAM role associated with this function.

Undefined if the function was imported without a role.

Specified by:

getRole in interface IFunction

Specified by:

getRole in class FunctionBase