interface CfnComponentVersionProps

Language	Type name
.NET	Amazon.CDK.AWS.GreengrassV2.CfnComponentVersionProps
Java	software.amazon.awscdk.services.greengrassv2.CfnComponentVersionProps
Python	aws_cdk.aws_greengrassv2.CfnComponentVersionProps
TypeScript	@aws-cdk/aws-greengrassv2 » CfnComponentVersionProps

Properties for defining a CfnComponentVersion.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as greengrassv2 from '@aws-cdk/aws-greengrassv2';
const cfnComponentVersionProps: greengrassv2.CfnComponentVersionProps = {
  inlineRecipe: 'inlineRecipe',
  lambdaFunction: {
    componentDependencies: {
      componentDependenciesKey: {
        dependencyType: 'dependencyType',
        versionRequirement: 'versionRequirement',
      },
    },
    componentLambdaParameters: {
      environmentVariables: {
        environmentVariablesKey: 'environmentVariables',
      },
      eventSources: [{
        topic: 'topic',
        type: 'type',
      }],
      execArgs: ['execArgs'],
      inputPayloadEncodingType: 'inputPayloadEncodingType',
      linuxProcessParams: {
        containerParams: {
          devices: [{
            addGroupOwner: false,
            path: 'path',
            permission: 'permission',
          }],
          memorySizeInKb: 123,
          mountRoSysfs: false,
          volumes: [{
            addGroupOwner: false,
            destinationPath: 'destinationPath',
            permission: 'permission',
            sourcePath: 'sourcePath',
          }],
        },
        isolationMode: 'isolationMode',
      },
      maxIdleTimeInSeconds: 123,
      maxInstancesCount: 123,
      maxQueueSize: 123,
      pinned: false,
      statusTimeoutInSeconds: 123,
      timeoutInSeconds: 123,
    },
    componentName: 'componentName',
    componentPlatforms: [{
      attributes: {
        attributesKey: 'attributes',
      },
      name: 'name',
    }],
    componentVersion: 'componentVersion',
    lambdaArn: 'lambdaArn',
  },
  tags: {
    tagsKey: 'tags',
  },
};

Properties

Name	Type	Description
inlineRecipe?	string	The recipe to use to create the component.
lambdaFunction?	LambdaFunctionRecipeSourceProperty | IResolvable	The parameters to create a component from a Lambda function.
tags?	{ [string]: string }	Application-specific metadata to attach to the component version.

---

inlineRecipe?

Type: string (optional)

The recipe to use to create the component.

The recipe defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform compatibility.

You must specify either InlineRecipe or LambdaFunction .

---

lambdaFunction?

Type: LambdaFunctionRecipeSourceProperty | IResolvable (optional)

The parameters to create a component from a Lambda function.

You must specify either InlineRecipe or LambdaFunction .

---

tags?

Type: { [string]: string } (optional)

Application-specific metadata to attach to the component version.

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 Tag your AWS IoT Greengrass Version 2 resources in the AWS IoT Greengrass V2 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"
}