Spec-Zone.ru › AWS CLI v2

[ aws . application-autoscaling ]

register-scalable-target

Описание

Регистрирует или обновляет целевой масштабируемый ресурс, который вы хотите масштабировать.

Целевые масштабируемые ресурсы уникально идентифицируются комбинацией идентификатора ресурса, размерности масштабирования и пространства имён, представляющего некую размерность ёмкости базовой службы.

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

Если вы добавите политику масштабирования, текущая ёмкость будет настраиваться в указанном диапазоне при запуске масштабирования. Политики масштабирования Application Auto Scaling не будут изменять ёмкость на значения, выходящие за пределы минимального и максимального диапазонов.

После регистрации целевого масштабируемого ресурса нет необходимости регистрировать его снова для использования других операций Application Auto Scaling. Чтобы увидеть, какие ресурсы были зарегистрированы, используйте DescribeScalableTargets. Вы также можете просмотреть политики масштабирования для пространства имён службы с помощью DescribeScalableTargets. Если целевой масштабируемый ресурс больше не нужен, вы можете его дезактивировать с помощью DeregisterScalableTarget.

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

Примечание

Если вы вызываете операцию API RegisterScalableTarget для создания целевого масштабируемого ресурса, может быть небольшая задержка, пока операция не достигнет конечной согласованности. Вы можете заметить эту небольшую задержку, если при выполнении последовательных операций получаете неожиданные ошибки. Типичная стратегия — повторно отправить запрос, и некоторые SDK Amazon Web Services включают автоматическую логику экспоненциального возврата и повторных попыток.

Если вы вызываете операцию API RegisterScalableTarget для обновления существующего целевого масштабируемого ресурса, Application Auto Scaling получает текущую ёмкость ресурса. Если она ниже минимальной ёмкости или выше максимальной ёмкости, Application Auto Scaling корректирует ёмкость целевого масштабируемого ресурса, чтобы поместить её в эти пределы, даже если вы не включили параметры запроса MinCapacity или MaxCapacity.

См. также: AWS API Documentation

Синопсис

  register-scalable-target
--service-namespace <value>
--resource-id <value>
--scalable-dimension <value>
[--min-capacity <value>]
[--max-capacity <value>]
[--role-arn <value>]
[--suspended-state <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]

Параметры

--service-namespace (строка)

Пространство имён службы Amazon Web Services, предоставляющей ресурс. Для ресурсов, предоставляемых собственным приложением или службой, используйте custom-resource.

Возможные значения:

  • ecs
  • elasticmapreduce
  • ec2
  • appstream
  • dynamodb
  • rds
  • sagemaker
  • custom-resource
  • comprehend
  • lambda
  • cassandra
  • kafka
  • elasticache
  • neptune
  • workspaces

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

