Package software.amazon.awscdk.services.lambda

Interface AliasOptions

All Superinterfaces:

EventInvokeConfigOptions, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AliasProps

All Known Implementing Classes:

AliasOptions.Jsii$Proxy, AliasProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:19.110Z")
@Stability(Stable)
public interface AliasOptions
extends software.amazon.jsii.JsiiSerializable, EventInvokeConfigOptions

Options for lambda.Alias.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.lambda.*;
 IDestination destination;
 Version version;
 AliasOptions aliasOptions = AliasOptions.builder()
         .additionalVersions(List.of(VersionWeight.builder()
                 .version(version)
                 .weight(123)
                 .build()))
         .description("description")
         .maxEventAge(Duration.minutes(30))
         .onFailure(destination)
         .onSuccess(destination)
         .provisionedConcurrentExecutions(123)
         .retryAttempts(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AliasOptions.Builder	builder()
default List<VersionWeight>	getAdditionalVersions()	Additional versions with individual weights this alias points to.
default String	getDescription()	Description for the alias.
default Number	getProvisionedConcurrentExecutions()	Specifies a provisioned concurrency configuration for a function's alias.

Methods inherited from interface software.amazon.awscdk.services.lambda.EventInvokeConfigOptions

getMaxEventAge, getOnFailure, getOnSuccess, getRetryAttempts

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdditionalVersions

@Stability(Stable)
@Nullable
default List<VersionWeight> getAdditionalVersions()

Additional versions with individual weights this alias points to.

Individual additional version weights specified here should add up to (less than) one. All remaining weight is routed to the default version.

For example, the config is

version: "1" additionalVersions: [{ version: "2", weight: 0.05 }]

Then 5% of traffic will be routed to function version 2, while the remaining 95% of traffic will be routed to function version 1.

Default: No additional versions

getDescription

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

Description for the alias.

Default: No description

getProvisionedConcurrentExecutions

@Stability(Stable)
@Nullable
default Number getProvisionedConcurrentExecutions()

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

Default: No provisioned concurrency

builder

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

Returns:

a AliasOptions.Builder of AliasOptions