Package software.amazon.awscdk.services.greengrass

Class CfnFunctionDefinition

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.CfnFunctionDefinition
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.96.0 (build 921e240)", date="2024-04-10T22:22:28.702Z") @Stability(Stable) public class CfnFunctionDefinition extends CfnResource implements IInspectable, ITaggable
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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFunctionDefinition

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

    • CfnFunctionDefinition

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

    • CfnFunctionDefinition

      @Stability(Stable) public CfnFunctionDefinition(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnFunctionDefinitionProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public 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

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the FunctionDefinition , such as 1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .

    • getAttrLatestVersionArn

      @Stability(Stable) @NotNull public 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

      @Stability(Stable) @NotNull public String getAttrName()
      The name of the FunctionDefinition , such as MyFunctionDefinition .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the function definition.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the function definition.

    • getInitialVersion

      @Stability(Stable) @Nullable public Object getInitialVersion()
      The function definition version to include when the function definition is created.

    • setInitialVersion

      @Stability(Stable) public void setInitialVersion(@Nullable IResolvable value)
      The function definition version to include when the function definition is created.

    • setInitialVersion

      @Stability(Stable) public void setInitialVersion(@Nullable CfnFunctionDefinition.FunctionDefinitionVersionProperty value)
      The function definition version to include when the function definition is created.

    • getTagsRaw

      @Stability(Stable) @Nullable public Object getTagsRaw()
      Application-specific metadata to attach to the function definition.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Object value)
      Application-specific metadata to attach to the function definition.