Идентификатор ресурса, связанного со масштабируемой целью. Эта строка состоит из типа ресурса и уникального идентификатора.

  • Служба ECS — тип ресурса service, а уникальный идентификатор — имя кластера и имя службы. Пример: service/my-cluster/my-service .
  • Spot Fleet — тип ресурса spot-fleet-request, а уникальный идентификатор — ID запроса Spot Fleet. Пример: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .
  • Кластер EMR — тип ресурса instancegroup, а уникальный идентификатор — ID кластера и ID группы экземпляров. Пример: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .
  • Флот AppStream 2.0 — тип ресурса fleet, а уникальный идентификатор — имя флота. Пример: fleet/sample-fleet .
  • Таблица DynamoDB — тип ресурса table, а уникальный идентификатор — имя таблицы. Пример: table/my-table .
  • Глобальный вторичный индекс DynamoDB — тип ресурса index, а уникальный идентификатор — имя индекса. Пример: table/my-table/index/my-table-index .
  • Кластер Aurora DB — тип ресурса cluster, а уникальный идентификатор — имя кластера. Пример: cluster:my-db-cluster .
  • Вариант конечной точки SageMaker — тип ресурса variant, а уникальный идентификатор — ID ресурса. Пример: endpoint/my-end-point/variant/KMeansClustering .
  • Пользовательские ресурсы не поддерживаются с типом ресурса. Этот параметр должен указать OutputValue из шаблона CloudFormation используемого для доступа к ресурсам. Уникальный идентификатор определяется поставщиком службы. Дополнительную информацию можно найти в нашем репозитории GitHub.
  • Конечная точка классификации документов Amazon Comprehend — тип ресурса и уникальный идентификатор задаются с помощью ARN конечной точки. Пример: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .
  • Конечная точка распознавания сущностей Amazon Comprehend — тип ресурса и уникальный идентификатор задаются с помощью ARN конечной точки. Пример: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .
  • Зарезервированная вычислительная мощность Lambda — тип ресурса function, а уникальный идентификатор — имя функции с суффиксом версии функции или имени псевдонима, который не является $LATEST . Пример: function:my-function:prod или function:my-function:1 .
  • Таблица Amazon Keyspaces — тип ресурса table, а уникальный идентификатор — имя таблицы. Пример: keyspace/mykeyspace/table/mytable .
  • Кластер Amazon MSK — тип ресурса и уникальный идентификатор задаются с помощью ARN кластера. Пример: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .
  • Группа репликации Amazon ElastiCache — тип ресурса replication-group, а уникальный идентификатор — имя группы репликации. Пример: replication-group/mycluster .
  • Кластер кэширования Amazon ElastiCache — тип ресурса cache-cluster, а уникальный идентификатор — имя кластера кэширования. Пример: cache-cluster/mycluster .
  • Кластер Neptune — тип ресурса cluster, а уникальный идентификатор — имя кластера. Пример: cluster:mycluster .
  • Сервисless конечная точка SageMaker — тип ресурса variant, а уникальный идентификатор — ID ресурса. Пример: endpoint/my-end-point/variant/KMeansClustering .
  • Компонент вывода SageMaker — тип ресурса inference-component, а уникальный идентификатор — ID ресурса. Пример: inference-component/my-inference-component .
  • Пул WorkSpaces — тип ресурса workspacespool, а уникальный идентификатор — ID пула. Пример: workspacespool/wspool-123456 .

--scalable-dimension (строка)

Масштабируемая размерность, связанная с масштабируемой целью. Эта строка состоит из пространства имён службы, типа ресурса и свойства масштабирования.

  • ecs:service:DesiredCount — Количество задач службы ECS.
  • elasticmapreduce:instancegroup:InstanceCount — Количество экземпляров группы экземпляров EMR.
  • ec2:spot-fleet-request:TargetCapacity — Целевая ёмкость Spot Fleet.
  • appstream:fleet:DesiredCapacity — Ёмкость флота AppStream 2.0.
  • dynamodb:table:ReadCapacityUnits — Зарезервированная пропускная способность чтения для таблицы DynamoDB.
  • dynamodb:table:WriteCapacityUnits — Зарезервированная пропускная способность записи для таблицы DynamoDB.
  • dynamodb:index:ReadCapacityUnits — Зарезервированная пропускная способность чтения для глобального вторичного индекса DynamoDB.
  • dynamodb:index:WriteCapacityUnits — Зарезервированная пропускная способность записи для глобального вторичного индекса DynamoDB.
  • rds:cluster:ReadReplicaCount — Количество реплик Aurora в кластере Aurora DB. Доступно для совместимой с Aurora MySQL и Aurora PostgreSQL редакций.
  • sagemaker:variant:DesiredInstanceCount — Количество экземпляров EC2 для варианта конечной точки модели SageMaker.
  • custom-resource:ResourceType:Property — Масштабируемая размерность для пользовательского ресурса, предоставляемого собственным приложением или службой.
  • comprehend:document-classifier-endpoint:DesiredInferenceUnits — Количество вычислительных блоков для конечной точки классификации документов Amazon Comprehend.
  • comprehend:entity-recognizer-endpoint:DesiredInferenceUnits — Количество вычислительных блоков для конечной точки распознавания сущностей Amazon Comprehend.
  • lambda:function:ProvisionedConcurrency — Зарезервированная вычислительная мощность для функции Lambda.
  • cassandra:table:ReadCapacityUnits — Зарезервированная пропускная способность чтения для таблицы Amazon Keyspaces.
  • cassandra:table:WriteCapacityUnits — Зарезервированная пропускная способность записи для таблицы Amazon Keyspaces.
  • kafka:broker-storage:VolumeSize — Зарезервированный размер объёма (в ГБ) для брокеров в кластере Amazon MSK.
  • elasticache:cache-cluster:Nodes — Количество узлов для кластера кэширования Amazon ElastiCache.
  • elasticache:replication-group:NodeGroups — Количество групп узлов для группы репликации Amazon ElastiCache.
  • elasticache:replication-group:Replicas — Количество реплик на группу узлов для группы репликации Amazon ElastiCache.
  • neptune:cluster:ReadReplicaCount — Количество чтений реплик в кластере Amazon Neptune DB.
  • sagemaker:variant:DesiredProvisionedConcurrency — Зарезервированная вычислительная мощность для сервеless конечной точки SageMaker.
  • sagemaker:inference-component:DesiredCopyCount — Количество копий через конечную точку для компонента вывода SageMaker.
  • workspaces:workspacespool:DesiredUserSessions — Количество пользовательских сеансов для WorkSpaces в пуле.

