software.amazon.awscdk.services.lambda

Interface FunctionProps.Builder.Build

Enclosing class:

FunctionProps.Builder

public static interface FunctionProps.Builder.Build

Method Summary

Modifier and Type	Method and Description
FunctionProps	build()
FunctionProps.Builder.Build	withDescription(String value) A description of the function.
FunctionProps.Builder.Build	withEnvironment(Map<String,Object> value) Key-value pairs that Lambda caches and makes available for your Lambda functions.
FunctionProps.Builder.Build	withFunctionName(String value) A name for the function.
FunctionProps.Builder.Build	withInitialPolicy(List<software.amazon.awscdk.PolicyStatement> value) Initial policy statements to add to the created Lambda Role.
FunctionProps.Builder.Build	withMemorySize(Number value) The amount of memory, in MB, that is allocated to your Lambda function.
FunctionProps.Builder.Build	withRole(software.amazon.awscdk.services.iam.Role value) Lambda execution role.
FunctionProps.Builder.Build	withTimeout(Number value) The function execution time (in seconds) after which Lambda terminates the function.

Method Detail

build

FunctionProps build()

Returns:

a new FunctionProps object, initialized with the values set on this builder.

withDescription

FunctionProps.Builder.Build withDescription(String value)

A description of the function.

withTimeout

FunctionProps.Builder.Build withTimeout(Number value)

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.

withEnvironment

FunctionProps.Builder.Build withEnvironment(Map<String,Object> value)

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.

withFunctionName

FunctionProps.Builder.Build withFunctionName(String value)

A name for the function. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type.

withMemorySize

FunctionProps.Builder.Build withMemorySize(Number value)

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.

withInitialPolicy

FunctionProps.Builder.Build withInitialPolicy(List<software.amazon.awscdk.PolicyStatement> value)

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

withRole

FunctionProps.Builder.Build withRole(software.amazon.awscdk.services.iam.Role value)

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.