software.amazon.awscdk.services.greengrass

Class CfnFunctionDefinition

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.greengrass.CfnFunctionDefinition

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:15.452Z")
public class CfnFunctionDefinition
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Greengrass::FunctionDefinition`.

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.services.greengrass.*;
 Object tags;
 Object variables;
 CfnFunctionDefinition cfnFunctionDefinition = CfnFunctionDefinition.Builder.create(this, "MyCfnFunctionDefinition")
         .name("name")
         // the properties below are optional
         .initialVersion(FunctionDefinitionVersionProperty.builder()
                 .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()
                                                 .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()))
                 // the properties below are optional
                 .defaultConfig(DefaultConfigProperty.builder()
                         .execution(ExecutionProperty.builder()
                                 .isolationMode("isolationMode")
                                 .runAs(RunAsProperty.builder()
                                         .gid(123)
                                         .uid(123)
                                         .build())
                                 .build())
                         .build())
                 .build())
         .tags(tags)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnFunctionDefinition.Builder A fluent builder for CfnFunctionDefinition.
static interface	CfnFunctionDefinition.DefaultConfigProperty The default configuration that applies to all Lambda functions in the function definition version.
static interface	CfnFunctionDefinition.EnvironmentProperty The environment configuration for a Lambda function on the AWS IoT Greengrass core.
static interface	CfnFunctionDefinition.ExecutionProperty Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core.
static interface	CfnFunctionDefinition.FunctionConfigurationProperty The group-specific configuration settings for a Lambda function.
static interface	CfnFunctionDefinition.FunctionDefinitionVersionProperty A function definition version contains a list of functions.
static interface	CfnFunctionDefinition.FunctionProperty A function is a Lambda function that's referenced from an AWS IoT Greengrass group.
static interface	CfnFunctionDefinition.ResourceAccessPolicyProperty A list of the [resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html) in the group that the function can access, with the corresponding read-only or read-write permissions.
static interface	CfnFunctionDefinition.RunAsProperty The access identity whose permissions are used to run the Lambda function.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFunctionDefinition(Construct scope, java.lang.String id, CfnFunctionDefinitionProps props) Create a new `AWS::Greengrass::FunctionDefinition`.
protected	CfnFunctionDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFunctionDefinition(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) of the `FunctionDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/functions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
java.lang.String	getAttrId() The ID of the `FunctionDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
java.lang.String	getAttrLatestVersionArn() The ARN of the last `FunctionDefinitionVersion` that was added to the `FunctionDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/functions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2` .
java.lang.String	getAttrName() The name of the `FunctionDefinition` , such as `MyFunctionDefinition` .
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getInitialVersion() The function definition version to include when the function definition is created.
java.lang.String	getName() The name of the function definition.
TagManager	getTags() Application-specific metadata to attach to the function definition.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setInitialVersion(CfnFunctionDefinition.FunctionDefinitionVersionProperty value) The function definition version to include when the function definition is created.
void	setInitialVersion(IResolvable value) The function definition version to include when the function definition is created.
void	setName(java.lang.String value) The name of the function definition.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnFunctionDefinition

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

CfnFunctionDefinition

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

CfnFunctionDefinition

public CfnFunctionDefinition(Construct scope,
                             java.lang.String id,
                             CfnFunctionDefinitionProps props)

Create a new `AWS::Greengrass::FunctionDefinition`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The Amazon Resource Name (ARN) of the `FunctionDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/functions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .

getAttrId

public java.lang.String getAttrId()

The ID of the `FunctionDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .

getAttrLatestVersionArn

public java.lang.String getAttrLatestVersionArn()

The ARN of the last `FunctionDefinitionVersion` that was added to the `FunctionDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/functions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2` .

getAttrName

public java.lang.String getAttrName()

The name of the `FunctionDefinition` , such as `MyFunctionDefinition` .

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

Application-specific metadata to attach to the function definition.

You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tagging Your AWS IoT Greengrass Resources in the Developer Guide .

This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates.

 "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
 }
 

getName

public java.lang.String getName()

The name of the function definition.

setName

public void setName(java.lang.String value)

The name of the function definition.

getInitialVersion

public java.lang.Object getInitialVersion()

The function definition version to include when the function definition is created.

A function definition version contains a list of function property types.

To associate a function definition version after the function definition is created, create an AWS::Greengrass::FunctionDefinitionVersion resource and specify the ID of this function definition.

setInitialVersion

public void setInitialVersion(IResolvable value)

The function definition version to include when the function definition is created.

A function definition version contains a list of function property types.

To associate a function definition version after the function definition is created, create an AWS::Greengrass::FunctionDefinitionVersion resource and specify the ID of this function definition.

setInitialVersion

public void setInitialVersion(CfnFunctionDefinition.FunctionDefinitionVersionProperty value)

The function definition version to include when the function definition is created.

A function definition version contains a list of function property types.

To associate a function definition version after the function definition is created, create an AWS::Greengrass::FunctionDefinitionVersion resource and specify the ID of this function definition.