software.amazon.awscdk.services.greengrass

Interface CfnFunctionDefinition.FunctionProperty

All Known Implementing Classes:

CfnFunctionDefinition.FunctionProperty.Jsii$Proxy

Enclosing class:

CfnFunctionDefinition

public static interface CfnFunctionDefinition.FunctionProperty

A function is a Lambda function that's referenced from an AWS IoT Greengrass group.

The function is deployed to a Greengrass core where it runs locally. For more information, see Run Lambda Functions on the AWS IoT Greengrass Core in the Developer Guide .

In an AWS CloudFormation template, the Functions property of the FunctionDefinitionVersion property type contains a list of Function property types.

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;
 FunctionProperty functionProperty = FunctionProperty.builder()
         .functionArn("functionArn")
         .functionConfiguration(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())
         .id("id")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnFunctionDefinition.FunctionProperty.Builder	builder()
java.lang.String	getFunctionArn() The Amazon Resource Name (ARN) of the alias (recommended) or version of the referenced Lambda function.
java.lang.Object	getFunctionConfiguration() The group-specific settings of the Lambda function.
java.lang.String	getId() A descriptive or arbitrary ID for the function.

Method Detail

getFunctionArn

java.lang.String getFunctionArn()

The Amazon Resource Name (ARN) of the alias (recommended) or version of the referenced Lambda function.

getFunctionConfiguration

java.lang.Object getFunctionConfiguration()

The group-specific settings of the Lambda function.

These settings configure the function's behavior in the Greengrass group.

getId

java.lang.String getId()

A descriptive or arbitrary ID for the function.

This value must be unique within the function definition version. Maximum length is 128 characters with pattern [a-zA-Z0-9:_-]+ .

builder

static CfnFunctionDefinition.FunctionProperty.Builder builder()

Returns:

a CfnFunctionDefinition.FunctionProperty.Builder of CfnFunctionDefinition.FunctionProperty