Package software.amazon.awscdk.services.lambda

Interface CfnAliasProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAliasProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:09.144Z")
@Stability(Stable)
public interface CfnAliasProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.lambda.*;
 CfnAliasProps cfnAliasProps = CfnAliasProps.builder()
         .functionName("functionName")
         .functionVersion("functionVersion")
         .name("name")
         // the properties below are optional
         .description("description")
         .provisionedConcurrencyConfig(ProvisionedConcurrencyConfigurationProperty.builder()
                 .provisionedConcurrentExecutions(123)
                 .build())
         .routingConfig(AliasRoutingConfigurationProperty.builder()
                 .additionalVersionWeights(List.of(VersionWeightProperty.builder()
                         .functionVersion("functionVersion")
                         .functionWeight(123)
                         .build()))
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAliasProps.Builder	A builder for CfnAliasProps
static final class	CfnAliasProps.Jsii$Proxy	An implementation for CfnAliasProps

Method Summary

Modifier and Type	Method	Description
static CfnAliasProps.Builder	builder()
default String	getDescription()	A description of the alias.
String	getFunctionName()	The name or ARN of the Lambda function.
String	getFunctionVersion()	The function version that the alias invokes.
String	getName()	The name of the alias.
default Object	getProvisionedConcurrencyConfig()	Specifies a provisioned concurrency configuration for a function's alias.
default Object	getRoutingConfig()	The routing configuration of the alias.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFunctionName

@Stability(Stable)
@NotNull
String getFunctionName()

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

getFunctionVersion

@Stability(Stable)
@NotNull
String getFunctionVersion()

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the alias.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the alias.

See Also:

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

getProvisionedConcurrencyConfig

@Stability(Stable)
@Nullable
default Object getProvisionedConcurrencyConfig()

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

getRoutingConfig

@Stability(Stable)
@Nullable
default Object getRoutingConfig()

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

builder

@Stability(Stable)
static CfnAliasProps.Builder builder()

Returns:

a CfnAliasProps.Builder of CfnAliasProps