stop-deployment

Описание

Останавливает развертывание. Данное действие API работает только с развертываниями, статус которых DEPLOYING, если не указан параметр AllowRevert. Если параметр AllowRevert указан, статус активного развертывания будет изменён на ROLLED_BACK. Статус завершённого развертывания будет изменён на REVERTED. AppConfig допускает откат только в течение 72 часов после завершения развертывания.

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

Синтаксис

  stop-deployment
--application-id <value>
--environment-id <value>
--deployment-number <value>
[--allow-revert | --no-allow-revert]
[--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-number (целое число)

--allow-revert | --no-allow-revert (логическое значение)

--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
• table
• yaml
• yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

Отображение версии инструмента.

--color (строка)

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

• on
• off
• auto

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, отображающего двоичный блок, 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.

Примеры

Для остановки развертывания конфигурации

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

aws appconfig stop-deployment \
    --application-id 339ohji \
    --environment-id 54j1r29 \
    --deployment-number 2

Вывод:

{
    "DeploymentNumber": 0,
    "DeploymentDurationInMinutes": 0,
    "GrowthFactor": 0.0,
    "FinalBakeTimeInMinutes": 0,
    "PercentageComplete": 0.0
}

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

Вывод

ApplicationId -> (строка)

EnvironmentId -> (строка)

DeploymentStrategyId -> (строка)

ConfigurationProfileId -> (строка)

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

ConfigurationName -> (строка)

ConfigurationLocationUri -> (строка)

ConfigurationVersion -> (строка)

Description -> (строка)

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

GrowthType -> (строка)

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

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

State -> (строка)

EventLog -> (список)

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

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

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

AppliedExtensions -> (список)

KmsKeyArn -> (строка)

KmsKeyIdentifier -> (строка)

VersionLabel -> (строка)