update-cluster-settings

Описание

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

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

Синтаксис

  update-cluster-settings
--cluster <value>
--settings <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 (строка)

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

--settings (список)

Параметр, который используется по умолчанию для кластера. Этот параметр используется для включения CloudWatch Container Insights для кластера. Если это значение указано, оно переопределяет значение containerInsights, заданное с помощью PutAccountSetting или PutAccountSettingDefault.

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

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

(структура)

Параметры, используемые при создании кластера. Этот параметр используется для включения CloudWatch Container Insights с расширенной наблюдаемостью или CloudWatch Container Insights для кластера.

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

Для получения дополнительной информации см. Наблюдение за контейнерами Amazon ECS с помощью Container Insights с расширенной наблюдаемостью в Руководстве разработчика Amazon Elastic Container Service.

name -> (строка)

Имя параметра настройки кластера. Значение равно containerInsights.

value -> (строка)

Значение, устанавливаемое для параметра настройки кластера. Доступные значения - enhanced , enabled и disabled.

Для использования Container Insights с расширенной наблюдаемостью установите параметр настройки учетной записи containerInsights в значение enhanced.

Для использования Container Insights установите параметр настройки учетной записи containerInsights в значение enabled.

Если значение параметра кластера указано, оно переопределит значение containerInsights, установленное с помощью PutAccountSetting или PutAccountSettingDefault.

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

name=string,value=string ...

Синтаксис JSON:

