Package software.amazon.awscdk.services.greengrass

Interface CfnFunctionDefinition.FunctionConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnFunctionDefinition.FunctionConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnFunctionDefinition
@Stability(Stable) public static interface CfnFunctionDefinition.FunctionConfigurationProperty extends software.amazon.jsii.JsiiSerializable
The group-specific configuration settings for a Lambda function.

These settings configure the function's behavior in the Greengrass group. For more information, see Controlling Execution of Greengrass Lambda Functions by Using Group-Specific Configuration in the Developer Guide .

In an AWS CloudFormation template, FunctionConfiguration is a property of the Function property type.

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.greengrass.*;
 Object variables;
 FunctionConfigurationProperty functionConfigurationProperty = FunctionConfigurationProperty.builder()
         .encodingType("encodingType")
         .environment(EnvironmentProperty.builder()
                 .accessSysfs(false)
                 .execution(ExecutionProperty.builder()
                         .isolationMode("isolationMode")
                         .runAs(RunAsProperty.builder()
                                 .gid(123)
                                 .uid(123)
                                 .build())
                         .build())
                 .resourceAccessPolicies(List.of(ResourceAccessPolicyProperty.builder()
                         .resourceId("resourceId")
                         // the properties below are optional
                         .permission("permission")
                         .build()))
                 .variables(variables)
                 .build())
         .execArgs("execArgs")
         .executable("executable")
         .memorySize(123)
         .pinned(false)
         .timeout(123)
         .build();

  • Method Details

    • getEncodingType

      @Stability(Stable) @Nullable default String getEncodingType()
      The expected encoding type of the input payload for the function.

      Valid values are json (default) and binary .

    • getEnvironment

      @Stability(Stable) @Nullable default Object getEnvironment()
      The environment configuration of the function.

    • getExecArgs

      @Stability(Stable) @Nullable default String getExecArgs()
      The execution arguments.

    • getExecutable

      @Stability(Stable) @Nullable default String getExecutable()
      The name of the function executable.

    • getMemorySize

      @Stability(Stable) @Nullable default Number getMemorySize()
      The memory size (in KB) required by the function.

      This property applies only to Lambda functions that run in a Greengrass container.

    • getPinned

      @Stability(Stable) @Nullable default Object getPinned()
      Indicates whether the function is pinned (or long-lived ).

      Pinned functions start when the core starts and process all requests in the same container. The default value is false.

    • getTimeout

      @Stability(Stable) @Nullable default Number getTimeout()
      The allowed execution time (in seconds) after which the function should terminate.

      For pinned functions, this timeout applies for each request.

    • builder

      @Stability(Stable) static CfnFunctionDefinition.FunctionConfigurationProperty.Builder builder()
      Returns:
      a CfnFunctionDefinition.FunctionConfigurationProperty.Builder of CfnFunctionDefinition.FunctionConfigurationProperty