Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

enable-add-on

Описание

Включает или изменяет дополнение для ресурса Amazon Lightsail. Дополнительная информация доступна в руководстве разработчика Amazon Lightsail .

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

Синтаксис

  enable-add-on
--resource-name <value>
--add-on-request <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]

Параметры

--resource-name (строка)

Имя исходного ресурса, для которого необходимо включить или изменить дополнение.

--add-on-request (структура)

Массив строк, представляющий дополнение для включения или изменения.

addOnType -> (строка)

Тип дополнения.

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

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

snapshotTimeOfDay -> (строка)

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

Ограничения:

  • Должно быть в формате HH:00 и с часовым интервалом.
  • Указано в координированном универсальном времени (UTC).
  • Моментальный снимок будет автоматически создан между указанным временем и в течение 45 минут после него.

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

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

Предупреждение

Этот объект применим только к ресурсам Lightsail for Research.

threshold -> (строка)

Значение для сравнения с продолжительностью.

duration -> (строка)

Длительность бездействия в минутах, после которой ваш виртуальный компьютер будет автоматически остановлен.

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

addOnType=string,autoSnapshotAddOnRequest={snapshotTimeOfDay=string},stopInstanceOnIdleRequest={threshold=string,duration=string}

Синтаксис JSON:

{
  "addOnType": "AutoSnapshot"|"StopInstanceOnIdle",
  "autoSnapshotAddOnRequest": {
    "snapshotTimeOfDay": "string"
  },
  "stopInstanceOnIdleRequest": {
    "threshold": "string",
    "duration": "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
  • текст
  • таблица
  • 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-auto-prompt (булево)

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

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

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

Вывод

operations -> (список)

Массив объектов, описывающих результат действия, такой как состояние запроса, отметка времени запроса и ресурсы, затронутые запросом.

(структура)

Описывает операцию API.

id -> (строка)

Идентификатор операции.

resourceName -> (строка)

Имя ресурса.

resourceType -> (строка)

Тип ресурса.

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

Отметка времени, когда операция была инициирована (1479816991.349).

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

Регион и зона доступности Amazon Web Services.

availabilityZone -> (строка)

Зона доступности. Следует формату us-east-2a (регистрозависимый).

regionName -> (строка)

Имя региона Amazon Web Services.

isTerminal -> (булево)

Булево значение, указывающее, является ли операция терминальной.

operationDetails -> (строка)

Подробности об операции (Debian-1GB-Ohio-1).

operationType -> (строка)

Тип операции.

status -> (строка)

Состояние операции.

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

Отметка времени, когда статус был изменён (1479816991.349).

errorCode -> (строка)

Код ошибки.

errorDetails -> (строка)

Подробности об ошибке.

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

Spec-Zone.ru

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