software.amazon.awscdk.services.lambda

Class AliasProps.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.AliasProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AliasProps>

Enclosing interface:

AliasProps

@Stability(value=Experimental)
public static final class AliasProps.Builder
extends Object
implements software.amazon.jsii.Builder<AliasProps>

A builder for AliasProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AliasProps.Builder	additionalVersions(List<? extends VersionWeight> additionalVersions) Sets the value of AliasOptions.getAdditionalVersions()
AliasProps.Builder	aliasName(String aliasName) Sets the value of AliasProps.getAliasName()
AliasProps	build() Builds the configured instance.
AliasProps.Builder	description(String description) Sets the value of AliasOptions.getDescription()
AliasProps.Builder	maxEventAge(Duration maxEventAge) Sets the value of EventInvokeConfigOptions.getMaxEventAge()
AliasProps.Builder	onFailure(IDestination onFailure) Sets the value of EventInvokeConfigOptions.getOnFailure()
AliasProps.Builder	onSuccess(IDestination onSuccess) Sets the value of EventInvokeConfigOptions.getOnSuccess()
AliasProps.Builder	provisionedConcurrentExecutions(Number provisionedConcurrentExecutions) Sets the value of AliasOptions.getProvisionedConcurrentExecutions()
AliasProps.Builder	retryAttempts(Number retryAttempts) Sets the value of EventInvokeConfigOptions.getRetryAttempts()
AliasProps.Builder	version(IVersion version) Sets the value of AliasProps.getVersion()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

aliasName

@Stability(value=Experimental)
public AliasProps.Builder aliasName(String aliasName)

Sets the value of AliasProps.getAliasName()

Parameters:

aliasName - Name of this alias. This parameter is required.

Returns:

this

version

@Stability(value=Experimental)
public AliasProps.Builder version(IVersion version)

Sets the value of AliasProps.getVersion()

Parameters:

version - Function version this alias refers to. This parameter is required. Use lambda.addVersion() to obtain a new lambda version to refer to.

Returns:

this

additionalVersions

@Stability(value=Experimental)
public AliasProps.Builder additionalVersions(List<? extends VersionWeight> additionalVersions)

Sets the value of AliasOptions.getAdditionalVersions()

Parameters:

additionalVersions - 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.

Returns:

this

description

@Stability(value=Experimental)
public AliasProps.Builder description(String description)

Sets the value of AliasOptions.getDescription()

Parameters:

description - Description for the alias.

Returns:

this

provisionedConcurrentExecutions

@Stability(value=Experimental)
public AliasProps.Builder provisionedConcurrentExecutions(Number provisionedConcurrentExecutions)

Sets the value of AliasOptions.getProvisionedConcurrentExecutions()

Parameters:

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

Returns:

this

maxEventAge

@Stability(value=Experimental)
public AliasProps.Builder maxEventAge(Duration maxEventAge)

Sets the value of EventInvokeConfigOptions.getMaxEventAge()

Parameters:

maxEventAge - The maximum age of a request that Lambda sends to a function for processing. Minimum: 60 seconds Maximum: 6 hours

Returns:

this

onFailure

@Stability(value=Experimental)
public AliasProps.Builder onFailure(IDestination onFailure)

Sets the value of EventInvokeConfigOptions.getOnFailure()

Parameters:

onFailure - The destination for failed invocations.

Returns:

this

onSuccess

@Stability(value=Experimental)
public AliasProps.Builder onSuccess(IDestination onSuccess)

Sets the value of EventInvokeConfigOptions.getOnSuccess()

Parameters:

onSuccess - The destination for successful invocations.

Returns:

this

retryAttempts

@Stability(value=Experimental)
public AliasProps.Builder retryAttempts(Number retryAttempts)

Sets the value of EventInvokeConfigOptions.getRetryAttempts()

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. Minimum: 0 Maximum: 2

Returns:

this

build

@Stability(value=Experimental)
public AliasProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<AliasProps>

Returns:

a new instance of AliasProps

Throws:

NullPointerException - if any required attribute was not provided