Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

создать-окно-технического-обслуживания

Описание

Создаёт новое окно технического обслуживания.

Примечание

Значение, которое вы указываете для Duration, определяет конкретное конечное время для окна технического обслуживания на основе времени его начала. Задачи окна технического обслуживания не могут начинаться после конечного времени, вычисленного как результат, минус количество часов, указанное для Cutoff. Например, если окно технического обслуживания начинается в 15:00, продолжительность составляет три часа, а значение, указанное для Cutoff, составляет один час, задачи окна технического обслуживания не могут начинаться после 17:00.

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

Синтаксис

  create-maintenance-window
--name <value>
[--description <value>]
[--start-date <value>]
[--end-date <value>]
--schedule <value>
[--schedule-timezone <value>]
[--schedule-offset <value>]
--duration <value>
--cutoff <value>
--allow-unassociated-targets | --no-allow-unassociated-targets
[--client-token <value>]
[--tags <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 (строка)

Необязательное описание окна технического обслуживания. Рекомендуется указывать описание для организации окон технического обслуживания.

--start-date (строка)

Дата и время, в формате ISO-8601 Extended, когда вы хотите, чтобы окно технического обслуживания стало активным. StartDate позволяет отложить активацию окна технического обслуживания до указанной будущей даты.

Примечание

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

--end-date (строка)

Дата и время, в формате ISO-8601 Extended, когда вы хотите, чтобы окно технического обслуживания стало неактивным. EndDate позволяет задать дату и время в будущем, когда окно технического обслуживания больше не будет выполняться.

--schedule (строка)

График окна технического обслуживания в формате выражения cron или rate.

--schedule-timezone (строка)

Временная зона, на основе которой выполняются запланированные действия окна технического обслуживания, в формате IANA. Например: “America/Los_Angeles”, “UTC” или “Asia/Seoul”. Дополнительную информацию можно найти в базе данных часовых поясов на веб-сайте IANA.

--schedule-offset (целое число)

Количество дней ожидания после даты и времени, указанных в выражении cron, перед запуском окна технического обслуживания.

Например, следующее выражение cron планирует запуск окна технического обслуживания в третье вторник каждого месяца в 23:30.

cron(30 23 ? * TUE#3 *)

Если смещение графика составляет 2, окно технического обслуживания не будет запущено до следующего дня.

--duration (целое число)

Продолжительность окна технического обслуживания в часах.

--cutoff (целое число)

Количество часов до окончания окна технического обслуживания, когда Amazon Web Services Systems Manager прекращает планирование новых задач для выполнения.

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

Включает выполнение задачи окна технического обслуживания на управляемых узлах, даже если вы не зарегистрировали эти узлы как целевые. При включенной настройке необходимо указать незарегистрированные управляемые узлы (по идентификатору узла) при регистрации задачи в окне технического обслуживания.

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

--client-token (строка)

Используемый токен идемпотентности, предоставленный пользователем.

--tags (список)

Необязательные метаданные, которые вы назначаете ресурсу. Теги позволяют категоризировать ресурс различными способами, например, по назначению, владельцу или среде. Например, вы можете пометить окно технического обслуживания, чтобы определить тип задач, которые оно будет запускать, типы целевых узлов и среду, в которой оно будет работать. В этом случае вы можете указать следующие пары ключ-значение:

  • Key=TaskType,Value=AgentUpdate
  • Key=OS,Value=Windows
  • Key=Environment,Value=Production

Примечание

Для добавления тегов к существующему окну технического обслуживания используйте операцию AddTagsToResource.

(структура)

Метаданные, которые вы назначаете своим ресурсам Amazon Web Services. Теги позволяют категоризировать ресурсы различными способами, например, по назначению, владельцу или среде. В Amazon Web Services Systems Manager вы можете применять теги к документам Systems Manager (SSM документы), управляемым узлам, окнам технического обслуживания, параметрам, шаблонам исправления, OpsItem и OpsMetadata.

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

Название тега.

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

Значение тега.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "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.

Пример 1: Создание окна технического обслуживания

Следующий create-maintenance-window пример создает новое окно технического обслуживания, которое выполняется каждые пять минут в течение максимум двух часов (по мере необходимости), предотвращает запуск новых задач в течение одного часа с момента окончания выполнения окна технического обслуживания, позволяет использовать незарегистрированные целевые узлы (инстансы, которые вы не зарегистрировали в окне технического обслуживания) и указывает с помощью пользовательских тегов, что создатель намеревается использовать его в учебном пособии.

aws ssm create-maintenance-window \
    --name "My-Tutorial-Maintenance-Window" \
    --schedule "rate(5 minutes)" \
    --duration 2 --cutoff 1 \
    --allow-unassociated-targets \
    --tags "Key=Purpose,Value=Tutorial"

Вывод:

{
    "WindowId": "mw-0c50858d01EXAMPLE"
}

Пример 2: Создание окна технического обслуживания, выполняемого только один раз

Следующий create-maintenance-window пример создает новое окно технического обслуживания, которое выполняется только один раз в указанную дату и время.

aws ssm create-maintenance-window \
    --name My-One-Time-Maintenance-Window \
    --schedule "at(2020-05-14T15:55:00)" \
    --duration 5 \
    --cutoff 2 \
    --allow-unassociated-targets \
    --tags "Key=Environment,Value=Production"

Вывод:

{
    "WindowId": "mw-01234567890abcdef"
}

Дополнительную информацию см. в разделе Окна технического обслуживания в Руководстве пользователя AWS Systems Manager.

Вывод

WindowId -> (строка)

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

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

Spec-Zone.ru

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