AWS Documentation » AWS IoT Greengrass » API Reference » Greengrass API » Definitions » Resource

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

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"
      }
    },
    "SageMakerMachineLearningModelResourceData": {
      "SageMakerJobArn": "string",
      "DestinationPath": "string"
    },
    "S3MachineLearningModelResourceData": {
      "S3Uri": "string",
      "DestinationPath": "string"
    },
    "SecretsManagerSecretResourceData": {
      "ARN": "string",
      "AdditionalStagingLabelsToDownload": [
        "string"
      ]
    }
  }
}

Resource

Information about a resource.

type: object

required: ["Id", "Name", "ResourceDataContainer"]

Id

The resource ID, used to refer to a resource in the Lambda function configuration. Maximum length is 128 characters with pattern [a‑zA‑Z0‑9:_‑]+. This must be unique within a Greengrass group.

type: string

Name

The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Maximum length is 128 characters with pattern [a‑zA‑Z0‑9:_‑]+. This must be unique within a Greengrass group.

type: string

ResourceDataContainer

A container for resource data. The container takes only one of the following supported resource data types: LocalDeviceResourceData, LocalVolumeResourceData, SageMakerMachineLearningModelResourceData, S3MachineLearningModelResourceData, SecretsManagerSecretResourceData.

type: object

NOTE: oneOf

LocalDeviceResourceData

Attributes that define a local device resource.

type: object

SourcePath

The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under /dev.

type: string

GroupOwnerSetting

Group owner related settings for local resources.

type: object

AutoAddGroupOwner

If true, AWS IoT 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

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 /sys.

type: string

DestinationPath

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

type: string

GroupOwnerSetting

Group owner related settings for local resources.

type: object

AutoAddGroupOwner

If true, AWS IoT 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

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

type: string

SageMakerMachineLearningModelResourceData

Attributes that define an Amazon SageMaker machine learning resource.

type: object

SageMakerJobArn

The ARN of the Amazon SageMaker training job that represents the source model.

type: string

DestinationPath

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

type: string

S3MachineLearningModelResourceData

Attributes that define an Amazon S3 machine learning resource.

type: object

S3Uri

The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format.

type: string

DestinationPath

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

type: string

SecretsManagerSecretResourceData

Attributes that define a secret resource, which references a secret from AWS Secrets Manager. AWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core, where it can be securely accessed by connectors and Lambda functions.

type: object

ARN

The ARN of the Secrets Manager secret to make available on the core. The value of the secret's latest version (represented by the AWSCURRENT staging label) is included by default.

type: string

AdditionalStagingLabelsToDownload

Optional. The staging labels whose values you want to make available on the core, in addition to AWSCURRENT.

type: array