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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFunctionDefinition.FunctionConfigurationProperty.Builder	A builder for CfnFunctionDefinition.FunctionConfigurationProperty
static final class	CfnFunctionDefinition.FunctionConfigurationProperty.Jsii$Proxy	An implementation for CfnFunctionDefinition.FunctionConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnFunctionDefinition.FunctionConfigurationProperty.Builder	builder()
default String	getEncodingType()	The expected encoding type of the input payload for the function.
default Object	getEnvironment()	The environment configuration of the function.
default String	getExecArgs()	The execution arguments.
default String	getExecutable()	The name of the function executable.
default Number	getMemorySize()	The memory size (in KB) required by the function.
default Object	getPinned()	Indicates whether the function is pinned (or long-lived ).
default Number	getTimeout()	The allowed execution time (in seconds) after which the function should terminate.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-encodingtype

getEnvironment

@Stability(Stable)
@Nullable
default Object getEnvironment()

The environment configuration of the function.

Returns union: either IResolvable or CfnFunctionDefinition.EnvironmentProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-environment

getExecArgs

@Stability(Stable)
@Nullable
default String getExecArgs()

The execution arguments.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-execargs

getExecutable

@Stability(Stable)
@Nullable
default String getExecutable()

The name of the function executable.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-memorysize

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.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-pinned

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-timeout

builder

@Stability(Stable)
static CfnFunctionDefinition.FunctionConfigurationProperty.Builder builder()

Returns:

a CfnFunctionDefinition.FunctionConfigurationProperty.Builder of CfnFunctionDefinition.FunctionConfigurationProperty