CfnFunctionProps.Builder (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.awscdk.services.lambda.CfnFunctionProps.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<CfnFunctionProps>

Enclosing interface:: CfnFunctionProps

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

A builder for CfnFunctionProps

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CfnFunctionProps.Builder`	`architectures(List<String> architectures)` Sets the value of `CfnFunctionProps.getArchitectures()`
`CfnFunctionProps`	`build()` Builds the configured instance.
`CfnFunctionProps.Builder`	`code(CfnFunction.CodeProperty code)` Sets the value of `CfnFunctionProps.getCode()`
`CfnFunctionProps.Builder`	`code(IResolvable code)` Sets the value of `CfnFunctionProps.getCode()`
`CfnFunctionProps.Builder`	`codeSigningConfigArn(String codeSigningConfigArn)` Sets the value of `CfnFunctionProps.getCodeSigningConfigArn()`
`CfnFunctionProps.Builder`	`deadLetterConfig(CfnFunction.DeadLetterConfigProperty deadLetterConfig)` Sets the value of `CfnFunctionProps.getDeadLetterConfig()`
`CfnFunctionProps.Builder`	`deadLetterConfig(IResolvable deadLetterConfig)` Sets the value of `CfnFunctionProps.getDeadLetterConfig()`
`CfnFunctionProps.Builder`	`description(String description)` Sets the value of `CfnFunctionProps.getDescription()`
`CfnFunctionProps.Builder`	`environment(CfnFunction.EnvironmentProperty environment)` Sets the value of `CfnFunctionProps.getEnvironment()`
`CfnFunctionProps.Builder`	`environment(IResolvable environment)` Sets the value of `CfnFunctionProps.getEnvironment()`
`CfnFunctionProps.Builder`	`ephemeralStorage(CfnFunction.EphemeralStorageProperty ephemeralStorage)` Sets the value of `CfnFunctionProps.getEphemeralStorage()`
`CfnFunctionProps.Builder`	`ephemeralStorage(IResolvable ephemeralStorage)` Sets the value of `CfnFunctionProps.getEphemeralStorage()`
`CfnFunctionProps.Builder`	`fileSystemConfigs(IResolvable fileSystemConfigs)` Sets the value of `CfnFunctionProps.getFileSystemConfigs()`
`CfnFunctionProps.Builder`	`fileSystemConfigs(List<? extends Object> fileSystemConfigs)` Sets the value of `CfnFunctionProps.getFileSystemConfigs()`
`CfnFunctionProps.Builder`	`functionName(String functionName)` Sets the value of `CfnFunctionProps.getFunctionName()`
`CfnFunctionProps.Builder`	`handler(String handler)` Sets the value of `CfnFunctionProps.getHandler()`
`CfnFunctionProps.Builder`	`imageConfig(CfnFunction.ImageConfigProperty imageConfig)` Sets the value of `CfnFunctionProps.getImageConfig()`
`CfnFunctionProps.Builder`	`imageConfig(IResolvable imageConfig)` Sets the value of `CfnFunctionProps.getImageConfig()`
`CfnFunctionProps.Builder`	`kmsKeyArn(String kmsKeyArn)` Sets the value of `CfnFunctionProps.getKmsKeyArn()`
`CfnFunctionProps.Builder`	`layers(List<String> layers)` Sets the value of `CfnFunctionProps.getLayers()`
`CfnFunctionProps.Builder`	`memorySize(Number memorySize)` Sets the value of `CfnFunctionProps.getMemorySize()`
`CfnFunctionProps.Builder`	`packageType(String packageType)` Sets the value of `CfnFunctionProps.getPackageType()`
`CfnFunctionProps.Builder`	`reservedConcurrentExecutions(Number reservedConcurrentExecutions)` Sets the value of `CfnFunctionProps.getReservedConcurrentExecutions()`
`CfnFunctionProps.Builder`	`role(String role)` Sets the value of `CfnFunctionProps.getRole()`
`CfnFunctionProps.Builder`	`runtime(String runtime)` Sets the value of `CfnFunctionProps.getRuntime()`
`CfnFunctionProps.Builder`	`tags(List<? extends CfnTag> tags)` Sets the value of `CfnFunctionProps.getTags()`
`CfnFunctionProps.Builder`	`timeout(Number timeout)` Sets the value of `CfnFunctionProps.getTimeout()`
`CfnFunctionProps.Builder`	`tracingConfig(CfnFunction.TracingConfigProperty tracingConfig)` Sets the value of `CfnFunctionProps.getTracingConfig()`
`CfnFunctionProps.Builder`	`tracingConfig(IResolvable tracingConfig)` Sets the value of `CfnFunctionProps.getTracingConfig()`
`CfnFunctionProps.Builder`	`vpcConfig(CfnFunction.VpcConfigProperty vpcConfig)` Sets the value of `CfnFunctionProps.getVpcConfig()`
`CfnFunctionProps.Builder`	`vpcConfig(IResolvable vpcConfig)` Sets the value of `CfnFunctionProps.getVpcConfig()`

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
  - code
```
@Stability(value=Stable)
public CfnFunctionProps.Builder code(CfnFunction.CodeProperty code)
```
    Sets the value of CfnFunctionProps.getCode()
    
    Parameters:
    
    code - The code for the function. This parameter is required.
    
    Returns:
    
    this
  - code
```
@Stability(value=Stable)
public CfnFunctionProps.Builder code(IResolvable code)
```
    Sets the value of CfnFunctionProps.getCode()
    
    Parameters:
    
    code - The code for the function. This parameter is required.
    
    Returns:
    
    this
  - role
```
@Stability(value=Stable)
public CfnFunctionProps.Builder role(String role)
```
    Sets the value of CfnFunctionProps.getRole()
    
    Parameters:
    
    role - The Amazon Resource Name (ARN) of the function's execution role. This parameter is required.
    
    Returns:
    
    this
  - architectures
```
@Stability(value=Stable)
public CfnFunctionProps.Builder architectures(List<String> architectures)
```
    Sets the value of CfnFunctionProps.getArchitectures()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - codeSigningConfigArn
```
@Stability(value=Stable)
public CfnFunctionProps.Builder codeSigningConfigArn(String codeSigningConfigArn)
```
    Sets the value of CfnFunctionProps.getCodeSigningConfigArn()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - deadLetterConfig
```
@Stability(value=Stable)
public CfnFunctionProps.Builder deadLetterConfig(CfnFunction.DeadLetterConfigProperty deadLetterConfig)
```
    Sets the value of CfnFunctionProps.getDeadLetterConfig()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - deadLetterConfig
```
@Stability(value=Stable)
public CfnFunctionProps.Builder deadLetterConfig(IResolvable deadLetterConfig)
```
    Sets the value of CfnFunctionProps.getDeadLetterConfig()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - description
```
@Stability(value=Stable)
public CfnFunctionProps.Builder description(String description)
```
    Sets the value of CfnFunctionProps.getDescription()
    
    Parameters:
    
    description - A description of the function.
    
    Returns:
    
    this
  - environment
```
@Stability(value=Stable)
public CfnFunctionProps.Builder environment(CfnFunction.EnvironmentProperty environment)
```
    Sets the value of CfnFunctionProps.getEnvironment()
    
    Parameters:
    
    environment - Environment variables that are accessible from function code during execution.
    
    Returns:
    
    this
  - environment
```
@Stability(value=Stable)
public CfnFunctionProps.Builder environment(IResolvable environment)
```
    Sets the value of CfnFunctionProps.getEnvironment()
    
    Parameters:
    
    environment - Environment variables that are accessible from function code during execution.
    
    Returns:
    
    this
  - ephemeralStorage
```
@Stability(value=Stable)
public CfnFunctionProps.Builder ephemeralStorage(CfnFunction.EphemeralStorageProperty ephemeralStorage)
```
    Sets the value of CfnFunctionProps.getEphemeralStorage()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - ephemeralStorage
```
@Stability(value=Stable)
public CfnFunctionProps.Builder ephemeralStorage(IResolvable ephemeralStorage)
```
    Sets the value of CfnFunctionProps.getEphemeralStorage()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - fileSystemConfigs
```
@Stability(value=Stable)
public CfnFunctionProps.Builder fileSystemConfigs(IResolvable fileSystemConfigs)
```
    Sets the value of CfnFunctionProps.getFileSystemConfigs()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - fileSystemConfigs
```
@Stability(value=Stable)
public CfnFunctionProps.Builder fileSystemConfigs(List<? extends Object> fileSystemConfigs)
```
    Sets the value of CfnFunctionProps.getFileSystemConfigs()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - functionName
```
@Stability(value=Stable)
public CfnFunctionProps.Builder functionName(String functionName)
```
    Sets the value of CfnFunctionProps.getFunctionName()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - handler
```
@Stability(value=Stable)
public CfnFunctionProps.Builder handler(String handler)
```
    Sets the value of CfnFunctionProps.getHandler()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - imageConfig
```
@Stability(value=Stable)
public CfnFunctionProps.Builder imageConfig(CfnFunction.ImageConfigProperty imageConfig)
```
    Sets the value of CfnFunctionProps.getImageConfig()
    
    Parameters:
    
    imageConfig - Configuration values that override the container image Dockerfile settings. See Container settings .
    
    Returns:
    
    this
  - imageConfig
```
@Stability(value=Stable)
public CfnFunctionProps.Builder imageConfig(IResolvable imageConfig)
```
    Sets the value of CfnFunctionProps.getImageConfig()
    
    Parameters:
    
    imageConfig - Configuration values that override the container image Dockerfile settings. See Container settings .
    
    Returns:
    
    this
  - kmsKeyArn
```
@Stability(value=Stable)
public CfnFunctionProps.Builder kmsKeyArn(String kmsKeyArn)
```
    Sets the value of CfnFunctionProps.getKmsKeyArn()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - layers
```
@Stability(value=Stable)
public CfnFunctionProps.Builder layers(List<String> layers)
```
    Sets the value of CfnFunctionProps.getLayers()
    
    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.
    
    Returns:
    
    this
  - memorySize
```
@Stability(value=Stable)
public CfnFunctionProps.Builder memorySize(Number memorySize)
```
    Sets the value of CfnFunctionProps.getMemorySize()
    
    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.
    
    Returns:
    
    this
  - packageType
```
@Stability(value=Stable)
public CfnFunctionProps.Builder packageType(String packageType)
```
    Sets the value of CfnFunctionProps.getPackageType()
    
    Parameters:
    
    packageType - The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
    
    Returns:
    
    this
  - reservedConcurrentExecutions
```
@Stability(value=Stable)
public CfnFunctionProps.Builder reservedConcurrentExecutions(Number reservedConcurrentExecutions)
```
    Sets the value of CfnFunctionProps.getReservedConcurrentExecutions()
    
    Parameters:
    
    reservedConcurrentExecutions - The number of simultaneous executions to reserve for the function.
    
    Returns:
    
    this
  - runtime
```
@Stability(value=Stable)
public CfnFunctionProps.Builder runtime(String runtime)
```
    Sets the value of CfnFunctionProps.getRuntime()
    
    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.
    
    Returns:
    
    this
  - tags
```
@Stability(value=Stable)
public CfnFunctionProps.Builder tags(List<? extends CfnTag> tags)
```
    Sets the value of CfnFunctionProps.getTags()
    
    Parameters:
    
    tags - A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.
    
    Returns:
    
    this
  - timeout
```
@Stability(value=Stable)
public CfnFunctionProps.Builder timeout(Number timeout)
```
    Sets the value of CfnFunctionProps.getTimeout()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - tracingConfig
```
@Stability(value=Stable)
public CfnFunctionProps.Builder tracingConfig(CfnFunction.TracingConfigProperty tracingConfig)
```
    Sets the value of CfnFunctionProps.getTracingConfig()
    
    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) .
    
    Returns:
    
    this
  - tracingConfig
```
@Stability(value=Stable)
public CfnFunctionProps.Builder tracingConfig(IResolvable tracingConfig)
```
    Sets the value of CfnFunctionProps.getTracingConfig()
    
    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) .
    
    Returns:
    
    this
  - vpcConfig
```
@Stability(value=Stable)
public CfnFunctionProps.Builder vpcConfig(CfnFunction.VpcConfigProperty vpcConfig)
```
    Sets the value of CfnFunctionProps.getVpcConfig()
    
    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.
    
    Returns:
    
    this
  - vpcConfig
```
@Stability(value=Stable)
public CfnFunctionProps.Builder vpcConfig(IResolvable vpcConfig)
```
    Sets the value of CfnFunctionProps.getVpcConfig()
    
    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.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public CfnFunctionProps build()
```
    Builds the configured instance.
    
    Specified by:
    
    build in interface software.amazon.jsii.Builder<CfnFunctionProps>
    
    Returns:
    
    a new instance of CfnFunctionProps
    
    Throws:
    
    NullPointerException - if any required attribute was not provided

Class CfnFunctionProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

code

code

role

architectures

codeSigningConfigArn

deadLetterConfig

deadLetterConfig

description

environment

environment

ephemeralStorage

ephemeralStorage

fileSystemConfigs

fileSystemConfigs

functionName

handler

imageConfig

imageConfig

kmsKeyArn

layers

memorySize

packageType

reservedConcurrentExecutions

runtime

tags

timeout

tracingConfig

tracingConfig

vpcConfig

vpcConfig

build