software.amazon.awscdk.services.lambda

Interface AliasProps

All Superinterfaces:

AliasOptions, EventInvokeConfigOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AliasProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.54.0 (build b1b977a)",
           date="2022-02-19T00:19:34.628Z")
 @Stability(value=Stable)
public interface AliasProps
extends software.amazon.jsii.JsiiSerializable, AliasOptions

Properties for a new Lambda alias.

Example:

 import software.amazon.awscdk.services.autoscaling.*;
 Function fn;
 Alias alias = Alias.Builder.create(this, "Alias")
         .aliasName("prod")
         .version(fn.getLatestVersion())
         .build();
 // Create AutoScaling target
 IScalableFunctionAttribute as = alias.addAutoScaling(AutoScalingOptions.builder().maxCapacity(50).build());
 // Configure Target Tracking
 as.scaleOnUtilization(UtilizationScalingOptions.builder()
         .utilizationTarget(0.5)
         .build());
 // Configure Scheduled Scaling
 as.scaleOnSchedule("ScaleUpInTheMorning", ScalingSchedule.builder()
         .schedule(Schedule.cron(CronOptions.builder().hour("8").minute("0").build()))
         .minCapacity(20)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static AliasProps.Builder	builder()
String	getAliasName() Name of this alias.
IVersion	getVersion() Function version this alias refers to.

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

getAdditionalVersions, getDescription, getProvisionedConcurrentExecutions

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 Detail

getAliasName

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

Name of this alias.

getVersion

@Stability(value=Stable)
 @NotNull
IVersion getVersion()

Function version this alias refers to.

Use lambda.addVersion() to obtain a new lambda version to refer to.

builder

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

Specified by:

builder in interface AliasOptions

Specified by:

builder in interface EventInvokeConfigOptions

Returns:

a AliasProps.Builder of AliasProps