Возможные значения:

  • ecs:service:DesiredCount
  • ec2:spot-fleet-request:TargetCapacity
  • elasticmapreduce:instancegroup:InstanceCount
  • appstream:fleet:DesiredCapacity
  • dynamodb:table:ReadCapacityUnits
  • dynamodb:table:WriteCapacityUnits
  • dynamodb:index:ReadCapacityUnits
  • dynamodb:index:WriteCapacityUnits
  • rds:cluster:ReadReplicaCount
  • sagemaker:variant:DesiredInstanceCount
  • custom-resource:ResourceType:Property
  • comprehend:document-classifier-endpoint:DesiredInferenceUnits
  • comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
  • lambda:function:ProvisionedConcurrency
  • cassandra:table:ReadCapacityUnits
  • cassandra:table:WriteCapacityUnits
  • kafka:broker-storage:VolumeSize
  • elasticache:cache-cluster:Nodes
  • elasticache:replication-group:NodeGroups
  • elasticache:replication-group:Replicas
  • neptune:cluster:ReadReplicaCount
  • sagemaker:variant:DesiredProvisionedConcurrency
  • sagemaker:inference-component:DesiredCopyCount
  • workspaces:workspacespool:DesiredUserSessions

--min-capacity (целое число)

Минимальное значение, к которому планируется масштабирование. При действии политики масштабирования Application Auto Scaling может уменьшать ёмкость (сокращать) по мере необходимости до минимального предела ёмкости в ответ на изменения спроса. Этот параметр обязателен при регистрации новой масштабируемой цели.

Для следующих ресурсов минимальное значение равно 0.

  • Флоты AppStream 2.0
  • Кластеры Aurora DB
  • Службы ECS
  • Кластеры EMR
  • Зарезервированная вычислительная мощность Lambda
  • Варианты конечных точек SageMaker
  • Компоненты вывода SageMaker
  • Зарезервированная вычислительная мощность сервеless конечной точки SageMaker
  • Spot Fleets
  • пользовательские ресурсы

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

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

--max-capacity (целое число)

Максимальное значение, до которого планируется масштабирование. При действии политики масштабирования Application Auto Scaling может увеличивать ёмкость (расширять) по мере необходимости до максимального предела ёмкости в ответ на изменения спроса. Этот параметр обязателен при регистрации новой масштабируемой цели.

Хотя можно указать большой максимальный объём, обратите внимание, что квоты службы могут наложить более низкие ограничения. Каждая служба имеет свои собственные значения по умолчанию для максимальной ёмкости ресурса. Если требуется указать более высокий предел, можно запросить увеличение. Для получения дополнительной информации см. документацию для этой службы. Сведения о значениях по умолчанию для каждой службы см. в разделе «Конечные точки служб и квоты» в справочнике Amazon Web Services.

--role-arn (строка)

Этот параметр требуется для служб, которые не поддерживают роли связанных со службой (например, Amazon EMR), и он должен указать ARN роли IAM, которая позволяет Application Auto Scaling изменять масштабируемую цель от вашего имени.

Если служба поддерживает роли, связанные со службой, Application Auto Scaling использует роль, связанную со службой, созданную, если она ещё не существует. Дополнительные сведения см. в разделе «Как Application Auto Scaling работает с IAM».

--suspended-state (структура)

Встроенный объект, содержащий атрибуты и значения атрибутов, используемые для приостановки и возобновления автоматического масштабирования. Установка значения атрибута в true приостанавливает указанные действия масштабирования. Установка значения в false (по умолчанию) возобновляет указанные действия масштабирования.

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

Дополнительную информацию см. в разделе «Приостановка и возобновление масштабирования» в руководстве пользователя Application Auto Scaling.

