software.amazon.awscdk.services.lambda

Class Alias

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.lambda.FunctionBase

software.amazon.awscdk.services.lambda.QualifiedFunctionBase

software.amazon.awscdk.services.lambda.Alias

All Implemented Interfaces:

IResource, IClientVpnConnectionHandler, IConnectable, IGrantable, IAlias, IFunction, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.374Z")
 @Stability(value=Stable)
public class Alias
extends QualifiedFunctionBase
implements IAlias

A new alias to a particular version of a Lambda function.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 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	Alias.Builder A fluent builder for Alias.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IAlias.Jsii$Default, IAlias.Jsii$Proxy

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

IClientVpnConnectionHandler.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	Alias(software.constructs.Construct scope, String id, AliasProps props)
protected	Alias(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Alias(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
IScalableFunctionAttribute	addAutoScaling(AutoScalingOptions options) Configure provisioned concurrency autoscaling on a function alias.
static IAlias	fromAliasAttributes(software.constructs.Construct scope, String id, AliasAttributes attrs)
String	getAliasName() Name of this alias.
Architecture	getArchitecture() The architecture of this Lambda Function.
protected Boolean	getCanCreatePermissions() Whether the addPermission() call adds any permissions.
String	getFunctionArn() ARN of this alias.
String	getFunctionName() ARN of this alias.
IPrincipal	getGrantPrincipal() The principal this Lambda Function is running as.
IFunction	getLambda()
protected String	getQualifier() The qualifier of the version or alias of this function.
IRole	getRole() The IAM role associated with this function.
IVersion	getVersion() The underlying Lambda function version.
Metric	metric(String metricName) Return the given named metric for this Function.
Metric	metric(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.Resource

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

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getConnections

Constructor Detail

Alias

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

Alias

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

Alias

@Stability(value=Stable)
public Alias(@NotNull
                                      software.constructs.Construct scope,
                                      @NotNull
                                      String id,
                                      @NotNull
                                      AliasProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromAliasAttributes

@Stability(value=Stable)
 @NotNull
public static IAlias fromAliasAttributes(@NotNull
                                                                            software.constructs.Construct scope,
                                                                            @NotNull
                                                                            String id,
                                                                            @NotNull
                                                                            AliasAttributes attrs)

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addAutoScaling

@Stability(value=Stable)
 @NotNull
public IScalableFunctionAttribute addAutoScaling(@NotNull
                                                                                    AutoScalingOptions options)

Configure provisioned concurrency autoscaling on a function alias.

Returns a scalable attribute that can call scaleOnUtilization() and scaleOnSchedule().

Parameters:

options - Autoscaling options. This parameter is required.

metric

@Stability(value=Stable)
 @NotNull
public Metric metric(@NotNull
                                                        String metricName,
                                                        @Nullable
                                                        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

@Stability(value=Stable)
 @NotNull
public Metric metric(@NotNull
                                                        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.

getAliasName

@Stability(value=Stable)
 @NotNull
public String getAliasName()

Name of this alias.

Specified by:

getAliasName in interface IAlias

getArchitecture

@Stability(value=Stable)
 @NotNull
public Architecture getArchitecture()

The architecture of this Lambda Function.

Specified by:

getArchitecture in interface IFunction

Specified by:

getArchitecture in class FunctionBase

getCanCreatePermissions

@Stability(value=Stable)
 @NotNull
protected 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

getFunctionArn

@Stability(value=Stable)
 @NotNull
public String getFunctionArn()

ARN of this alias.

Used to be able to use Alias in place of a regular Lambda. Lambda accepts ARNs everywhere it accepts function names.

Specified by:

getFunctionArn in interface IClientVpnConnectionHandler

Specified by:

getFunctionArn in interface IFunction

Specified by:

getFunctionArn in class FunctionBase

getFunctionName

@Stability(value=Stable)
 @NotNull
public String getFunctionName()

ARN of this alias.

Used to be able to use Alias in place of a regular Lambda. Lambda accepts ARNs everywhere it accepts function names.

Specified by:

getFunctionName in interface IClientVpnConnectionHandler

Specified by:

getFunctionName in interface IFunction

Specified by:

getFunctionName in class FunctionBase

getGrantPrincipal

@Stability(value=Stable)
 @NotNull
public IPrincipal getGrantPrincipal()

The principal this Lambda Function is running as.

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in class FunctionBase

getLambda

@Stability(value=Stable)
 @NotNull
public IFunction getLambda()

Specified by:

getLambda in class QualifiedFunctionBase

getQualifier

@Stability(value=Stable)
 @NotNull
protected 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

@Stability(value=Stable)
 @NotNull
public IVersion getVersion()

The underlying Lambda function version.

Specified by:

getVersion in interface IAlias

getRole

@Stability(value=Stable)
 @Nullable
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