Spec-Zone.ru › AWS CLI v2

[ aws . appconfig ]

создать-расширение

Описание

Создает расширение AppConfig. Расширение дополняет возможности вставки логики или поведения в различные моменты рабочего процесса AppConfig при создании или развертывании конфигурации.

Вы можете создать собственные расширения или использовать расширения, разработанные Amazon Web Services, предоставляемые AppConfig. Для расширения AppConfig, использующего Lambda, необходимо создать функцию Lambda для выполнения любых вычислений и обработки, определённых в расширении. Если вы планируете создавать пользовательские версии расширений уведомлений, разработанных Amazon Web Services, вам нужно только указать Amazon Resource Name (ARN) в поле Uri для новой версии расширения.

  • Для пользовательского расширения уведомлений EventBridge введите ARN стандартных событий EventBridge в поле Uri.
  • Для пользовательского расширения уведомлений Amazon SNS введите ARN темы Amazon SNS в поле Uri.
  • Для пользовательского расширения уведомлений Amazon SQS введите ARN очереди сообщений Amazon SQS в поле Uri.

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

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

Синопсис

  create-extension
--name <value>
[--description <value>]
--actions <value>
[--parameters <value>]
[--tags <value>]
[--latest-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]

Параметры

--name (строка)

Название расширения. Каждое имя расширения в вашей учётной записи должно быть уникальным. Версии расширений используют одно и то же имя.

--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) для роли делегирования Identity and Access Management. Вы указываете имя, 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) для роли делегирования Identity and Access Management.

Краткий синтаксис:

  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 (карта)

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

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

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

Значение, такое как 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
    }
  ...}

--tags (карта)

Добавляет один или несколько тегов для указанного расширения. Теги — это метаданные, которые помогают классифицировать ресурсы по-разному, например, по назначению, владельцу или среде. Каждый тег состоит из ключа и необязательного значения, которые вы определяете.

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

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

Краткий синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--latest-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 (булево)

Отключить вывод страниц AWS CLI.

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

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

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

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

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Подробнее см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

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

Для создания расширения

Следующий create-extension пример создаёт новое расширение в AWS AppConfig.

aws appconfig create-extension \
    --region us-west-2 \
    --name S3-backup-extension \
    --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 S3bucket={Required=true}

Вывод:

{
    "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": {
        "S3bucket": {
            "Required": true
        }
    }
}

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

Вывод

Id -> (строка)

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

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

Название расширения.

Номер версии -> (целое число)

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

Arn -> (строка)

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

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

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

Действия -> (карта)

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

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

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

(структура)

Действие определяет задачи, выполняемые расширением во время рабочего процесса 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) для роли доверенного лица Identity and Access Management. Вы указываете имя, 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) для роли доверенного лица Identity and Access Management.

Параметры -> (карта)

Параметры, принимаемые расширением. Значения параметров указываются при ассоциации расширения с ресурсом 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