Menu
AWS Greengrass
API Reference

CreateCoreDefinition

Creates a core definition. You may optionally provide the initial version of the core definition or use CreateCoreDefinitionVersion at a later time. AWS Greengrass Groups must each contain exactly 1 AWS Greengrass Core.

URI: /greengrass/definition/cores

Operation: POST

Produces: application/json

Parameters:

  • CreateCoreDefinitionRequestBody

    Information needed to create a core definition.

    where used: body

    required: true

    schema:

    properties:

    • Name:

      The name of the core definition.

      type: string

    • InitialVersion:

      Information about the initial version of the core definition.

      CoreDefinitionVersion

      type: object

      Information about a core definition version.

      properties:

      • Cores

        A list of cores in the definition version.

        type: array

        items:
        Core

        type: object

        Information about a core.

        required: Id|ThingArn|CertificateArn

        properties:

        • Id:

          The id of the core.

          type: string

        • ThingArn:

          The thing arn of the core.

          type: string

        • CertificateArn:

          The arn of the certificate associated with the core.

          type: string

        • SyncShadow:

          If true, the core's local shadow state is automatically synced with the cloud.

          type: boolean

    Example:

    Copy
    { "Name": "string", "InitialVersion": { "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] } }
  • X-Amzn-Client-Token

    A client token used to correlate requests and responses.

    where used: header

    required: false

    type: string

Responses: