CfnComponentVersion.LambdaExecutionParametersProperty

All Known Implementing Classes:: CfnComponentVersion.LambdaExecutionParametersProperty.Jsii$Proxy

Enclosing class:: CfnComponentVersion

public static interface CfnComponentVersion.LambdaExecutionParametersProperty

Contains parameters for a Lambda function that runs on AWS IoT Greengrass .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.greengrassv2.*;
 LambdaExecutionParametersProperty lambdaExecutionParametersProperty = LambdaExecutionParametersProperty.builder()
         .environmentVariables(Map.of(
                 "environmentVariablesKey", "environmentVariables"))
         .eventSources(List.of(LambdaEventSourceProperty.builder()
                 .topic("topic")
                 .type("type")
                 .build()))
         .execArgs(List.of("execArgs"))
         .inputPayloadEncodingType("inputPayloadEncodingType")
         .linuxProcessParams(LambdaLinuxProcessParamsProperty.builder()
                 .containerParams(LambdaContainerParamsProperty.builder()
                         .devices(List.of(LambdaDeviceMountProperty.builder()
                                 .addGroupOwner(false)
                                 .path("path")
                                 .permission("permission")
                                 .build()))
                         .memorySizeInKb(123)
                         .mountRoSysfs(false)
                         .volumes(List.of(LambdaVolumeMountProperty.builder()
                                 .addGroupOwner(false)
                                 .destinationPath("destinationPath")
                                 .permission("permission")
                                 .sourcePath("sourcePath")
                                 .build()))
                         .build())
                 .isolationMode("isolationMode")
                 .build())
         .maxIdleTimeInSeconds(123)
         .maxInstancesCount(123)
         .maxQueueSize(123)
         .pinned(false)
         .statusTimeoutInSeconds(123)
         .timeoutInSeconds(123)
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnComponentVersion.LambdaExecutionParametersProperty.Builder` A builder for `CfnComponentVersion.LambdaExecutionParametersProperty`
`static class`	`CfnComponentVersion.LambdaExecutionParametersProperty.Jsii$Proxy` An implementation for `CfnComponentVersion.LambdaExecutionParametersProperty`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static CfnComponentVersion.LambdaExecutionParametersProperty.Builder`	`builder()`
`default java.lang.Object`	`getEnvironmentVariables()` The map of environment variables that are available to the Lambda function when it runs.
`default java.lang.Object`	`getEventSources()` The list of event sources to which to subscribe to receive work messages.
`default java.util.List<java.lang.String>`	`getExecArgs()` The list of arguments to pass to the Lambda function when it runs.
`default java.lang.String`	`getInputPayloadEncodingType()` The encoding type that the Lambda function supports.
`default java.lang.Object`	`getLinuxProcessParams()` The parameters for the Linux process that contains the Lambda function.
`default java.lang.Number`	`getMaxIdleTimeInSeconds()` The maximum amount of time in seconds that a non-pinned Lambda function can idle before the software stops its process.
`default java.lang.Number`	`getMaxInstancesCount()` The maximum number of instances that a non-pinned Lambda function can run at the same time.
`default java.lang.Number`	`getMaxQueueSize()` The maximum size of the message queue for the Lambda function component.
`default java.lang.Object`	`getPinned()` Whether or not the Lambda function is pinned, or long-lived.
`default java.lang.Number`	`getStatusTimeoutInSeconds()` The interval in seconds at which a pinned (also known as long-lived) Lambda function component sends status updates to the Lambda manager component.
`default java.lang.Number`	`getTimeoutInSeconds()` The maximum amount of time in seconds that the Lambda function can process a work item.

- Method Detail
  - getEnvironmentVariables
```
default java.lang.Object getEnvironmentVariables()
```
    The map of environment variables that are available to the Lambda function when it runs.
  - getEventSources
```
default java.lang.Object getEventSources()
```
    The list of event sources to which to subscribe to receive work messages.
    The Lambda function runs when it receives a message from an event source. You can subscribe this function to local publish/subscribe messages and AWS IoT Core MQTT messages.
  - getExecArgs
```
default java.util.List<java.lang.String> getExecArgs()
```
    The list of arguments to pass to the Lambda function when it runs.
  - getInputPayloadEncodingType
```
default java.lang.String getInputPayloadEncodingType()
```
    The encoding type that the Lambda function supports.
    Default: json
  - getLinuxProcessParams
```
default java.lang.Object getLinuxProcessParams()
```
    The parameters for the Linux process that contains the Lambda function.
  - getMaxIdleTimeInSeconds
```
default java.lang.Number getMaxIdleTimeInSeconds()
```
    The maximum amount of time in seconds that a non-pinned Lambda function can idle before the software stops its process.
  - getMaxInstancesCount
```
default java.lang.Number getMaxInstancesCount()
```
    The maximum number of instances that a non-pinned Lambda function can run at the same time.
  - getMaxQueueSize
```
default java.lang.Number getMaxQueueSize()
```
    The maximum size of the message queue for the Lambda function component.
    The Greengrass core device stores messages in a FIFO (first-in-first-out) queue until it can run the Lambda function to consume each message.
  - getPinned
```
default java.lang.Object getPinned()
```
    Whether or not the Lambda function is pinned, or long-lived.
    - A pinned Lambda function starts when the starts and keeps running in its own container.
    - A non-pinned Lambda function starts only when it receives a work item and exists after it idles for maxIdleTimeInSeconds . If the function has multiple work items, the software creates multiple instances of the function.
    Default: true
  - getStatusTimeoutInSeconds
```
default java.lang.Number getStatusTimeoutInSeconds()
```
    The interval in seconds at which a pinned (also known as long-lived) Lambda function component sends status updates to the Lambda manager component.
  - getTimeoutInSeconds
```
default java.lang.Number getTimeoutInSeconds()
```
    The maximum amount of time in seconds that the Lambda function can process a work item.
  - builder
```
static CfnComponentVersion.LambdaExecutionParametersProperty.Builder builder()
```
    Returns:
    
    a CfnComponentVersion.LambdaExecutionParametersProperty.Builder of CfnComponentVersion.LambdaExecutionParametersProperty

Interface CfnComponentVersion.LambdaExecutionParametersProperty

Nested Class Summary

Method Summary

Method Detail

getEnvironmentVariables

getEventSources

getExecArgs

getInputPayloadEncodingType

getLinuxProcessParams

getMaxIdleTimeInSeconds

getMaxInstancesCount

getMaxQueueSize

getPinned

getStatusTimeoutInSeconds

getTimeoutInSeconds

builder