Menu
AWS Greengrass
API Reference

Resource

{ "Id": "string", "Name": "string", "ResourceDataContainer": { "*-- NOTE:": "choose one of the following --*", "LocalDeviceResourceData": { "SourcePath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } }, "LocalVolumeResourceData": { "SourcePath": "string", "DestinationPath": "string", "GroupOwnerSetting": { "AutoAddGroupOwner": true, "GroupOwner": "string" } } } }
Resource

Information about a resource.

type: object

required: ["Id", "ResourceDataContainer"]

Id

The resource ID, used to refer to a resource in the Lambda function configuration. Max length is 128 characters with pattern [a‑zA‑Z0‑9:_‑]+.

type: string

Name

A descriptive resource name which will be displayed on the AWS Greengrass console. Max length 128 characters with pattern [a‑zA‑Z0‑9:_‑]+.

type: string

ResourceDataContainer

Should contain one of LocalDeviceResourceData or LocalVolumeResourceData.

type: object

NOTE: oneOf

LocalDeviceResourceData

Attributes that define a local device resource.

type: object

SourcePath

The local source path of the resource.

type: string

GroupOwnerSetting

Group owner related settings for local resources.

type: object

AutoAddGroupOwner

If true, AWS Greengrass automatically adds the specified Linux OS group owner of the resource to the Lambda process privileges. Thus the Lambda process will have the file access permissions of the added Linux group.

type: boolean

GroupOwner

Specifies the name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.

type: string

LocalVolumeResourceData

Attributes that define a Local Volume Resource.

type: object

SourcePath

The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with /proc or /sys</code.

type: string

DestinationPath

The absolute path of the volume resource inside the Lambda environment.

type: string

GroupOwnerSetting

Group owner related settings for local resources.

type: object

AutoAddGroupOwner

If true, AWS Greengrass automatically adds the specified Linux OS group owner of the resource to the Lambda process privileges. Thus the Lambda process will have the file access permissions of the added Linux group.

type: boolean

GroupOwner

Specifies the name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.

type: string