software.amazon.awscdk.services.lambda.nodejs

Class NodejsFunctionProps.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.nodejs.NodejsFunctionProps.Builder

Enclosing interface:

NodejsFunctionProps

@Stability(value=Experimental)
public static final class NodejsFunctionProps.Builder
extends Object

A builder for NodejsFunctionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
NodejsFunctionProps.Builder	allowAllOutbound(Boolean allowAllOutbound) Sets the value of FunctionOptions.getAllowAllOutbound()
NodejsFunctionProps	build() Builds the configured instance.
NodejsFunctionProps.Builder	buildDir(String buildDir) Sets the value of NodejsFunctionProps.getBuildDir()
NodejsFunctionProps.Builder	cacheDir(String cacheDir) Sets the value of NodejsFunctionProps.getCacheDir()
NodejsFunctionProps.Builder	deadLetterQueue(software.amazon.awscdk.services.sqs.IQueue deadLetterQueue) Sets the value of FunctionOptions.getDeadLetterQueue()
NodejsFunctionProps.Builder	deadLetterQueueEnabled(Boolean deadLetterQueueEnabled) Sets the value of FunctionOptions.getDeadLetterQueueEnabled()
NodejsFunctionProps.Builder	description(String description) Sets the value of FunctionOptions.getDescription()
NodejsFunctionProps.Builder	entry(String entry) Sets the value of NodejsFunctionProps.getEntry()
NodejsFunctionProps.Builder	environment(Map<String,String> environment) Sets the value of FunctionOptions.getEnvironment()
NodejsFunctionProps.Builder	events(List<software.amazon.awscdk.services.lambda.IEventSource> events) Sets the value of FunctionOptions.getEvents()
NodejsFunctionProps.Builder	functionName(String functionName) Sets the value of FunctionOptions.getFunctionName()
NodejsFunctionProps.Builder	handler(String handler) Sets the value of NodejsFunctionProps.getHandler()
NodejsFunctionProps.Builder	initialPolicy(List<software.amazon.awscdk.services.iam.PolicyStatement> initialPolicy) Sets the value of FunctionOptions.getInitialPolicy()
NodejsFunctionProps.Builder	layers(List<software.amazon.awscdk.services.lambda.ILayerVersion> layers) Sets the value of FunctionOptions.getLayers()
NodejsFunctionProps.Builder	logRetention(software.amazon.awscdk.services.logs.RetentionDays logRetention) Sets the value of FunctionOptions.getLogRetention()
NodejsFunctionProps.Builder	logRetentionRole(software.amazon.awscdk.services.iam.IRole logRetentionRole) Sets the value of FunctionOptions.getLogRetentionRole()
NodejsFunctionProps.Builder	maxEventAge(software.amazon.awscdk.core.Duration maxEventAge) Sets the value of EventInvokeConfigOptions.getMaxEventAge()
NodejsFunctionProps.Builder	memorySize(Number memorySize) Sets the value of FunctionOptions.getMemorySize()
NodejsFunctionProps.Builder	minify(Boolean minify) Sets the value of NodejsFunctionProps.getMinify()
NodejsFunctionProps.Builder	onFailure(software.amazon.awscdk.services.lambda.IDestination onFailure) Sets the value of EventInvokeConfigOptions.getOnFailure()
NodejsFunctionProps.Builder	onSuccess(software.amazon.awscdk.services.lambda.IDestination onSuccess) Sets the value of EventInvokeConfigOptions.getOnSuccess()
NodejsFunctionProps.Builder	reservedConcurrentExecutions(Number reservedConcurrentExecutions) Sets the value of FunctionOptions.getReservedConcurrentExecutions()
NodejsFunctionProps.Builder	retryAttempts(Number retryAttempts) Sets the value of EventInvokeConfigOptions.getRetryAttempts()
NodejsFunctionProps.Builder	role(software.amazon.awscdk.services.iam.IRole role) Sets the value of FunctionOptions.getRole()
NodejsFunctionProps.Builder	runtime(software.amazon.awscdk.services.lambda.Runtime runtime) Sets the value of NodejsFunctionProps.getRuntime()
NodejsFunctionProps.Builder	securityGroup(software.amazon.awscdk.services.ec2.ISecurityGroup securityGroup) Deprecated. - This property is deprecated, use securityGroups instead
NodejsFunctionProps.Builder	securityGroups(List<software.amazon.awscdk.services.ec2.ISecurityGroup> securityGroups) Sets the value of FunctionOptions.getSecurityGroups()
NodejsFunctionProps.Builder	sourceMaps(Boolean sourceMaps) Sets the value of NodejsFunctionProps.getSourceMaps()
NodejsFunctionProps.Builder	timeout(software.amazon.awscdk.core.Duration timeout) Sets the value of FunctionOptions.getTimeout()
NodejsFunctionProps.Builder	tracing(software.amazon.awscdk.services.lambda.Tracing tracing) Sets the value of FunctionOptions.getTracing()
NodejsFunctionProps.Builder	vpc(software.amazon.awscdk.services.ec2.IVpc vpc) Sets the value of FunctionOptions.getVpc()
NodejsFunctionProps.Builder	vpcSubnets(software.amazon.awscdk.services.ec2.SubnetSelection vpcSubnets) Sets the value of FunctionOptions.getVpcSubnets()

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

