Package software.amazon.awscdk.services.lambda

Class AliasOptions.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.AliasOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AliasOptions>

Enclosing interface:

AliasOptions

@Stability(Stable)
public static final class AliasOptions.Builder
extends Object
implements software.amazon.jsii.Builder<AliasOptions>

A builder for AliasOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

additionalVersions

@Stability(Stable)
public AliasOptions.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(Stable)
public AliasOptions.Builder description(String description)

Sets the value of AliasOptions.getDescription()

Parameters:

description - Description for the alias.

Returns:

this

provisionedConcurrentExecutions

@Stability(Stable)
public AliasOptions.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(Stable)
public AliasOptions.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(Stable)
public AliasOptions.Builder onFailure(IDestination onFailure)

Sets the value of EventInvokeConfigOptions.getOnFailure()

Parameters:

onFailure - The destination for failed invocations.

Returns:

this

onSuccess

@Stability(Stable)
public AliasOptions.Builder onSuccess(IDestination onSuccess)

Sets the value of EventInvokeConfigOptions.getOnSuccess()

Parameters:

onSuccess - The destination for successful invocations.

Returns:

this

retryAttempts

@Stability(Stable)
public AliasOptions.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(Stable)
public AliasOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AliasOptions

Throws:

NullPointerException - if any required attribute was not provided