Spec-Zone.ru › AWS CLI v2

[ aws . appconfig ]

Обновление расширения

Описание

Обновляет расширение AppConfig. Дополнительную информацию о расширениях см. в разделе «Расширение рабочих процессов» в руководстве пользователя AppConfig.

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

Синтаксис

  update-extension
--extension-identifier <value>
[--description <value>]
[--actions <value>]
[--parameters <value>]
[--version-number <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]

Параметры

--extension-identifier (строка)

Имя, идентификатор или Amazon Resource Name (ARN) расширения.

--description (строка)

Информация о расширении.

--actions (массив)

Действия, определенные в расширении.

ключ -> (строка)

значение -> (список)

(структура)

Действие определяет задачи, выполняемые расширением во время рабочего процесса AppConfig. Каждое действие включает точку действия, как показано в следующем списке:

  • PRE_CREATE_HOSTED_CONFIGURATION_VERSION
  • PRE_START_DEPLOYMENT
  • AT_DEPLOYMENT_TICK
  • ON_DEPLOYMENT_START
  • ON_DEPLOYMENT_STEP
  • ON_DEPLOYMENT_BAKING
  • ON_DEPLOYMENT_COMPLETE
  • ON_DEPLOYMENT_ROLLED_BACK

Каждое действие также включает имя, URI функции Lambda и Amazon Resource Name (ARN) для роли доверенного лица управления доступом и безопасностью. Вы указываете имя, URI и ARN для каждой точки действия, определенной в расширении.

Имя -> (строка)

Имя действия.

Описание -> (строка)

Информация об действии.

Uri -> (строка)

URI расширения, связанный с точкой действия в определении расширения. URI может быть Amazon Resource Name (ARN) для одного из следующих: функция Lambda, очередь Amazon Simple Queue Service, тема Amazon Simple Notification Service или стандартная очередь Amazon EventBridge.

RoleArn -> (строка)

Amazon Resource Name (ARN) для роли доверенного лица управления доступом и безопасностью.

Краткая запись:

  KeyName1=[{Name=string,Description=string,Uri=string,RoleArn=string},{Name=string,Description=string,Uri=string,RoleArn=string}],KeyName2=[{Name=string,Description=string,Uri=string,RoleArn=string},{Name=string,Description=string,Uri=string,RoleArn=string}]

Where valid key names are:
  PRE_CREATE_HOSTED_CONFIGURATION_VERSION
  PRE_START_DEPLOYMENT
  AT_DEPLOYMENT_TICK
  ON_DEPLOYMENT_START
  ON_DEPLOYMENT_STEP
  ON_DEPLOYMENT_BAKING
  ON_DEPLOYMENT_COMPLETE
  ON_DEPLOYMENT_ROLLED_BACK

Синтаксис JSON:

{"PRE_CREATE_HOSTED_CONFIGURATION_VERSION"|"PRE_START_DEPLOYMENT"|"AT_DEPLOYMENT_TICK"|"ON_DEPLOYMENT_START"|"ON_DEPLOYMENT_STEP"|"ON_DEPLOYMENT_BAKING"|"ON_DEPLOYMENT_COMPLETE"|"ON_DEPLOYMENT_ROLLED_BACK": [
      {
        "Name": "string",
        "Description": "string",
        "Uri": "string",
        "RoleArn": "string"
      }
      ...
    ]
  ...}

--parameters (массив)

Один или несколько параметров для действий, вызываемых расширением.

ключ -> (строка)

значение -> (структура)

Значение, такое как Amazon Resource Name (ARN) или тема Amazon Simple Notification Service, введенные в расширение при вызове. Значения параметров указываются при ассоциации расширения. Дополнительную информацию о расширениях см. в разделе «Расширение рабочих процессов» в руководстве пользователя AppConfig.

Описание -> (строка)

Информация о параметре.

Обязательный -> (булево)

Значение параметра должно быть указано при ассоциации расширения.

Динамический -> (булево)

Указывает, можно ли предоставить значение этого параметра в точке действия расширения вместо ассоциации расширения. Динамические параметры не могут быть помечены Required.

Краткая запись:

KeyName1=Description=string,Required=boolean,Dynamic=boolean,KeyName2=Description=string,Required=boolean,Dynamic=boolean

Синтаксис JSON:

{"string": {
      "Description": "string",
      "Required": true|false,
      "Dynamic": true|false
    }
  ...}

--version-number (целое число)

Номер версии расширения.

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

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

Глобальные параметры

--debug (булево)

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

--endpoint-url (строка)

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

