2.173.3

interface CfnAliasProps

LanguageType name
.NETAmazon.CDK.AWS.Lambda.CfnAliasProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslambda#CfnAliasProps
Javasoftware.amazon.awscdk.services.lambda.CfnAliasProps
Pythonaws_cdk.aws_lambda.CfnAliasProps
TypeScript aws-cdk-lib » aws_lambda » CfnAliasProps

Properties for defining a CfnAlias.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html

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

NameTypeDescription
functionNamestringThe name or ARN of the Lambda function.
functionVersionstringThe function version that the alias invokes.
namestringThe name of the alias.
description?stringA description of the alias.
provisionedConcurrencyConfig?IResolvable | ProvisionedConcurrencyConfigurationPropertySpecifies a provisioned concurrency configuration for a function's alias.
routingConfig?IResolvable | AliasRoutingConfigurationPropertyThe 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionname

functionVersion

Type: string

The function version that the alias invokes.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionversion

name

Type: string

The name of the alias.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-name

description?

Type: string (optional)

A description of the alias.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-description

provisionedConcurrencyConfig?

Type: IResolvable | ProvisionedConcurrencyConfigurationProperty (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig

routingConfig?

Type: IResolvable | AliasRoutingConfigurationProperty (optional)

The routing configuration of the alias.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-routingconfig

← PreviousNext →