software.amazon.awscdk.services.lambda

Class CfnFunction.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.CfnFunction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFunction>

Enclosing class:

CfnFunction

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

A fluent builder for CfnFunction.

Method Summary

Modifier and Type	Method and Description
CfnFunction.Builder	architectures(List<String> architectures) The instruction set architecture that the function supports.
CfnFunction	build()
CfnFunction.Builder	code(CfnFunction.CodeProperty code) The code for the function.
CfnFunction.Builder	code(IResolvable code) The code for the function.
CfnFunction.Builder	codeSigningConfigArn(String codeSigningConfigArn) To enable code signing for this function, specify the ARN of a code-signing configuration.
static CfnFunction.Builder	create(software.constructs.Construct scope, String id)
CfnFunction.Builder	deadLetterConfig(CfnFunction.DeadLetterConfigProperty deadLetterConfig) A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.
CfnFunction.Builder	deadLetterConfig(IResolvable deadLetterConfig) A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.
CfnFunction.Builder	description(String description) A description of the function.
CfnFunction.Builder	environment(CfnFunction.EnvironmentProperty environment) Environment variables that are accessible from function code during execution.
CfnFunction.Builder	environment(IResolvable environment) Environment variables that are accessible from function code during execution.
CfnFunction.Builder	ephemeralStorage(CfnFunction.EphemeralStorageProperty ephemeralStorage) The size of the function’s /tmp directory in MB.
CfnFunction.Builder	ephemeralStorage(IResolvable ephemeralStorage) The size of the function’s /tmp directory in MB.
CfnFunction.Builder	fileSystemConfigs(IResolvable fileSystemConfigs) Connection settings for an Amazon EFS file system.
CfnFunction.Builder	fileSystemConfigs(List<? extends Object> fileSystemConfigs) Connection settings for an Amazon EFS file system.
CfnFunction.Builder	functionName(String functionName) The name of the Lambda function, up to 64 characters in length.
CfnFunction.Builder	handler(String handler) The name of the method within your code that Lambda calls to execute your function.
CfnFunction.Builder	imageConfig(CfnFunction.ImageConfigProperty imageConfig) Configuration values that override the container image Dockerfile settings.
CfnFunction.Builder	imageConfig(IResolvable imageConfig) Configuration values that override the container image Dockerfile settings.
CfnFunction.Builder	kmsKeyArn(String kmsKeyArn) The ARN of the AWS Key Management Service ( AWS KMS ) key that's used to encrypt your function's environment variables.
CfnFunction.Builder	layers(List<String> layers) A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment.
CfnFunction.Builder	memorySize(Number memorySize) The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html) at runtime.
CfnFunction.Builder	packageType(String packageType) The type of deployment package.
CfnFunction.Builder	reservedConcurrentExecutions(Number reservedConcurrentExecutions) The number of simultaneous executions to reserve for the function.
CfnFunction.Builder	role(String role) The Amazon Resource Name (ARN) of the function's execution role.
CfnFunction.Builder	runtime(String runtime) The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) .
CfnFunction.Builder	tags(List<? extends CfnTag> tags) A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.
CfnFunction.Builder	timeout(Number timeout) The amount of time (in seconds) that Lambda allows a function to run before stopping it.
CfnFunction.Builder	tracingConfig(CfnFunction.TracingConfigProperty tracingConfig) Set `Mode` to `Active` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) .
CfnFunction.Builder	tracingConfig(IResolvable tracingConfig) Set `Mode` to `Active` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) .
CfnFunction.Builder	vpcConfig(CfnFunction.VpcConfigProperty vpcConfig) For network connectivity to AWS resources in a [VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-network.html) , specify a list of security groups and subnets in the VPC.
CfnFunction.Builder	vpcConfig(IResolvable vpcConfig) For network connectivity to AWS resources in a [VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-network.html) , specify a list of security groups and subnets in the VPC.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnFunction.Builder create(software.constructs.Construct scope,
                                                                  String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnFunction.CodeProperty.Builder.

code

@Stability(value=Stable)
public CfnFunction.Builder code(CfnFunction.CodeProperty code)

The code for the function.

Parameters:

code - The code for the function. This parameter is required.

Returns:

this

code

@Stability(value=Stable)
public CfnFunction.Builder code(IResolvable code)

The code for the function.

Parameters:

code - The code for the function. This parameter is required.

Returns:

this

role

@Stability(value=Stable)
public CfnFunction.Builder role(String role)

The Amazon Resource Name (ARN) of the function's execution role.

Parameters:

role - The Amazon Resource Name (ARN) of the function's execution role. This parameter is required.

Returns:

this

architectures

@Stability(value=Stable)
public CfnFunction.Builder architectures(List<String> architectures)

The instruction set architecture that the function supports.

Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64 .

Parameters:

architectures - The instruction set architecture that the function supports. This parameter is required.

Returns:

this

codeSigningConfigArn

@Stability(value=Stable)
public CfnFunction.Builder codeSigningConfigArn(String codeSigningConfigArn)

To enable code signing for this function, specify the ARN of a code-signing configuration.

A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.

Parameters:

codeSigningConfigArn - To enable code signing for this function, specify the ARN of a code-signing configuration. This parameter is required.

Returns:

this

deadLetterConfig

@Stability(value=Stable)
public CfnFunction.Builder deadLetterConfig(CfnFunction.DeadLetterConfigProperty deadLetterConfig)

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.

For more information, see Dead Letter Queues .

Parameters:

deadLetterConfig - A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. This parameter is required.

Returns:

this

deadLetterConfig

@Stability(value=Stable)
public CfnFunction.Builder deadLetterConfig(IResolvable deadLetterConfig)

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.

For more information, see Dead Letter Queues .

Parameters:

deadLetterConfig - A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. This parameter is required.

Returns:

this

description

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

A description of the function.

Parameters:

description - A description of the function. This parameter is required.

Returns:

this

environment

@Stability(value=Stable)
public CfnFunction.Builder environment(CfnFunction.EnvironmentProperty environment)

Environment variables that are accessible from function code during execution.

Parameters:

environment - Environment variables that are accessible from function code during execution. This parameter is required.

Returns:

this

environment

@Stability(value=Stable)
public CfnFunction.Builder environment(IResolvable environment)

Environment variables that are accessible from function code during execution.

Parameters:

environment - Environment variables that are accessible from function code during execution. This parameter is required.

Returns:

this

ephemeralStorage

@Stability(value=Stable)
public CfnFunction.Builder ephemeralStorage(CfnFunction.EphemeralStorageProperty ephemeralStorage)

The size of the function’s /tmp directory in MB.

The default value is 512, but can be any whole number between 512 and 10240 MB.

Parameters:

ephemeralStorage - The size of the function’s /tmp directory in MB. This parameter is required.

Returns:

this

ephemeralStorage

@Stability(value=Stable)
public CfnFunction.Builder ephemeralStorage(IResolvable ephemeralStorage)

The size of the function’s /tmp directory in MB.

The default value is 512, but can be any whole number between 512 and 10240 MB.

Parameters:

ephemeralStorage - The size of the function’s /tmp directory in MB. This parameter is required.

Returns:

this

fileSystemConfigs

@Stability(value=Stable)
public CfnFunction.Builder fileSystemConfigs(IResolvable fileSystemConfigs)

Connection settings for an Amazon EFS file system.

To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function.

For more information about using the DependsOn attribute, see DependsOn Attribute .

Parameters:

fileSystemConfigs - Connection settings for an Amazon EFS file system. This parameter is required.

Returns:

this

fileSystemConfigs

@Stability(value=Stable)
public CfnFunction.Builder fileSystemConfigs(List<? extends Object> fileSystemConfigs)

Connection settings for an Amazon EFS file system.

To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function.

For more information about using the DependsOn attribute, see DependsOn Attribute .

Parameters:

fileSystemConfigs - Connection settings for an Amazon EFS file system. This parameter is required.

Returns:

this

functionName

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

The name of the Lambda function, up to 64 characters in length.

If you don't specify a name, AWS CloudFormation generates one.

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Parameters:

functionName - The name of the Lambda function, up to 64 characters in length. This parameter is required.

Returns:

this

handler

@Stability(value=Stable)
public CfnFunction.Builder handler(String handler)

The name of the method within your code that Lambda calls to execute your function.

Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model .

Parameters:

handler - The name of the method within your code that Lambda calls to execute your function. This parameter is required.

Returns:

this

imageConfig

@Stability(value=Stable)
public CfnFunction.Builder imageConfig(CfnFunction.ImageConfigProperty imageConfig)

Configuration values that override the container image Dockerfile settings.

See Container settings .

Parameters:

imageConfig - Configuration values that override the container image Dockerfile settings. This parameter is required.

Returns:

this

imageConfig

@Stability(value=Stable)
public CfnFunction.Builder imageConfig(IResolvable imageConfig)

Configuration values that override the container image Dockerfile settings.

See Container settings .

Parameters:

imageConfig - Configuration values that override the container image Dockerfile settings. This parameter is required.

Returns:

this

kmsKeyArn

@Stability(value=Stable)
public CfnFunction.Builder kmsKeyArn(String kmsKeyArn)

The ARN of the AWS Key Management Service ( AWS KMS ) key that's used to encrypt your function's environment variables.

If it's not provided, AWS Lambda uses a default service key.

Parameters:

kmsKeyArn - The ARN of the AWS Key Management Service ( AWS KMS ) key that's used to encrypt your function's environment variables. This parameter is required.

Returns:

this

layers

@Stability(value=Stable)
public CfnFunction.Builder layers(List<String> layers)

A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version.

Parameters:

layers - A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version. This parameter is required.

Returns:

this

memorySize

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

The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

Parameters:

memorySize - The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. This parameter is required.

Returns:

this

packageType

@Stability(value=Stable)
public CfnFunction.Builder packageType(String packageType)

The type of deployment package.

Set to Image for container image and set Zip for .zip file archive.

Parameters:

packageType - The type of deployment package. This parameter is required.

Returns:

this

reservedConcurrentExecutions

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

The number of simultaneous executions to reserve for the function.

Parameters:

reservedConcurrentExecutions - The number of simultaneous executions to reserve for the function. This parameter is required.

Returns:

this

runtime

@Stability(value=Stable)
public CfnFunction.Builder runtime(String runtime)

The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) . Runtime is required if the deployment package is a .zip file archive.