--no-verify-ssl (булево)

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

--no-paginate (булево)

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

--output (строка)

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

  • json
  • текст
  • таблица
  • yaml
  • поток yaml

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • включено
  • выключено
  • автоматически

--no-sign-request (булево)

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

--ca-bundle (строка)

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

--cli-read-timeout (целое число)

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

--cli-connect-timeout (целое число)

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

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (булево)

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

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве пользователя AWS CLI в разделе «Начало работы».

Если не указано иное, во всех примерах используются правила цитирования Unix-подобных систем. Эти примеры нужно будет адаптировать к правилам цитирования вашей терминальной программы. Смотрите раздел «Использование кавычек со строками» в руководстве пользователя AWS CLI.

Обновление расширения AWS AppConfig

В следующем примере добавляется дополнительный параметр Key к расширению в AWS AppConfig.

aws appconfig update-extension \
    --region us-west-2 \
    --extension-identifier S3-backup-extension \
    --parameters S3bucket={Required=true},CampaignID={Required=false}

Вывод:

{
    "Id": "1A2B3C4D",
    "Name": "S3-backup-extension",
    "VersionNumber": 1,
    "Arn": "arn:aws:appconfig:us-west-2:123456789012:extension/1A2B3C4D/1",
    "Actions": {
        "PRE_CREATE_HOSTED_CONFIGURATION_VERSION": [
            {
                "Name": "S3backup",
                "Uri": "arn:aws:lambda:us-west-2:123456789012:function:S3backupfunction",
                "RoleArn": "arn:aws:iam::123456789012:role/appconfigextensionrole"
            }
        ]
    },
    "Parameters": {
        "CampaignID": {
            "Required": false
        },
        "S3bucket": {
            "Required": true
        }
    }
}

Дополнительную информацию см. в разделе «Работа с расширениями AWS AppConfig» в руководстве пользователя AWS AppConfig.

Вывод

Id -> (строка)

Сгенерированный системой идентификатор расширения.

Name -> (строка)

Имя расширения.

VersionNumber -> (целое число)

Номер версии расширения.

Arn -> (строка)

Сгенерированный системой Amazon Resource Name (ARN) для расширения.

Description -> (строка)

Информация о расширении.

Actions -> (массив)

Действия, определенные в расширении.

ключ -> (строка)

значение -> (список)

(структура)

Действие определяет задачи, выполняемые расширением во время рабочего процесса AppConfig. Каждое действие включает точку действия, как показано в следующем списке:

  • PRE_CREATE_HOSTED_CONFIGURATION_VERSION
  • PRE_START_DEPLOYMENT
  • AT_DEPLOYMENT_TICK
  • ON_DEPLOYMENT_START
  • ON_DEPLOYMENT_STEP
  • ON_DEPLOYMENT_BAKING
  • ON_DEPLOYMENT_COMPLETE
  • ON_DEPLOYMENT_ROLLED_BACK

Каждое действие также включает имя, URI функции Lambda и Amazon Resource Name (ARN) для роли доверенного лица управления доступом и безопасностью. Вы указываете имя, URI и ARN для каждой точки действия, определенной в расширении.

Имя -> (строка)

Имя действия.

Описание -> (строка)

Информация об действии.

Uri -> (строка)

URI расширения, связанный с точкой действия в определении расширения. URI может быть Amazon Resource Name (ARN) для одного из следующих: функция Lambda, очередь Amazon Simple Queue Service, тема Amazon Simple Notification Service или стандартная очередь Amazon EventBridge.

RoleArn -> (строка)

Amazon Resource Name (ARN) для роли доверенного лица управления доступом и безопасностью.

Parameters -> (массив)

Параметры, принимаемые расширением. Вы указываете значения параметров, когда связываете расширение с ресурсом AppConfig, используя действие API CreateExtensionAssociation. Для действий расширения Lambda эти параметры включаются в объект запроса Lambda.

ключ -> (строка)

значение -> (структура)

Значение, такое как Amazon Resource Name (ARN) или тема Amazon Simple Notification Service, введенные в расширение при вызове. Значения параметров указываются при ассоциации расширения. Дополнительную информацию о расширениях см. в разделе «Расширение рабочих процессов» в руководстве пользователя AppConfig.

Описание -> (строка)

Информация о параметре.

Обязательный -> (булево)

Значение параметра должно быть указано при ассоциации расширения.

Динамический -> (булево)

Указывает, можно ли предоставить значение этого параметра в точке действия расширения вместо ассоциации расширения. Динамические параметры не могут быть помечены Required.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API