Spec-Zone.ru › AWS CLI v2

[ aws . emr ]

put-auto-scaling-policy

Описание

Создаёт или обновляет политику автоматического масштабирования для группы базовых экземпляров или группы экземпляров задач в кластере Amazon EMR. Политика автоматического масштабирования определяет, как группа экземпляров динамически добавляет и удаляет экземпляры Amazon EC2 в ответ на значение метрики CloudWatch.

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

Синтаксис

  put-auto-scaling-policy
--cluster-id <value>
--instance-group-id <value>
--auto-scaling-policy <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]

Параметры

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

Указывает идентификатор кластера. Группа экземпляров, к которой применяется политика автоматического масштабирования, находится внутри этого кластера.

--instance-group-id (строка)

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

--auto-scaling-policy (структура)

Указывает определение политики автоматического масштабирования.

Ограничения -> (структура)

Верхние и нижние пределы экземпляров Amazon EC2 для политики автоматического масштабирования. Действия автоматического масштабирования не позволят группе экземпляров увеличиться или уменьшиться сверх этих пределов.

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

Нижняя граница экземпляров Amazon EC2 в группе экземпляров, ниже которой действия масштабирования не допускают уменьшения. Действия по уменьшению масштаба не будут завершать экземпляры ниже этой границы.

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

Верхняя граница экземпляров Amazon EC2 в группе экземпляров, сверх которой действия масштабирования не допускают увеличения. Действия по увеличению масштаба не добавят экземпляры сверх этой границы.

Rules -> (список)

Правила масштабирования, входящие в состав политики автоматического масштабирования.

(структура)

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

Name -> (строка)

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

Description -> (строка)

Дружественное, более подробное описание правила автоматического масштабирования.

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

Условия, которые инициируют действие автоматического масштабирования.

Market -> (строка)

Не доступно для групп экземпляров. Группы экземпляров используют тип рынка, указанный для группы.

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

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

AdjustmentType -> (строка)

Способ, которым добавляются экземпляры Amazon EC2 (если ScalingAdjustment является положительным числом) или удаляются (если ScalingAdjustment является отрицательным числом) каждый раз, когда запускается действие масштабирования. CHANGE_IN_CAPACITY — это значение по умолчанию. CHANGE_IN_CAPACITY указывает, что количество экземпляров Amazon EC2 увеличивается или уменьшается на ScalingAdjustment, которое должно быть выражено как целое число. PERCENT_CHANGE_IN_CAPACITY указывает, что количество экземпляров увеличивается или уменьшается на процент, указанный ScalingAdjustment, который должен быть выражен как целое число. Например, 20 указывает увеличение на 20% от емкости кластера. EXACT_CAPACITY указывает, что действие масштабирования приводит к группе экземпляров с количеством экземпляров Amazon EC2, указанным в ScalingAdjustment, которое должно быть выражено как положительное целое число.

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

Количество масштабирования, увеличивающего или уменьшающего группу, на основе указанного AdjustmentType. Положительное значение добавляет в группу экземпляров количество экземпляров Amazon EC2, а отрицательное — удаляет. Если AdjustmentType установлено в EXACT_CAPACITY, число должно быть только положительным целым числом. Если AdjustmentType установлено в PERCENT_CHANGE_IN_CAPACITY, значение должно выражать процент как целое число. Например, -20 указывает уменьшение на 20% от емкости кластера.

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

Время, в секундах, после завершения действия масштабирования, прежде чем любые дальнейшие действия масштабирования, связанные со срабатыванием, могут начаться. Значение по умолчанию — 0.

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

Определение сигнала тревоги CloudWatch, которое определяет, когда запускается действие автоматического масштабирования.

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

Определение сигнала тревоги метрики CloudWatch. Когда определенные условия сигнала тревоги выполняются вместе с другими параметрами срабатывания, начинается действие масштабирования.

ComparisonOperator -> (строка)

Определяет, как метрика, указанная MetricName, сравнивается со значением, указанным Threshold.

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

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

MetricName -> (строка)

Название метрики CloudWatch, за которой ведется наблюдение для определения условия срабатывания сигнала тревоги.

Namespace -> (строка)

Пространство имен для метрики CloudWatch. По умолчанию — AWS/ElasticMapReduce.

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

