interface CfnAliasProps

Language	Type name
.NET	`Amazon.CDK.AWS.Lambda.CfnAliasProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awslambda#CfnAliasProps`
Java	`software.amazon.awscdk.services.lambda.CfnAliasProps`
Python	`aws_cdk.aws_lambda.CfnAliasProps`
TypeScript	`aws-cdk-lib` » `aws_lambda` » `CfnAliasProps`

Properties for defining a CfnAlias.

Example

// 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

Name	Type	Description
functionName	`string`	The name or ARN of the Lambda function.
functionVersion	`string`	The function version that the alias invokes.
name	`string`	The name of the alias.
description?	`string`	A description of the alias.
provisionedConcurrencyConfig?	`IResolvable` `\|` `ProvisionedConcurrencyConfigurationProperty`	Specifies a provisioned concurrency configuration for a function's alias.
routingConfig?	`IResolvable` `\|` `AliasRoutingConfigurationProperty`	The routing configuration of the alias.

functionName

Type: string

The name or ARN of the Lambda function.

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.

functionVersion

Type: string

The function version that the alias invokes.

name

Type: string

The name of the alias.

description?

Type: string (optional)

A description of the alias.

provisionedConcurrencyConfig?

Type: IResolvable | ProvisionedConcurrencyConfigurationProperty (optional)

Specifies a provisioned concurrency configuration for a function's alias.

routingConfig?

Type: IResolvable | AliasRoutingConfigurationProperty (optional)

The routing configuration of the alias.