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.74.0 (build 6d08790)",
           date="2023-05-10T17:05:56.384Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnAliasProps.Builder	builder()
default String	getDescription() A description of the alias.
String	getFunctionName() The name 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](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) configuration for a function's alias.
default Object	getRoutingConfig() The [routing configuration](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) of the alias.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFunctionName

@Stability(value=Stable)
 @NotNull
String getFunctionName()

The name 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.

getFunctionVersion

@Stability(value=Stable)
 @NotNull
String getFunctionVersion()

The function version that the alias invokes.

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name of the alias.

getDescription

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

A description of the alias.

getProvisionedConcurrencyConfig

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

Specifies a [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) configuration for a function's alias.

getRoutingConfig

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

The [routing configuration](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) of the alias.

builder

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

Returns:

a CfnAliasProps.Builder of CfnAliasProps