2.248.0

interface FunctionProperty

LanguageType name
.NETAmazon.CDK.CfnPropertyMixins.AWS.Greengrass.CfnFunctionDefinitionPropsMixin.FunctionProperty
Gogithub.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsgreengrass#CfnFunctionDefinitionPropsMixin_FunctionProperty
Javasoftware.amazon.awscdk.cfnpropertymixins.services.greengrass.CfnFunctionDefinitionPropsMixin.FunctionProperty
Pythonaws_cdk.cfn_property_mixins.aws_greengrass.CfnFunctionDefinitionPropsMixin.FunctionProperty
TypeScript @aws-cdk/cfn-property-mixins » aws_greengrass » CfnFunctionDefinitionPropsMixin » FunctionProperty

A function is a Lambda function that's referenced from an AWS IoT Greengrass group.

The function is deployed to a Greengrass core where it runs locally. For more information, see Run Lambda Functions on the AWS IoT Greengrass Core in the Developer Guide .

In an CloudFormation template, the Functions property of the FunctionDefinitionVersion property type contains a list of Function property types.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_greengrass as greengrass } from '@aws-cdk/cfn-property-mixins';

declare const variables: any;
const functionProperty: greengrass.CfnFunctionDefinitionPropsMixin.FunctionProperty = {
  functionArn: 'functionArn',
  functionConfiguration: {
    encodingType: 'encodingType',
    environment: {
      accessSysfs: false,
      execution: {
        isolationMode: 'isolationMode',
        runAs: {
          gid: 123,
          uid: 123,
        },
      },
      resourceAccessPolicies: [{
        permission: 'permission',
        resourceId: 'resourceId',
      }],
      variables: variables,
    },
    execArgs: 'execArgs',
    executable: 'executable',
    memorySize: 123,
    pinned: false,
    timeout: 123,
  },
  id: 'id',
};

Properties

NameTypeDescription
functionArn?stringThe Amazon Resource Name (ARN) of the alias (recommended) or version of the referenced Lambda function.
functionConfiguration?IResolvable | FunctionConfigurationPropertyThe group-specific settings of the Lambda function.
id?stringA descriptive or arbitrary ID for the function.

functionArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the alias (recommended) or version of the referenced Lambda function.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html#cfn-greengrass-functiondefinition-function-functionarn

functionConfiguration?

Type: IResolvable | FunctionConfigurationProperty (optional)

The group-specific settings of the Lambda function.

These settings configure the function's behavior in the Greengrass group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html#cfn-greengrass-functiondefinition-function-functionconfiguration

id?

Type: string (optional)

A descriptive or arbitrary ID for the function.

This value must be unique within the function definition version. Maximum length is 128 characters with pattern [a-zA-Z0-9:_-]+ .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html#cfn-greengrass-functiondefinition-function-id

← PreviousNext →