software.amazon.awscdk.services.greengrass

Class CfnFunctionDefinitionVersion

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.greengrass.CfnFunctionDefinitionVersion

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.626Z")
 @Stability(value=Stable)
public class CfnFunctionDefinitionVersion
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Greengrass::FunctionDefinitionVersion`.

The AWS::Greengrass::FunctionDefinitionVersion resource represents a function definition version for AWS IoT Greengrass . A function definition version contains contain a list of functions.

To create a function definition version, you must specify the ID of the function definition that you want to associate with the version. For information about creating a function definition, see AWS::Greengrass::FunctionDefinition .

After you create a 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 variables;
 CfnFunctionDefinitionVersion cfnFunctionDefinitionVersion = CfnFunctionDefinitionVersion.Builder.create(this, "MyCfnFunctionDefinitionVersion")
         .functionDefinitionId("functionDefinitionId")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnFunctionDefinitionVersion.Builder A fluent builder for CfnFunctionDefinitionVersion.
static interface	CfnFunctionDefinitionVersion.DefaultConfigProperty The default configuration that applies to all Lambda functions in the function definition version.
static interface	CfnFunctionDefinitionVersion.EnvironmentProperty The environment configuration for a Lambda function on the AWS IoT Greengrass core.
static interface	CfnFunctionDefinitionVersion.ExecutionProperty Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core.
static interface	CfnFunctionDefinitionVersion.FunctionConfigurationProperty The group-specific configuration settings for a Lambda function.
static interface	CfnFunctionDefinitionVersion.FunctionProperty A function is a Lambda function that's referenced from an AWS IoT Greengrass group.
static interface	CfnFunctionDefinitionVersion.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	CfnFunctionDefinitionVersion.RunAsProperty The user and group permissions 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.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFunctionDefinitionVersion(software.constructs.Construct scope, String id, CfnFunctionDefinitionVersionProps props) Create a new `AWS::Greengrass::FunctionDefinitionVersion`.
protected	CfnFunctionDefinitionVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFunctionDefinitionVersion(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
Object	getDefaultConfig() The default configuration that applies to all Lambda functions in the group.
String	getFunctionDefinitionId() The ID of the function definition associated with this version.
Object	getFunctions() The functions in this version.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDefaultConfig(CfnFunctionDefinitionVersion.DefaultConfigProperty value) The default configuration that applies to all Lambda functions in the group.
void	setDefaultConfig(IResolvable value) The default configuration that applies to all Lambda functions in the group.
void	setFunctionDefinitionId(String value) The ID of the function definition associated with this version.
void	setFunctions(IResolvable value) The functions in this version.
void	setFunctions(List<Object> value) The functions in this version.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnFunctionDefinitionVersion

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

CfnFunctionDefinitionVersion

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

CfnFunctionDefinitionVersion

@Stability(value=Stable)
public CfnFunctionDefinitionVersion(@NotNull
                                                             software.constructs.Construct scope,
                                                             @NotNull
                                                             String id,
                                                             @NotNull
                                                             CfnFunctionDefinitionVersionProps props)

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

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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFunctionDefinitionId

@Stability(value=Stable)
 @NotNull
public String getFunctionDefinitionId()

The ID of the function definition associated with this version.

This value is a GUID.

setFunctionDefinitionId

@Stability(value=Stable)
public void setFunctionDefinitionId(@NotNull
                                                             String value)

The ID of the function definition associated with this version.

This value is a GUID.

getFunctions

@Stability(value=Stable)
 @NotNull
public Object getFunctions()

The functions in this version.

setFunctions

@Stability(value=Stable)
public void setFunctions(@NotNull
                                                  IResolvable value)

The functions in this version.

setFunctions

@Stability(value=Stable)
public void setFunctions(@NotNull
                                                  List<Object> value)

The functions in this version.

getDefaultConfig

@Stability(value=Stable)
 @Nullable
public Object getDefaultConfig()

The default configuration that applies to all Lambda functions in the group.

Individual Lambda functions can override these settings.

setDefaultConfig

@Stability(value=Stable)
public void setDefaultConfig(@Nullable
                                                      CfnFunctionDefinitionVersion.DefaultConfigProperty value)

The default configuration that applies to all Lambda functions in the group.

Individual Lambda functions can override these settings.

setDefaultConfig

@Stability(value=Stable)
public void setDefaultConfig(@Nullable
                                                      IResolvable value)

The default configuration that applies to all Lambda functions in the group.

Individual Lambda functions can override these settings.