@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
date="2022-08-09T19:16:38.727Z")
public class Alias
extends QualifiedFunctionBase
implements IAlias
Example:
CfnParametersCode lambdaCode = Code.fromCfnParameters();
Function func = Function.Builder.create(this, "Lambda")
.code(lambdaCode)
.handler("index.handler")
.runtime(Runtime.NODEJS_12_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();
| Modifier and Type | Class and Description |
|---|---|
static class |
Alias.Builder
A fluent builder for
Alias. |
IAlias.Jsii$Default, IAlias.Jsii$ProxyIClientVpnConnectionHandler.Jsii$Default| Modifier | Constructor and Description |
|---|---|
protected |
Alias(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
Alias(software.amazon.jsii.JsiiObjectRef objRef) |
|
Alias(software.constructs.Construct scope,
java.lang.String id,
AliasProps props) |
| 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,
java.lang.String id,
AliasAttributes attrs) |
java.lang.String |
getAliasName()
Name of this alias.
|
Architecture |
getArchitecture()
The architecture of this Lambda Function.
|
protected java.lang.Boolean |
getCanCreatePermissions()
Whether the addPermission() call adds any permissions.
|
java.lang.String |
getFunctionArn()
ARN of this alias.
|
java.lang.String |
getFunctionName()
ARN of this alias.
|
IPrincipal |
getGrantPrincipal()
The principal this Lambda Function is running as.
|
IFunction |
getLambda() |
protected java.lang.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(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.
|
configureAsyncInvoke, considerWarningOnInvokeFunctionPermissions, getLatestVersion, getPermissionsNode, getResourceArnsForGrantInvokeaddEventSource, addEventSourceMapping, addFunctionUrl, addFunctionUrl, addPermission, addToRolePolicy, getConnections, getIsBoundToVpc, grantInvoke, grantInvokeUrl, metricDuration, metricDuration, metricErrors, metricErrors, metricInvocations, metricInvocations, metricThrottles, metricThrottles, warnInvokeFunctionPermissionsapplyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResourcegetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validateclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddEventSource, addEventSourceMapping, addFunctionUrl, addFunctionUrl, addPermission, addToRolePolicy, configureAsyncInvoke, getIsBoundToVpc, getLatestVersion, getPermissionsNode, getResourceArnsForGrantInvoke, grantInvoke, grantInvokeUrl, metricDuration, metricDuration, metricErrors, metricErrors, metricInvocations, metricInvocations, metricThrottles, metricThrottlesapplyRemovalPolicy, getEnv, getStackgetNodegetConnectionsprotected Alias(software.amazon.jsii.JsiiObjectRef objRef)
protected Alias(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public Alias(software.constructs.Construct scope,
java.lang.String id,
AliasProps props)
scope - This parameter is required.id - This parameter is required.props - This parameter is required.public static IAlias fromAliasAttributes(software.constructs.Construct scope, java.lang.String id, AliasAttributes attrs)
scope - This parameter is required.id - This parameter is required.attrs - This parameter is required.public IScalableFunctionAttribute addAutoScaling(AutoScalingOptions options)
Returns a scalable attribute that can call
scaleOnUtilization() and scaleOnSchedule().
options - Autoscaling options. This parameter is required.public Metric metric(java.lang.String metricName, MetricOptions props)
metric in interface IFunctionmetric in class FunctionBasemetricName - This parameter is required.props - public Metric metric(java.lang.String metricName)
metric in interface IFunctionmetric in class FunctionBasemetricName - This parameter is required.public java.lang.String getAliasName()
getAliasName in interface IAliaspublic Architecture getArchitecture()
getArchitecture in interface IFunctiongetArchitecture in class FunctionBaseprotected java.lang.Boolean getCanCreatePermissions()
True for new Lambdas, false for version $LATEST and imported Lambdas from different accounts.
getCanCreatePermissions in class FunctionBasepublic java.lang.String getFunctionArn()
Used to be able to use Alias in place of a regular Lambda. Lambda accepts ARNs everywhere it accepts function names.
getFunctionArn in interface IClientVpnConnectionHandlergetFunctionArn in interface IFunctiongetFunctionArn in class FunctionBasepublic java.lang.String getFunctionName()
Used to be able to use Alias in place of a regular Lambda. Lambda accepts ARNs everywhere it accepts function names.
getFunctionName in interface IClientVpnConnectionHandlergetFunctionName in interface IFunctiongetFunctionName in class FunctionBasepublic IPrincipal getGrantPrincipal()
getGrantPrincipal in interface IGrantablegetGrantPrincipal in class FunctionBasepublic IFunction getLambda()
getLambda in class QualifiedFunctionBaseprotected java.lang.String getQualifier()
A qualifier is the identifier that's appended to a version or alias ARN.
public IVersion getVersion()
getVersion in interface IAliaspublic IRole getRole()
Undefined if the function was imported without a role.
getRole in interface IFunctiongetRole in class FunctionBase