[
  {
    "name": "containerInsights",
    "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-in-base64-out

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

Отключить пейджер CLI для вывода.

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

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

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

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

Примеры

Примечание

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

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

Для изменения параметров вашего кластера

Следующий пример update-cluster-settings включает CloudWatch Container Insights с расширенной наблюдаемостью для кластера MyCluster.

aws ecs update-cluster-settings \
    --cluster MyCluster \
    --settings name=containerInsights,value=enhanced

Вывод:

{
    "cluster": {
        "clusterArn": "arn:aws:ecs:us-esat-1:123456789012:cluster/MyCluster",
        "clusterName": "default",
        "status": "ACTIVE",
        "registeredContainerInstancesCount": 0,
        "runningTasksCount": 0,
        "pendingTasksCount": 0,
        "activeServicesCount": 0,
        "statistics": [],
        "tags": [],
        "settings": [
            {
                "name": "containerInsights",
                "value": "enhanced"
            }
        ]
    }
}

Дополнительную информацию см. в разделе Изменение параметров учетной записи в Руководстве разработчика Amazon ECS.

Вывод

кластер -> (структура)

Подробная информация о кластере

clusterArn -> (строка)

Amazon Resource Name (ARN), идентифицирующий кластер. Дополнительная информация о формате ARN представлена в разделе Amazon Resource Name (ARN) в руководстве для разработчиков Amazon ECS.

clusterName -> (строка)

Строка, введенная пользователем, используемая для идентификации кластера.

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

Конфигурация команды выполнения и управляемого хранилища для кластера.

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

Подробная информация о конфигурации команды выполнения.

kmsKeyId -> (строка)

Укажите идентификатор ключа Key Management Service для шифрования данных между локальным клиентом и контейнером.

logging -> (строка)

Настройки ведения журнала для перенаправления журналов результатов команды выполнения. Доступны следующие настройки ведения журнала:

NONE : Сессия команды выполнения не регистрируется.
DEFAULT : Используется конфигурация awslogs в определении задачи. Если параметр logging не указан, используется это значение по умолчанию. Если драйвер ведения журнала awslogs не настроен в определении задачи, вывод не будет записан в журнал.
OVERRIDE : Укажите детали ведения журнала как часть logConfiguration. Если указан параметр OVERRIDE ведения журнала, необходимо указать logConfiguration.

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

Конфигурация ведения журнала результатов действий команды выполнения. Журналы могут быть отправлены в CloudWatch Logs или в Amazon S3-ведро. Когда указано logging=OVERRIDE, необходимо указать logConfiguration.

cloudWatchLogGroupName -> (строка)

Имя группы журналов CloudWatch для отправки журналов.

Примечание

Группа журналов CloudWatch должна быть создана заранее.

cloudWatchEncryptionEnabled -> (булево)

Определяет, следует ли использовать шифрование для журналов CloudWatch. Если не указано, шифрование выключено.

s3BucketName -> (строка)

Имя S3-ведpa для отправки журналов.

Примечание

S3-ведро должно быть создано заранее.

s3EncryptionEnabled -> (булево)

Определяет, следует ли использовать шифрование для журналов S3. Если не указано, шифрование не используется.

s3KeyPrefix -> (строка)

Необязательная папка в S3-ведре для размещения журналов.

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

Подробная информация о конфигурации управляемого хранилища.

kmsKeyId -> (строка)

Укажите идентификатор ключа Key Management Service для шифрования управляемого Amazon ECS хранилища.

При указании kmsKeyId, Amazon ECS использует ключ для шифрования томов управляемого хранилища Amazon ECS, подключенных к задачам в кластере. Следующие тома хранилища управляются Amazon ECS: Amazon EBS. Дополнительная информация о шифровании томов Amazon EBS, подключенных к задачам Amazon ECS, содержится в руководстве по Amazon Elastic Container Service.

Ключ должен быть ключом одного региона.

fargateEphemeralStorageKmsKeyId -> (строка)

Укажите идентификатор ключа Key Management Service для временного хранилища Fargate.

При указании fargateEphemeralStorageKmsKeyId, Fargate использует ключ для шифрования данных во временном хранилище. Дополнительную информацию о шифровании временного хранилища Fargate см. в руководстве по Amazon Elastic Container Service.

Ключ должен быть ключом одного региона.

status -> (строка)

Статус кластера. Возможные состояния:

ACTIVE

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

PROVISIONING

Кластер ассоциирован с поставщиками ресурсов, и ресурсы для поставщика ресурсов создаются.

DEPROVISIONING

Кластер ассоциирован с поставщиками ресурсов, и ресурсы для поставщика ресурсов удаляются.

FAILED

Кластер ассоциирован с поставщиками ресурсов, но ресурсы для поставщика ресурсов не были созданы.

INACTIVE

Кластер удален. Кластеры со статусом INACTIVE могут оставаться доступными в вашей учетной записи в течение некоторого времени. Однако это поведение может измениться в будущем. Не рекомендуется полагаться на сохранение кластеров со статусом INACTIVE.

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

Количество контейнерных инстансов, зарегистрированных в кластере. Включает контейнерные инстансы в состояниях ACTIVE и DRAINING.

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

Количество задач в кластере в состоянии RUNNING.

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

Количество задач в кластере в состоянии PENDING.

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

Количество служб в кластере в состоянии ACTIVE. Эти службы можно просмотреть с помощью PListServices.

statistics -> (список)

Дополнительная информация о ваших кластерах, разделенная по типу запуска. Включает:

runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount

(структура)

Объект пар ключ-значение.

name -> (строка)

Имя пары ключ-значение. Для переменных среды - это имя переменной среды.

value -> (строка)

Значение пары ключ-значение. Для переменных среды - это значение переменной среды.

tags -> (список)

Метаданные, применяемые к кластеру для категоризации и организации. Каждый тег состоит из ключа и необязательного значения. Вы задаете оба.

Применяются следующие ограничения:

Максимальное количество тегов на ресурс - 50
Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
Максимальная длина ключа - 128 символов Юникода в UTF-8
Максимальная длина значения - 256 символов Юникода в UTF-8
Если ваша схема тегов используется в нескольких сервисах и ресурсах, помните, что другие сервисы могут иметь ограничения на разрешенные символы. В целом разрешены: буквы, цифры, пробелы, представляемые в UTF-8, и следующие символы: + - = . _ : / @.
Ключи и значения тегов чувствительны к регистру.
Не используйте aws:, AWS: или любые комбинации этих префиксов в верхнем или нижнем регистре для ключей или значений, так как они зарезервированы для использования Amazon Web Services. Вы не можете редактировать или удалять ключи или значения тегов с этим префиксом. Теги с этим префиксом не учитываются при подсчете тегов на ресурс.

(структура)

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

Применяются следующие ограничения:

Максимальное количество тегов на ресурс - 50
Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
Максимальная длина ключа - 128 символов Юникода в UTF-8
Максимальная длина значения - 256 символов Юникода в UTF-8
Если ваша схема тегов используется в нескольких сервисах и ресурсах, помните, что другие сервисы могут иметь ограничения на разрешенные символы. В целом разрешены: буквы, цифры, пробелы, представляемые в UTF-8, и следующие символы: + - = . _ : / @.
Ключи и значения тегов чувствительны к регистру.
Не используйте aws:, AWS: или любые комбинации этих префиксов в верхнем или нижнем регистре для ключей или значений, так как они зарезервированы для использования Amazon Web Services. Вы не можете редактировать или удалять ключи или значения тегов с этим префиксом. Теги с этим префиксом не учитываются при подсчете тегов на ресурс.

key -> (строка)

Часть пары ключ-значение, составляющей тег. Ключ - это общая метка, которая действует как категория для более специфичных значений тегов.

value -> (строка)

Необязательная часть пары ключ-значение, составляющей тег. Значение - это описатель внутри категории тега (ключ).

settings -> (список)

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

(структура)

Настройки для создания кластера. Используется для включения CloudWatch Container Insights с расширенной наблюдаемостью или CloudWatch Container Insights для кластера.

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

Дополнительную информацию можно найти в руководстве для разработчиков Amazon Elastic Container Service.

name -> (строка)

Имя настройки кластера. Значение - containerInsights.

value -> (строка)

Значение для настройки кластера. Поддерживаемые значения - enhanced, enabled и disabled.

Чтобы использовать Container Insights с расширенной наблюдаемостью, установите настройку учетной записи containerInsights в значение enhanced.

Чтобы использовать Container Insights, установите настройку учетной записи containerInsights в значение enabled.

Если для кластера указано значение, оно переопределит значение containerInsights, заданное с помощью PutAccountSetting или PutAccountSettingDefault.

capacityProviders -> (список)

Поставщики ресурсов, связанные с кластером.

(строка)

defaultCapacityProviderStrategy -> (список)

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

(структура)

Подробности стратегии поставщика емкости. Стратегию поставщика емкости можно задать при использовании API RunTask или CreateCluster или в качестве стратегии поставщика емкости по умолчанию для кластера с помощью API CreateCluster.

В стратегии поставщика емкости можно использовать только поставщиков емкости, уже связанных с кластером и имеющих статус ACTIVE или UPDATING. Для связывания поставщика емкости с кластером используется API PutClusterCapacityProviders.

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

Для использования поставщика емкости Fargate укажите поставщиков емкости FARGATE или FARGATE_SPOT. Поставщики емкости Fargate доступны для всех учетных записей и должны быть только связаны с кластером, чтобы использоваться в стратегии поставщика емкости.

С помощью FARGATE_SPOT можно запускать задачи, допускающие прерывания, с дисконтированной скоростью по сравнению с ценой FARGATE. FARGATE_SPOT запускает задачи на резервных вычислительных ресурсах. Когда Amazon Web Services нуждается в этих ресурсах обратно, ваши задачи прерываются с двухминутным предупреждением. FARGATE_SPOT поддерживает задачи Linux с архитектурой X86_64 на платформе версии 1.3.0 или выше. FARGATE_SPOT поддерживает задачи Linux с архитектурой ARM64 на платформе версии 1.4.0 или выше.

Стратегия поставщика емкости может содержать не более 20 поставщиков емкости.

capacityProvider -> (строка)

Короткое имя поставщика емкости.

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

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

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

Пример использования весов - определение стратегии, содержащей двух поставщиков емкости, у которых оба имеют вес 1, затем, когда выполняется условие base, задачи будут разделены равномерно между двумя поставщиками емкости. Используя ту же логику, если вы укажете вес 1 для capacityProviderA и вес 4 для capacityProviderB, то на каждую запущенную задачу с использованием capacityProviderA будут использоваться четыре задачи с использованием capacityProviderB.

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

Значение base определяет минимальное количество задач для запуска на указанном поставщике емкости. Только один поставщик емкости в стратегии поставщика емкости может иметь определенное значение base. Если значение не указано, используется значение по умолчанию 0.

attachments -> (список)

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

(структура)

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

id -> (строка)

Уникальный идентификатор прикрепления.

type -> (строка)

Тип прикрепления, такой как ElasticNetworkInterface, Service Connect и AmazonElasticBlockStorage.

status -> (строка)

Статус прикрепления. Допустимые значения - PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED и FAILED.

details -> (список)

Подробности прикрепления.

Для интерфейсов эластичной сети это включает идентификатор сетевого интерфейса, MAC-адрес, идентификатор подсети и частный IPv4-адрес.

Для сервисов Service Connect это включает portName, clientAliases, discoveryName и ingressPortOverride.

Для Elastic Block Storage это включает roleArn, deleteOnTermination, volumeName, volumeId и statusReason (только в случае, если прикрепление не удалось создать или подключить).

(структура)

Объект пары "ключ-значение".

name -> (строка)

Имя пары "ключ-значение". Для переменных среды это имя переменной среды.

value -> (строка)

Значение пары "ключ-значение". Для переменных среды это значение переменной среды.

attachmentsStatus -> (строка)

Статус поставщиков емкости, связанных с кластером. Ниже приведены состояния, которые возвращаются.

UPDATE_IN_PROGRESS

Доступные поставщики емкости для кластера обновляются.

UPDATE_COMPLETE

Поставщики емкости успешно обновлены.

UPDATE_FAILED

Обновление поставщика емкости завершилось ошибкой.

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

Используйте этот параметр для установки по умолчанию пространства имен Service Connect. После установки по умолчанию пространства имен Service Connect все новые сервисы с включенным Service Connect, созданные в кластере, добавляются как клиентские сервисы в пространстве имен. Это значение применяется только к новым сервисам, которые устанавливают параметр enabled в значение true в ServiceConnectConfiguration. Вы можете установить пространство имен каждого сервиса индивидуально в ServiceConnectConfiguration, чтобы переопределить этот параметр по умолчанию.

Задачи, выполняемые в пространстве имен, могут использовать короткие имена для подключения к сервисам в пространстве имен. Задачи могут подключаться к сервисам во всех кластерах в пространстве имен. Задачи подключаются через управляемый контейнер прокси-сервера, который собирает журналы и метрики для повышения наглядности. Поддерживаются только задачи, созданные сервисами Amazon ECS. Дополнительную информацию см. в разделе Service Connect в руководстве разработчика Amazon Elastic Container Service.

namespace -> (строка)

Имя пространства имен или полный Amazon Resource Name (ARN) пространства имен Cloud Map. Это пространство имен используется при создании сервиса без указания конфигурации Service Connect.

END_OF_DOCUMENT_MARKER