Package software.amazon.awscdk.cfnpropertymixins.services.greengrass

Class CfnFunctionDefinitionPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.greengrass.CfnFunctionDefinitionPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:59.807Z")
@Stability(Stable)
public class CfnFunctionDefinitionPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::Greengrass::FunctionDefinition resource represents a function definition for AWS IoT Greengrass .

Function definitions are used to organize your function definition versions.

Function definitions can reference multiple function definition versions. All function definition versions must be associated with a function definition. Each function definition version can contain one or more functions.

When you create a function definition, you can optionally include an initial function definition version. To associate a function definition version later, create an AWS::Greengrass::FunctionDefinitionVersion resource and specify the ID of this function definition.

After you create the function definition version that contains the functions you want to deploy, you must add it to your group version. For more information, see AWS::Greengrass::Group .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.greengrass.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 Object tags;
 Object variables;
 CfnFunctionDefinitionPropsMixin cfnFunctionDefinitionPropsMixin = CfnFunctionDefinitionPropsMixin.Builder.create(CfnFunctionDefinitionMixinProps.builder()
         .initialVersion(FunctionDefinitionVersionProperty.builder()
                 .defaultConfig(DefaultConfigProperty.builder()
                         .execution(ExecutionProperty.builder()
                                 .isolationMode("isolationMode")
                                 .runAs(RunAsProperty.builder()
                                         .gid(123)
                                         .uid(123)
                                         .build())
                                 .build())
                         .build())
                 .functions(List.of(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()
                                                 .permission("permission")
                                                 .resourceId("resourceId")
                                                 .build()))
                                         .variables(variables)
                                         .build())
                                 .execArgs("execArgs")
                                 .executable("executable")
                                 .memorySize(123)
                                 .pinned(false)
                                 .timeout(123)
                                 .build())
                         .id("id")
                         .build()))
                 .build())
         .name("name")
         .tags(tags)
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnFunctionDefinitionPropsMixin.Builder	A fluent builder for CfnFunctionDefinitionPropsMixin.
static interface	CfnFunctionDefinitionPropsMixin.DefaultConfigProperty	The default configuration that applies to all Lambda functions in the function definition version.
static interface	CfnFunctionDefinitionPropsMixin.EnvironmentProperty	The environment configuration for a Lambda function on the AWS IoT Greengrass core.
static interface	CfnFunctionDefinitionPropsMixin.ExecutionProperty	Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core.
static interface	CfnFunctionDefinitionPropsMixin.FunctionConfigurationProperty	The group-specific configuration settings for a Lambda function.
static interface	CfnFunctionDefinitionPropsMixin.FunctionDefinitionVersionProperty	A function definition version contains a list of functions.
static interface	CfnFunctionDefinitionPropsMixin.FunctionProperty	A function is a Lambda function that's referenced from an AWS IoT Greengrass group.
static interface	CfnFunctionDefinitionPropsMixin.ResourceAccessPolicyProperty	A list of the resources in the group that the function can access, with the corresponding read-only or read-write permissions.
static interface	CfnFunctionDefinitionPropsMixin.RunAsProperty	The access identity whose permissions are used to run the Lambda function.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnFunctionDefinitionPropsMixin(CfnFunctionDefinitionMixinProps props)	Create a mixin to apply properties to AWS::Greengrass::FunctionDefinition.
	CfnFunctionDefinitionPropsMixin(CfnFunctionDefinitionMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Greengrass::FunctionDefinition.
protected	CfnFunctionDefinitionPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFunctionDefinitionPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnFunctionDefinitionMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnFunctionDefinitionPropsMixin

protected CfnFunctionDefinitionPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnFunctionDefinitionPropsMixin

protected CfnFunctionDefinitionPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnFunctionDefinitionPropsMixin

@Stability(Stable)
public CfnFunctionDefinitionPropsMixin(@NotNull
 CfnFunctionDefinitionMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Greengrass::FunctionDefinition.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnFunctionDefinitionPropsMixin

@Stability(Stable)
public CfnFunctionDefinitionPropsMixin(@NotNull
 CfnFunctionDefinitionMixinProps props)

Create a mixin to apply properties to AWS::Greengrass::FunctionDefinition.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnFunctionDefinitionMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()