DynamicScalingInSuspended -> (boolean)

Приостанавливает ли масштабирование вниз политикой целевого отслеживания или политикой пошагового масштабирования. Установите значение в true, если вы не хотите, чтобы Application Auto Scaling удалял емкость при срабатывании политики масштабирования. По умолчанию значение равно false.

DynamicScalingOutSuspended -> (boolean)

Приостанавливает ли масштабирование вверх политикой целевого отслеживания или политикой пошагового масштабирования. Установите значение в true, если вы не хотите, чтобы Application Auto Scaling добавлял емкость при срабатывании политики масштабирования. По умолчанию значение равно false.

ScheduledScalingSuspended -> (boolean)

Приостановлено ли запланированное масштабирование. Установите значение в true, если вы не хотите, чтобы Application Auto Scaling добавлял или удалял емкость путем запуска запланированных операций. По умолчанию значение равно false.

Сокращенная запись:

DynamicScalingInSuspended=boolean,DynamicScalingOutSuspended=boolean,ScheduledScalingSuspended=boolean

Синтаксис JSON:

{
  "DynamicScalingInSuspended": true|false,
  "DynamicScalingOutSuspended": true|false,
  "ScheduledScalingSuspended": true|false
}

--tags (массив)

Назначает один или несколько тегов масштабируемой цели. Используйте этот параметр для добавления тегов к масштабируемой цели при ее создании. Для добавления тегов к существующей масштабируемой цели используйте операцию TagResource.

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

Используйте теги для управления доступом к масштабируемой цели. Дополнительную информацию см. в разделе «Поддержка тегов для Application Auto Scaling» в руководстве пользователя Application Auto Scaling.

key -> (строка)

value -> (строка)

Сокращенная запись:

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 (boolean)

Включить отладку.

--endpoint-url (строка)

Переопределить стандартный URL команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

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

--version (строка)

Показать версию этого инструмента.

--color (строка)

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

  • включено
  • выключено
  • автоматически

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--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 (boolean)

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

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве пользователя AWS CLI в разделе «Начало работы».

Если не указано иное, все примеры используют правила цитирования для Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Дополнительную информацию см. в руководстве пользователя AWS CLI в разделе «Использование кавычек со строками».

Пример 1: Регистрация сервиса ECS в качестве масштабируемой цели

Следующий пример регистрирует Amazon ECS-сервис в Application Auto Scaling. Он также добавляет тег с именем ключа environment и значением production к масштабируемой цели.

aws application-autoscaling register-scalable-target \
    --service-namespace ecs \
    --scalable-dimension ecs:service:DesiredCount \
    --resource-id service/default/web-app \
    --min-capacity 1 --max-capacity 10 \
    --tags environment=production

Вывод:

{
    "ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
}

Примеры для других AWS-сервисов и пользовательских ресурсов см. в разделах о поддерживаемых AWS-сервисах в руководстве пользователя Application Auto Scaling.

Пример 2: Приостановка действий масштабирования для масштабируемой цели

Следующий пример приостанавливает действия масштабирования для существующей масштабируемой цели.

aws application-autoscaling register-scalable-target \
    --service-namespace dynamodb \
    --scalable-dimension dynamodb:table:ReadCapacityUnits \
    --resource-id table/my-table \
    --suspended-state DynamicScalingInSuspended=true,DynamicScalingOutSuspended=true,ScheduledScalingSuspended=true

Вывод:

{
    "ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
}

Дополнительную информацию см. в разделе «Приостановка и возобновление масштабирования для Application Auto Scaling» в руководстве пользователя Application Auto Scaling.

Пример 3: Возобновление действий масштабирования для масштабируемой цели

Следующий пример возобновляет действия масштабирования для существующей масштабируемой цели.

aws application-autoscaling register-scalable-target \
    --service-namespace dynamodb \
    --scalable-dimension dynamodb:table:ReadCapacityUnits \
    --resource-id table/my-table \
    --suspended-state DynamicScalingInSuspended=false,DynamicScalingOutSuspended=false,ScheduledScalingSuspended=false

Вывод:

{
    "ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
}

Дополнительную информацию см. в разделе «Приостановка и возобновление масштабирования для Application Auto Scaling» в руководстве пользователя Application Auto Scaling.

Вывод

ScalableTargetARN -> (строка)

ARN масштабируемой цели.

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

Spec-Zone.ru

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