Период, в секундах, за который применяется статистика. Метрики CloudWatch для Amazon EMR передаются каждые пять минут (300 секунд), поэтому если вы указываете метрику CloudWatch, укажите 300.

Statistic -> (строка)

Статистика, применяемая к метрике, связанной с сигналом тревоги. По умолчанию — AVERAGE.

Threshold -> (двойное число)

Значение, с которым сравнивается указанная статистика.

Unit -> (строка)

Единица измерения, связанная с метрикой CloudWatch, за которой ведется наблюдение. Указанное значение для Unit должно соответствовать единицам, указанным в метрике CloudWatch.

Dimensions -> (список)

Измерение метрики CloudWatch.

(структура)

Измерение CloudWatch, которое указывается с использованием Key (известное как Name в CloudWatch), Value пары. По умолчанию Amazon EMR использует одно измерение, у которого Key — это JobFlowID, а Value — переменная, представляющая идентификатор кластера, который является ${emr.clusterId}. Это позволяет правилу запуститься, когда идентификатор кластера становится доступным.

Key -> (строка)

Имя измерения.

Value -> (строка)

Значение измерения.

Синтаксис JSON:

{
  "Constraints": {
    "MinCapacity": integer,
    "MaxCapacity": integer
  },
  "Rules": [
    {
      "Name": "string",
      "Description": "string",
      "Action": {
        "Market": "ON_DEMAND"|"SPOT",
        "SimpleScalingPolicyConfiguration": {
          "AdjustmentType": "CHANGE_IN_CAPACITY"|"PERCENT_CHANGE_IN_CAPACITY"|"EXACT_CAPACITY",
          "ScalingAdjustment": integer,
          "CoolDown": integer
        }
      },
      "Trigger": {
        "CloudWatchAlarmDefinition": {
          "ComparisonOperator": "GREATER_THAN_OR_EQUAL"|"GREATER_THAN"|"LESS_THAN"|"LESS_THAN_OR_EQUAL",
          "EvaluationPeriods": integer,
          "MetricName": "string",
          "Namespace": "string",
          "Period": integer,
          "Statistic": "SAMPLE_COUNT"|"AVERAGE"|"SUM"|"MINIMUM"|"MAXIMUM",
          "Threshold": double,
          "Unit": "NONE"|"SECONDS"|"MICRO_SECONDS"|"MILLI_SECONDS"|"BYTES"|"KILO_BYTES"|"MEGA_BYTES"|"GIGA_BYTES"|"TERA_BYTES"|"BITS"|"KILO_BITS"|"MEGA_BITS"|"GIGA_BITS"|"TERA_BITS"|"PERCENT"|"COUNT"|"BYTES_PER_SECOND"|"KILO_BYTES_PER_SECOND"|"MEGA_BYTES_PER_SECOND"|"GIGA_BYTES_PER_SECOND"|"TERA_BYTES_PER_SECOND"|"BITS_PER_SECOND"|"KILO_BITS_PER_SECOND"|"MEGA_BITS_PER_SECOND"|"GIGA_BITS_PER_SECOND"|"TERA_BITS_PER_SECOND"|"COUNT_PER_SECOND",
          "Dimensions": [
            {
              "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
  • текст
  • таблица
  • 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-в-base64-вывод

--no-cli-pager (булево)

Отключить вывод пагинатора CLI.

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

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

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

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

Вывод

ClusterId -> (строка)

Указывает идентификатор кластера. Группа экземпляров, к которой применяется политика автоматического масштабирования, находится в этом кластере.

InstanceGroupId -> (строка)

Указывает идентификатор группы экземпляров, к которой применяется политика масштабирования.

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

Определение политики автоматического масштабирования.

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

Статус политики автоматического масштабирования.

State -> (строка)

Указывает состояние политики автоматического масштабирования.

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

Причина изменения статуса.

Code -> (строка)

Код, указывающий причину изменения состояния. ``USER_REQUEST`` указывает, что состояние политики масштабирования было изменено пользователем. PROVISION_FAILURE указывает, что изменение статуса произошло из-за того, что политика не смогла выполнить выделение. CLEANUP_FAILURE указывает на ошибку.

Message -> (строка)

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

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

Верхние и нижние пределы количества экземпляров Amazon EC2 для политики автоматического масштабирования. Действия автоматического масштабирования не позволят группе экземпляров увеличиться или уменьшиться выше или ниже этих пределов.

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

Нижняя граница количества экземпляров Amazon EC2 в группе экземпляров, ниже которой действия масштабирования не допускают уменьшения. Действия уменьшения масштаба не завершат экземпляры ниже этого предела.

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

Верхняя граница количества экземпляров Amazon EC2 в группе экземпляров, выше которой действия масштабирования не допускают увеличения. Действия увеличения масштаба не добавят экземпляры за пределами этой границы.

Rules -> (список)

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

(структура)

Правило увеличения или уменьшения масштаба, определяющее действия по масштабированию, включая задачу оповещения CloudWatch, как добавляются или удаляются экземпляры Amazon EC2 и периодичность корректировок. Политика автоматического масштабирования для группы экземпляров может включать одно или несколько правил автоматического масштабирования.

Name -> (строка)

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

Description -> (строка)

Дружественное, более подробное описание правила автоматического масштабирования.

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

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

Market -> (строка)

Недоступно для групп экземпляров. Группы экземпляров используют тип рынка, указанный для группы.

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

Тип корректировки, которую действия автоматического масштабирования производят при запуске, и периодичность этой корректировки.

AdjustmentType -> (строка)

Способ, которым добавляются (если ScalingAdjustment является положительным числом) или удаляются (если ScalingAdjustment является отрицательным числом) экземпляры Amazon EC2 каждый раз, когда запускается действие масштабирования. CHANGE_IN_CAPACITY является значением по умолчанию. CHANGE_IN_CAPACITY указывает, что количество экземпляров Amazon EC2 увеличивается или уменьшается на ScalingAdjustment, которое должно быть представлено как целое число. PERCENT_CHANGE_IN_CAPACITY указывает, что количество экземпляров увеличивается или уменьшается на процент, указанный в ScalingAdjustment, которое должно быть представлено как целое число. Например, 20 указывает увеличение на 20% от емкости кластера. EXACT_CAPACITY указывает, что действие масштабирования приводит к группе экземпляров с количеством экземпляров Amazon EC2, указанным в ScalingAdjustment, которое должно быть представлено как положительное целое число.

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

Величина увеличения или уменьшения масштаба на основе указанного AdjustmentType. Положительное значение добавляет к количеству экземпляров Amazon EC2 в группе экземпляров, а отрицательное удаляет экземпляры. Если AdjustmentType установлено в EXACT_CAPACITY, число должно быть только положительным целым. Если AdjustmentType установлено в PERCENT_CHANGE_IN_CAPACITY, значение должно выражать процент в виде целого числа. Например, -20 указывает уменьшение на 20% от емкости кластера.

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

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

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

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

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

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

ComparisonOperator -> (строка)

Определяет, как метрика, указанная в MetricName, сравнивается со значением, указанным в Threshold.

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

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

MetricName -> (строка)

Имя метрики CloudWatch, которая отслеживается для определения условия оповещения.

Namespace -> (строка)

Пространство имен метрики CloudWatch. Значение по умолчанию равно AWS/ElasticMapReduce.

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

Период в секундах, в течение которого применяется статистика. Метрики CloudWatch для Amazon EMR отправляются каждые 5 минут (300 секунд), поэтому, если вы указываете метрику CloudWatch, укажите 300.

Statistic -> (строка)

Статистика, применяемая к метрике, связанной с оповещением. Значение по умолчанию равно AVERAGE.

Threshold -> (двойное значение)

Значение, с которым сравнивается указанная статистика.

Unit -> (строка)

Единица измерения, связанная с метрикой CloudWatch, за которой наблюдают. Указанное для Unit значение должно соответствовать единицам измерения, указанным в метрике CloudWatch.

Dimensions -> (список)

Измерение метрики CloudWatch.

(структура)

Измерение CloudWatch, которое задается с использованием Key (известного как Name в CloudWatch), Value пары. По умолчанию Amazon EMR использует одно измерение, у которого Key равно JobFlowID, а Value — переменная, представляющая идентификатор кластера, который является ${emr.clusterId}. Это позволяет правилу выполнять загрузку, когда идентификатор кластера станет доступен.

Key -> (строка)

Имя измерения.

Value -> (строка)

Значение измерения.

ClusterArn -> (строка)

Amazon Resource Name (ARN) кластера.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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