Spec-Zone.ru › AWS CLI v2

[ aws . appconfig ]

start-deployment

Описание

Запускает развертывание.

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

Синтаксис

  start-deployment
--application-id <value>
--environment-id <value>
--deployment-strategy-id <value>
--configuration-profile-id <value>
--configuration-version <value>
[--description <value>]
[--tags <value>]
[--kms-key-identifier <value>]
[--dynamic-extension-parameters <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]

Параметры

--application-id (строка)

Идентификатор приложения.

--environment-id (строка)

Идентификатор среды.

--deployment-strategy-id (строка)

Идентификатор стратегии развертывания.

--configuration-profile-id (строка)

Идентификатор профиля конфигурации.

--configuration-version (строка)

Версия конфигурации для развертывания. При развертывании размещенной конфигурации AppConfig вы можете указать либо номер версии, либо метку версии. Для всех остальных конфигураций необходимо указать номер версии.

--description (строка)

Описание развертывания.

--tags (карта)

Метаданные для назначения развертыванию. Теги помогают организовать и категоризировать ваши ресурсы AppConfig. Каждый тег состоит из ключа и необязательного значения, оба из которых вы определяете.

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

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

Краткая форма:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--kms-key-identifier (строка)

Идентификатор ключа KMS (идентификатор ключа, псевдоним ключа или ARN ключа). AppConfig использует этот идентификатор для шифрования данных конфигурации с помощью управляемого клиентом ключа.

--dynamic-extension-parameters (карта)

Карта имен параметров динамического расширения к значениям, передаваемым связанным расширениям с действиями PRE_START_DEPLOYMENT.

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

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

Краткая форма:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--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
  • text
  • таблица
  • 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.

Чтобы запустить развертывание конфигурации

Следующий start-deployment пример запускает развертывание для приложения, используя указанную среду, стратегию развертывания и профиль конфигурации.

aws appconfig start-deployment \
    --application-id 339ohji \
    --environment-id 54j1r29 \
    --deployment-strategy-id 1225qzk \
    --configuration-profile-id ur8hx2f \
    --configuration-version 1

Вывод:

{
    "ApplicationId": "339ohji",
    "EnvironmentId": "54j1r29",
    "DeploymentStrategyId": "1225qzk",
    "ConfigurationProfileId": "ur8hx2f",
    "DeploymentNumber": 1,
    "ConfigurationName": "Example-Configuration-Profile",
    "ConfigurationLocationUri": "ssm-parameter://Example-Parameter",
    "ConfigurationVersion": "1",
    "DeploymentDurationInMinutes": 15,
    "GrowthType": "LINEAR",
    "GrowthFactor": 25.0,
    "FinalBakeTimeInMinutes": 0,
    "State": "DEPLOYING",
    "EventLog": [
        {
            "EventType": "DEPLOYMENT_STARTED",
            "TriggeredBy": "USER",
            "Description": "Deployment started",
            "OccurredAt": "2021-09-17T21:43:54.205000+00:00"
        }
    ],
    "PercentageComplete": 0.0,
    "StartedAt": "2021-09-17T21:43:54.205000+00:00"
}

Для получения дополнительной информации см. Шаг 5: Развертывание конфигурации в руководстве пользователя AWS AppConfig.

Вывод

ApplicationId -> (строка)

Идентификатор приложения, которое было развернуто.

EnvironmentId -> (строка)

Идентификатор среды, которая была развернута.

DeploymentStrategyId -> (строка)

Идентификатор стратегии развертывания, которая была развернута.

ConfigurationProfileId -> (строка)

Идентификатор профиля конфигурации, который был развернут.

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

Порядковый номер развертывания.

ConfigurationName -> (строка)

Имя конфигурации.

ConfigurationLocationUri -> (строка)

Информация об исходном расположении конфигурации.

ConfigurationVersion -> (строка)

Версия конфигурации, которая была развернута.

Description -> (строка)

Описание развертывания.

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

Общее время выполнения развертывания.

GrowthType -> (строка)

Алгоритм, определяющий, как процентное соотношение росло со временем.

GrowthFactor -> (вещественное число)

Процент целевых объектов, которые получат развернутую конфигурацию в каждый интервал.

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

Время, в течение которого AppConfig отслеживал события для определения того, что развертывание завершено и больше не подлежит автоматическому откату.

State -> (строка)

Состояние развертывания.

EventLog -> (список)

Список всех событий, связанных с развертыванием. Самые последние события отображаются первыми.

(структура)

Объект, описывающий событие развертывания.

EventType -> (строка)

Тип события развертывания. Типы событий развертывания включают начало, остановку или завершение развертывания; обновление процента; начало или остановку периода выпечки; и начало или завершение отката.

TriggeredBy -> (строка)

Сущность, которая инициировала событие развертывания. События могут быть инициированы пользователем, AppConfig, сигналом Amazon CloudWatch или внутренней ошибкой.

Description -> (строка)

Описание события развертывания. Описания включают, но не ограничиваются следующими:

  • Учетная запись Amazon Web Services или ARN сигнала Amazon CloudWatch, которая инициировала откат.
  • Процент хостов, получивших развертывание.
  • Рекомендация попробовать новое развертывание (в случае внутренней ошибки).

ActionInvocations -> (список)

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

(структура)

Расширение, которое было вызвано в рамках события развертывания.

ExtensionIdentifier -> (строка)

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

ActionName -> (строка)

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

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.

ErrorMessage -> (строка)

Сообщение об ошибке при неудачном вызове расширения.

ErrorCode -> (строка)

Код ошибки при неудачном вызове расширения.

InvocationId -> (строка)

Сгенерированный системой ID для данного вызова.

OccurredAt -> (временная метка)

Дата и время события.

PercentageComplete -> (вещественное число)

Процент целевых объектов, для которых развертывание доступно.

StartedAt -> (временная метка)

Время начала развертывания.

CompletedAt -> (временная метка)

Время завершения развертывания.

AppliedExtensions -> (список)

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

(структура)

Расширение, которое было вызвано во время развертывания.

ExtensionId -> (строка)

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

ExtensionAssociationId -> (строка)

Сгенерированный системой ID для ассоциации.

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

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

Parameters -> (карта)

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

key -> (строка)

value -> (строка)

KmsKeyArn -> (строка)

Amazon Resource Name (ARN) ключа Key Management Service, используемого для шифрования данных конфигурации. Вы можете зашифровать секреты, хранящиеся в Secrets Manager, объекты Amazon Simple Storage Service (Amazon S3) зашифрованные с помощью SSE-KMS или параметры безопасных строк, хранящиеся в Amazon Web Services Systems Manager Parameter Store.

KmsKeyIdentifier -> (строка)

Идентификатор ключа Key Management Service (ID ключа, псевдоним ключа или ARN ключа), предоставленный при создании или обновлении ресурса.

VersionLabel -> (строка)

Определяемое пользователем метка версии размещенной в AppConfig конфигурации.

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

Spec-Zone.ru

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