software.amazon.awscdk.services.lambda

Interface AliasOptions

All Superinterfaces:

EventInvokeConfigOptions

All Known Subinterfaces:

AliasProps

All Known Implementing Classes:

AliasOptions.Jsii$Proxy, AliasProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:04.596Z")
public interface AliasOptions
extends 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.services.lambda.*;
 import software.amazon.awscdk.core.*;
 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 and Description
static class	AliasOptions.Builder A builder for AliasOptions
static class	AliasOptions.Jsii$Proxy An implementation for AliasOptions

Method Summary

Modifier and Type	Method and Description
static AliasOptions.Builder	builder()
default java.util.List<VersionWeight>	getAdditionalVersions() Additional versions with individual weights this alias points to.
default java.lang.String	getDescription() Description for the alias.
default java.lang.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

Method Detail

getAdditionalVersions

default java.util.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

default java.lang.String getDescription()

Description for the alias.

Default: No description

getProvisionedConcurrentExecutions

default java.lang.Number getProvisionedConcurrentExecutions()

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

Default: No provisioned concurrency

builder

static AliasOptions.Builder builder()

Specified by:

builder in interface EventInvokeConfigOptions

Returns:

a AliasOptions.Builder of AliasOptions