create-component-version

Описание

Создаёт компонент. Компоненты — это программное обеспечение, выполняемое на устройствах ядра Greengrass. После разработки и тестирования компонента на устройстве ядра вы можете использовать эту операцию для загрузки своего компонента в IoT Greengrass. Затем вы можете развернуть компонент на других устройствах ядра.

Вы можете использовать эту операцию для выполнения следующих действий:

• Создание компонентов из рецептов Создайте компонент из рецепта, который представляет собой файл, определяющий метаданные, параметры, зависимости, жизненный цикл, артефакты и возможности платформы компонента. Дополнительную информацию см. в справке по рецептам компонентов IoT Greengrass в руководстве разработчика IoT Greengrass V2. Чтобы создать компонент из рецепта, укажите inlineRecipe при вызове этой операции.
• Создание компонентов из функций Lambda Создайте компонент из функции Lambda, выполняющейся на IoT Greengrass. Это создаёт рецепт и артефакты из пакета развертывания функции Lambda. Вы можете использовать эту операцию для миграции функций Lambda из IoT Greengrass V1 в IoT Greengrass V2. Эта функция принимает функции Lambda во всех поддерживаемых версиях Python, Node.js и Java. IoT Greengrass не применяет дополнительных ограничений на устаревшие версии среды выполнения Lambda. Чтобы создать компонент из функции Lambda, укажите lambdaFunction при вызове этой операции.

См. также: Документацию API AWS

Синтаксис

  create-component-version
[--inline-recipe <value>]
[--lambda-function <value>]
[--tags <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--inline-recipe (блок)

--lambda-function (структура)

Синтаксис JSON:

{
  "lambdaArn": "string",
  "componentName": "string",
  "componentVersion": "string",
  "componentPlatforms": [
    {
      "name": "string",
      "attributes": {"string": "string"
        ...}
    }
    ...
  ],
  "componentDependencies": {"string": {
        "versionRequirement": "string",
        "dependencyType": "HARD"|"SOFT"
      }
    ...},
  "componentLambdaParameters": {
    "eventSources": [
      {
        "topic": "string",
        "type": "PUB_SUB"|"IOT_CORE"
      }
      ...
    ],
    "maxQueueSize": integer,
    "maxInstancesCount": integer,
    "maxIdleTimeInSeconds": integer,
    "timeoutInSeconds": integer,
    "statusTimeoutInSeconds": integer,
    "pinned": true|false,
    "inputPayloadEncodingType": "json"|"binary",
    "execArgs": ["string", ...],
    "environmentVariables": {"string": "string"
      ...},
    "linuxProcessParams": {
      "isolationMode": "GreengrassContainer"|"NoContainer",
      "containerParams": {
        "memorySizeInKB": integer,
        "mountROSysfs": true|false,
        "volumes": [
          {
            "sourcePath": "string",
            "destinationPath": "string",
            "permission": "ro"|"rw",
            "addGroupOwner": true|false
          }
          ...
        ],
        "devices": [
          {
            "path": "string",
            "permission": "ro"|"rw",
            "addGroupOwner": true|false
          }
          ...
        ]
      }
    }
  }
}

--tags (массив)

Сокращенный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--client-token (строка)

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, поскольку строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение null или input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, будет выведен пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, проверяет входные данные команд и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Общие параметры

--debug (boolean)

Включить отладочную запись в журнал.

--endpoint-url (string)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

• on
• off
• auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (string)

Файл с сертификатами CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет рассматриваться как двоичное и будет использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Пример 1: Создание версии компонента из рецепта

Следующий create-component-version пример создает версию компонента «Hello World» из файла рецепта.

aws greengrassv2 create-component-version \
    --inline-recipe fileb://com.example.HelloWorld-1.0.0.json

Содержание com.example.HelloWorld-1.0.0.json:

{
    "RecipeFormatVersion": "2020-01-25",
    "ComponentName": "com.example.HelloWorld",
    "ComponentVersion": "1.0.0",
    "ComponentDescription": "My first AWS IoT Greengrass component.",
    "ComponentPublisher": "Amazon",
    "ComponentConfiguration": {
        "DefaultConfiguration": {
            "Message": "world"
        }
    },
    "Manifests": [
        {
            "Platform": {
                "os": "linux"
            },
            "Lifecycle": {
                "Run": "echo 'Hello {configuration:/Message}'"
            }
        }
    ]
}

Вывод:

{
    "arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0",
    "componentName": "com.example.HelloWorld",
    "componentVersion": "1.0.0",
    "creationTimestamp": "2021-01-07T16:24:33.650000-08:00",
    "status": {
        "componentState": "REQUESTED",
        "message": "NONE",
        "errors": {}
    }
}

Дополнительную информацию см. в разделах Создание пользовательских компонентов и Загрузка компонентов для развертывания в Руководстве разработчика AWS IoT Greengrass V2.

Пример 2: Создание версии компонента из функции AWS Lambda

Следующий create-component-version пример создает версию компонента «Hello World» из функции AWS Lambda.

aws greengrassv2 create-component-version \
    --cli-input-json file://lambda-function-component.json

Содержание lambda-function-component.json:

{
    "lambdaFunction": {
        "lambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:HelloWorldPythonLambda:1",
        "componentName": "com.example.HelloWorld",
        "componentVersion": "1.0.0",
        "componentLambdaParameters": {
            "eventSources": [
                {
                    "topic": "hello/world/+",
                    "type": "IOT_CORE"
                }
            ]
        }
    }
}

Вывод:

{
    "arn": "arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0",
    "componentName": "com.example.HelloWorld",
    "componentVersion": "1.0.0",
    "creationTimestamp": "2021-01-07T17:05:27.347000-08:00",
    "status": {
        "componentState": "REQUESTED",
        "message": "NONE",
        "errors": {}
    }
}

Дополнительную информацию см. в разделе Выполнение функций AWS Lambda в Руководстве разработчика AWS IoT Greengrass V2.

Вывод

arn -> (строка)

componentName -> (строка)

componentVersion -> (строка)

creationTimestamp -> (метка времени)

status -> (структура)