buildDir

@Stability(value=Experimental)
public NodejsFunctionProps.Builder buildDir(String buildDir)

Sets the value of NodejsFunctionProps.getBuildDir()

Parameters:

buildDir - The build directory.

Returns:

this

cacheDir

@Stability(value=Experimental)
public NodejsFunctionProps.Builder cacheDir(String cacheDir)

Sets the value of NodejsFunctionProps.getCacheDir()

Parameters:

cacheDir - The cache directory. Parcel uses a filesystem cache for fast rebuilds.

Returns:

this

entry

@Stability(value=Experimental)
public NodejsFunctionProps.Builder entry(String entry)

Sets the value of NodejsFunctionProps.getEntry()

Parameters:

entry - Path to the entry file (JavaScript or TypeScript).

Returns:

this

handler

@Stability(value=Experimental)
public NodejsFunctionProps.Builder handler(String handler)

Sets the value of NodejsFunctionProps.getHandler()

Parameters:

handler - The name of the exported handler in the entry file.

Returns:

this

minify

@Stability(value=Experimental)
public NodejsFunctionProps.Builder minify(Boolean minify)

Sets the value of NodejsFunctionProps.getMinify()

Parameters:

minify - Whether to minify files when bundling.

Returns:

this

runtime

@Stability(value=Experimental)
public NodejsFunctionProps.Builder runtime(software.amazon.awscdk.services.lambda.Runtime runtime)

Sets the value of NodejsFunctionProps.getRuntime()

Parameters:

runtime - The runtime environment. Only runtimes of the Node.js family are supported.

Returns:

this

sourceMaps

@Stability(value=Experimental)
public NodejsFunctionProps.Builder sourceMaps(Boolean sourceMaps)

Sets the value of NodejsFunctionProps.getSourceMaps()

Parameters:

sourceMaps - Whether to include source maps when bundling.

Returns:

this

allowAllOutbound

@Stability(value=Stable)
public NodejsFunctionProps.Builder allowAllOutbound(Boolean allowAllOutbound)

Sets the value of FunctionOptions.getAllowAllOutbound()

Parameters:

allowAllOutbound - Whether to allow the Lambda to send all network traffic. If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets.

Returns:

this

deadLetterQueue

@Stability(value=Stable)
public NodejsFunctionProps.Builder deadLetterQueue(software.amazon.awscdk.services.sqs.IQueue deadLetterQueue)

Sets the value of FunctionOptions.getDeadLetterQueue()

Parameters:

deadLetterQueue - The SQS queue to use if DLQ is enabled.

Returns:

this

deadLetterQueueEnabled

@Stability(value=Stable)
public NodejsFunctionProps.Builder deadLetterQueueEnabled(Boolean deadLetterQueueEnabled)

Sets the value of FunctionOptions.getDeadLetterQueueEnabled()

Parameters:

deadLetterQueueEnabled - Enabled DLQ. If deadLetterQueue is undefined, an SQS queue with default options will be defined for your Function.

Returns:

this

description

@Stability(value=Stable)
public NodejsFunctionProps.Builder description(String description)

Sets the value of FunctionOptions.getDescription()

Parameters:

description - A description of the function.

Returns:

this

environment

@Stability(value=Stable)
public NodejsFunctionProps.Builder environment(Map<String,String> environment)

Sets the value of FunctionOptions.getEnvironment()

Parameters:

environment - Key-value pairs that Lambda caches and makes available for your Lambda functions. Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Lambda function source code.

Returns:

this

events

@Stability(value=Stable)
public NodejsFunctionProps.Builder events(List<software.amazon.awscdk.services.lambda.IEventSource> events)

Sets the value of FunctionOptions.getEvents()

Parameters:

events - Event sources for this function. You can also add event sources using addEventSource.

Returns:

this

functionName

@Stability(value=Stable)
public NodejsFunctionProps.Builder functionName(String functionName)

Sets the value of FunctionOptions.getFunctionName()

Parameters:

functionName - A name for the function.

Returns:

this

initialPolicy

@Stability(value=Stable)
public NodejsFunctionProps.Builder initialPolicy(List<software.amazon.awscdk.services.iam.PolicyStatement> initialPolicy)

Sets the value of FunctionOptions.getInitialPolicy()

Parameters:

initialPolicy - Initial policy statements to add to the created Lambda Role. You can call addToRolePolicy to the created lambda to add statements post creation.

Returns:

this

layers

@Stability(value=Stable)
public NodejsFunctionProps.Builder layers(List<software.amazon.awscdk.services.lambda.ILayerVersion> layers)

Sets the value of FunctionOptions.getLayers()

Parameters:

layers - A list of layers to add to the function's execution environment. You can configure your Lambda function to pull in additional code during initialization in the form of layers. Layers are packages of libraries or other dependencies that can be used by mulitple functions.

Returns:

this

