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,IAliasRef,IFunction,IFunctionRef,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
date="2025-10-24T13:34:41.115Z")
@Stability(Stable)
public class Alias
extends QualifiedFunctionBase
implements IAlias
A new alias to a particular version of a Lambda function.
Example:
CfnParametersCode lambdaCode = Code.fromCfnParameters();
Function func = Function.Builder.create(this, "Lambda")
.code(lambdaCode)
.handler("index.handler")
.runtime(Runtime.NODEJS_LATEST)
.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 ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.IAlias
IAlias.Jsii$Default, IAlias.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IClientVpnConnectionHandler
IClientVpnConnectionHandler.Jsii$DefaultNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.IFunction
IFunction.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAlias(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedAlias(software.amazon.jsii.JsiiObjectRef objRef) Alias(software.constructs.Construct scope, String id, AliasProps props) -
Method Summary
Modifier and TypeMethodDescriptionaddAutoScaling(AutoScalingOptions options) Configure provisioned concurrency autoscaling on a function alias.static IAliasfromAliasAttributes(software.constructs.Construct scope, String id, AliasAttributes attrs) Name of this alias.A reference to a Alias resource.The architecture of this Lambda Function.protected BooleanWhether the addPermission() call adds any permissions.ARN of this alias.ARN of this alias.The principal this Lambda Function is running as.The underlyingIFunction.protected StringThe qualifier of the version or alias of this function.getRole()The IAM role associated with this function.The underlying Lambda function version.Return the given named metric for this Function.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, getResourceArnsForGrantInvokeMethods inherited from class software.amazon.awscdk.services.lambda.FunctionBase
addEventSource, addEventSourceMapping, addFunctionUrl, addFunctionUrl, addPermission, addToRolePolicy, getConnections, getFunctionRef, getIsBoundToVpc, grantInvoke, grantInvokeCompositePrincipal, grantInvokeLatestVersion, grantInvokeUrl, grantInvokeVersion, metricDuration, metricDuration, metricErrors, metricErrors, metricInvocations, metricInvocations, metricThrottles, metricThrottles, warnInvokeFunctionPermissionsMethods inherited from class software.amazon.awscdk.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResourceMethods inherited from class software.constructs.Construct
getNode, isConstruct, toStringMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.awscdk.services.ec2.IConnectable
getConnectionsMethods inherited from interface software.amazon.awscdk.services.lambda.IFunction
addEventSource, addEventSourceMapping, addFunctionUrl, addFunctionUrl, addPermission, addToRolePolicy, configureAsyncInvoke, getIsBoundToVpc, getLatestVersion, getPermissionsNode, getResourceArnsForGrantInvoke, grantInvoke, grantInvokeCompositePrincipal, grantInvokeLatestVersion, grantInvokeUrl, grantInvokeVersion, metricDuration, metricDuration, metricErrors, metricErrors, metricInvocations, metricInvocations, metricThrottles, metricThrottlesMethods inherited from interface software.amazon.awscdk.services.lambda.IFunctionRef
getFunctionRefMethods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStackMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
PROPERTY_INJECTION_ID
Uniquely identifies this class.
-
-
Constructor Details
-
Alias
protected Alias(software.amazon.jsii.JsiiObjectRef objRef) -
Alias
protected Alias(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
Alias
@Stability(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 Details
-
fromAliasAttributes
@Stability(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(Stable) @NotNull public IScalableFunctionAttribute addAutoScaling(@NotNull AutoScalingOptions options) Configure provisioned concurrency autoscaling on a function alias.Returns a scalable attribute that can call
scaleOnUtilization()andscaleOnSchedule().- Parameters:
options- Autoscaling options. This parameter is required.
-
metric
@Stability(Stable) @NotNull public Metric metric(@NotNull String metricName, @Nullable MetricOptions props) Return the given named metric for this Function.- Specified by:
metricin interfaceIFunction- Overrides:
metricin classFunctionBase- Parameters:
metricName- This parameter is required.props-
-
metric
Return the given named metric for this Function.- Specified by:
metricin interfaceIFunction- Overrides:
metricin classFunctionBase- Parameters:
metricName- This parameter is required.
-
getAliasName
Name of this alias.- Specified by:
getAliasNamein interfaceIAlias
-
getAliasRef
A reference to a Alias resource.- Specified by:
getAliasRefin interfaceIAliasRef
-
getArchitecture
The architecture of this Lambda Function.- Specified by:
getArchitecturein interfaceIFunction- Specified by:
getArchitecturein classFunctionBase
-
getCanCreatePermissions
Whether the addPermission() call adds any permissions.True for new Lambdas, false for version $LATEST and imported Lambdas from different accounts.
- Specified by:
getCanCreatePermissionsin classFunctionBase
-
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:
getFunctionArnin interfaceIClientVpnConnectionHandler- Specified by:
getFunctionArnin interfaceIFunction- Specified by:
getFunctionArnin classFunctionBase
-
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:
getFunctionNamein interfaceIClientVpnConnectionHandler- Specified by:
getFunctionNamein interfaceIFunction- Specified by:
getFunctionNamein classFunctionBase
-
getGrantPrincipal
The principal this Lambda Function is running as.- Specified by:
getGrantPrincipalin interfaceIGrantable- Specified by:
getGrantPrincipalin classFunctionBase
-
getLambda
The underlyingIFunction.- Specified by:
getLambdain classQualifiedFunctionBase
-
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:
getQualifierin classQualifiedFunctionBase- See Also:
-
getVersion
The underlying Lambda function version.- Specified by:
getVersionin interfaceIAlias
-
getRole
The IAM role associated with this function.Undefined if the function was imported without a role.
- Specified by:
getRolein interfaceIFunction- Specified by:
getRolein classFunctionBase
-