Parameters:

runtime - The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) . Runtime is required if the deployment package is a .zip file archive. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnFunction.Builder tags(List<? extends CfnTag> tags)

A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.

Parameters:

tags - A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function. This parameter is required.

Returns:

this

timeout

@Stability(value=Stable)
public CfnFunction.Builder timeout(Number timeout)

The amount of time (in seconds) that Lambda allows a function to run before stopping it.

The default is 3 seconds. The maximum allowed value is 900 seconds. For additional information, see Lambda execution environment .

Parameters:

timeout - The amount of time (in seconds) that Lambda allows a function to run before stopping it. This parameter is required.

Returns:

this

tracingConfig

@Stability(value=Stable)
public CfnFunction.Builder tracingConfig(CfnFunction.TracingConfigProperty tracingConfig)

Set `Mode` to `Active` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) .

Parameters:

tracingConfig - Set `Mode` to `Active` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) . This parameter is required.

Returns:

this

tracingConfig

@Stability(value=Stable)
public CfnFunction.Builder tracingConfig(IResolvable tracingConfig)

Set `Mode` to `Active` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) .

Parameters:

tracingConfig - Set `Mode` to `Active` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) . This parameter is required.

Returns:

this

vpcConfig

@Stability(value=Stable)
public CfnFunction.Builder vpcConfig(CfnFunction.VpcConfigProperty vpcConfig)

For network connectivity to AWS resources in a [VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-network.html) , specify a list of security groups and subnets in the VPC.

Parameters:

vpcConfig - For network connectivity to AWS resources in a [VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-network.html) , specify a list of security groups and subnets in the VPC. This parameter is required.

Returns:

this

vpcConfig

@Stability(value=Stable)
public CfnFunction.Builder vpcConfig(IResolvable vpcConfig)

For network connectivity to AWS resources in a [VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-network.html) , specify a list of security groups and subnets in the VPC.

Parameters:

vpcConfig - For network connectivity to AWS resources in a [VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-network.html) , specify a list of security groups and subnets in the VPC. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnFunction build()

Specified by:

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