logRetention

@Stability(value=Stable)
public NodejsFunctionProps.Builder logRetention(software.amazon.awscdk.services.logs.RetentionDays logRetention)

Sets the value of FunctionOptions.getLogRetention()

Parameters:

logRetention - The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to INFINITE.

Returns:

this

logRetentionRole

@Stability(value=Stable)
public NodejsFunctionProps.Builder logRetentionRole(software.amazon.awscdk.services.iam.IRole logRetentionRole)

Sets the value of FunctionOptions.getLogRetentionRole()

Parameters:

logRetentionRole - The IAM role for the Lambda function associated with the custom resource that sets the retention policy.

Returns:

this

memorySize

@Stability(value=Stable)
public NodejsFunctionProps.Builder memorySize(Number memorySize)

Sets the value of FunctionOptions.getMemorySize()

Parameters:

memorySize - The amount of memory, in MB, that is allocated to your Lambda function. Lambda uses this value to proportionally allocate the amount of CPU power. For more information, see Resource Model in the AWS Lambda Developer Guide.

Returns:

this

reservedConcurrentExecutions

@Stability(value=Stable)
public NodejsFunctionProps.Builder reservedConcurrentExecutions(Number reservedConcurrentExecutions)

Sets the value of FunctionOptions.getReservedConcurrentExecutions()

Parameters:

reservedConcurrentExecutions - The maximum of concurrent executions you want to reserve for the function.

Returns:

this

role

@Stability(value=Stable)
public NodejsFunctionProps.Builder role(software.amazon.awscdk.services.iam.IRole role)

Sets the value of FunctionOptions.getRole()

Parameters:

role - Lambda execution role. This is the role that will be assumed by the function upon execution. It controls the permissions that the function will have. The Role must be assumable by the 'lambda.amazonaws.com' service principal.

Returns:

this

securityGroup

@Stability(value=Deprecated)
 @Deprecated
public NodejsFunctionProps.Builder securityGroup(software.amazon.awscdk.services.ec2.ISecurityGroup securityGroup)

Deprecated. - This property is deprecated, use securityGroups instead

Sets the value of FunctionOptions.getSecurityGroup()

Parameters:

securityGroup - What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead. Only used if 'vpc' is supplied.

Use securityGroups property instead. Function constructor will throw an error if both are specified.

Returns:

this

securityGroups

@Stability(value=Stable)
public NodejsFunctionProps.Builder securityGroups(List<software.amazon.awscdk.services.ec2.ISecurityGroup> securityGroups)

Sets the value of FunctionOptions.getSecurityGroups()

Parameters:

securityGroups - The list of security groups to associate with the Lambda's network interfaces. Only used if 'vpc' is supplied.

Returns:

this

timeout

@Stability(value=Stable)
public NodejsFunctionProps.Builder timeout(software.amazon.awscdk.core.Duration timeout)

Sets the value of FunctionOptions.getTimeout()

Parameters:

timeout - The function execution time (in seconds) after which Lambda terminates the function. Because the execution time affects cost, set this value based on the function's expected execution time.

Returns:

this

tracing

@Stability(value=Stable)
public NodejsFunctionProps.Builder tracing(software.amazon.awscdk.services.lambda.Tracing tracing)

Sets the value of FunctionOptions.getTracing()

Parameters:

tracing - Enable AWS X-Ray Tracing for Lambda Function.

Returns:

this

vpc

@Stability(value=Stable)
public NodejsFunctionProps.Builder vpc(software.amazon.awscdk.services.ec2.IVpc vpc)

Sets the value of FunctionOptions.getVpc()

Parameters:

vpc - VPC network to place Lambda network interfaces. Specify this if the Lambda function needs to access resources in a VPC.

Returns:

this

vpcSubnets

@Stability(value=Stable)
public NodejsFunctionProps.Builder vpcSubnets(software.amazon.awscdk.services.ec2.SubnetSelection vpcSubnets)

Sets the value of FunctionOptions.getVpcSubnets()

Parameters:

vpcSubnets - Where to place the network interfaces within the VPC. Only used if 'vpc' is supplied. Note: internet access for Lambdas requires a NAT gateway, so picking Public subnets is not allowed.

Returns:

this

maxEventAge

@Stability(value=Stable)
public NodejsFunctionProps.Builder maxEventAge(software.amazon.awscdk.core.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=Stable)
public NodejsFunctionProps.Builder onFailure(software.amazon.awscdk.services.lambda.IDestination onFailure)

Sets the value of EventInvokeConfigOptions.getOnFailure()

Parameters:

onFailure - The destination for failed invocations.

Returns:

this

onSuccess

@Stability(value=Stable)
public NodejsFunctionProps.Builder onSuccess(software.amazon.awscdk.services.lambda.IDestination onSuccess)

Sets the value of EventInvokeConfigOptions.getOnSuccess()

Parameters:

onSuccess - The destination for successful invocations.

Returns:

this

retryAttempts

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

Builds the configured instance.

Returns:

a new instance of NodejsFunctionProps

Throws:

NullPointerException - if any required attribute was not provided