AWS CDK Reference

Appearance

v2.274.0

CfnAliasProps Struct ​

Properties for defining a CfnAlias.

Source
Generated code
Type last changed
v2.239.0 · 19 Feb 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const cfnAliasProps: lambda.CfnAliasProps = {
  functionName: 'functionName',
  functionVersion: 'functionVersion',
  name: 'name',

  // the properties below are optional
  description: 'description',
  provisionedConcurrencyConfig: {
    provisionedConcurrentExecutions: 123,
  },
  routingConfig: {
    additionalVersionWeights: [{
      functionVersion: 'functionVersion',
      functionWeight: 123,
    }],
  },
};

Properties ​

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#
A description of the alias.
functionNamestring | IFunctionReffunction_nametyping.Union[str, IFunctionRef]functionNameStringFunctionNamestringFunctionNameinterface{}required#
The name or ARN of the Lambda function.
notes

Name formats - Function name - MyFunction .

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction .
  • Partial ARN - 123456789012:function:MyFunction .

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

functionVersionstringfunction_versionstrfunctionVersionStringFunctionVersionstringFunctionVersion*stringrequired#
The function version that the alias invokes.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the alias.
provisionedConcurrencyConfigIResolvable | CfnAlias.ProvisionedConcurrencyConfigurationPropertyprovisioned_concurrency_configtyping.Union[IResolvable, ProvisionedConcurrencyConfigurationProperty]provisionedConcurrencyConfigIResolvableProvisionedConcurrencyConfigIResolvableProvisionedConcurrencyConfiginterface{}#
Specifies a [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) configuration for a function's alias.
routingConfigIResolvable | CfnAlias.AliasRoutingConfigurationPropertyrouting_configtyping.Union[IResolvable, AliasRoutingConfigurationProperty]routingConfigIResolvableRoutingConfigIResolvableRoutingConfiginterface{}#
The [routing configuration](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) of the alias.