[ aws . cloudformation ]
update-stack-instances
Описание
Обновляет значения параметров для экземпляров стека для указанных учетных записей в указанных регионах Amazon Web Services. Экземпляр стека относится к стеку в конкретной учетной записи и регионе.
Вы можете обновлять только экземпляры стека в регионах и учетных записях Amazon Web Services, где они уже существуют; для создания дополнительных экземпляров стека используйте CreateStackInstances.
Во время обновлений набора стеков любые переопределенные параметры для экземпляра стека не обновляются, а сохраняют свое переопределенное значение.
Вы можете обновлять только значения параметров, указанных в наборе стеков; для добавления или удаления параметра используйте UpdateStackSet для обновления шаблона набора стеков. Если вы добавляете параметр в шаблон, прежде чем вы сможете переопределить значение параметра, указанное в наборе стеков, вы должны сначала использовать UpdateStackSet для обновления всех экземпляров стеков с обновленным шаблоном и значением параметра, указанным в наборе стеков. После того, как экземпляр стека был обновлен с новым параметром, вы можете переопределить значение параметра, используя UpdateStackInstances .
См. также: Документация API AWS
Синтаксис
update-stack-instances
--stack-set-name <value>
[--accounts <value>]
[--deployment-targets <value>]
--regions <value>
[--parameter-overrides <value>]
[--operation-preferences <value>]
[--operation-id <value>]
[--call-as <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]
Параметры
--stack-set-name (строка)
--accounts (список)
[Права самообслуживания] Идентификаторы учетных записей одного или нескольких аккаунтов Amazon Web Services, для которых требуется обновить значения параметров для стековых экземпляров. Изменённые значения параметров будут применены ко всем стековым экземплярам в указанных аккаунтах и регионах Amazon Web Services.
Вы можете указать Accounts или DeploymentTargets , но не оба.
(строка)
Синтаксис:
"string" "string" ...
--deployment-targets (структура)
[Права, управляемые сервисом] Учетные записи Организации, для которых требуется обновить значения параметров для стековых экземпляров. Если ваш запрос направлен на подразделения Организации, изменённые значения параметров применяются только к учетным записям, которые в настоящее время находятся в целевых подразделениях и их дочерних подразделениях. Учетные записи, добавленные в целевые подразделения и их дочерние подразделения в будущем, не будут использовать изменённые значения.
Вы можете указать Accounts или DeploymentTargets , но не оба.
Accounts -> (список)
Идентификаторы учетных записей аккаунтов Amazon Web Services. Если у вас много номеров учетных записей, вы можете указать их, используя свойство AccountsUrl вместо этого.
(строка)
AccountsUrl -> (строка)
.csv, либо .txt, а данные могут быть разделены запятыми или новой строкой. В настоящее время существует ограничение в 10 МБ для данных (примерно 800 000 учетных записей).OrganizationalUnitIds -> (список)
Идентификатор корня организации или идентификаторы подразделений организации (OU).
(строка)
AccountFilterType -> (строка)
Ограничить целевые развертывания отдельными учетными записями или включить дополнительные учетные записи с предоставленными подразделениями OU.
Следующий список возможных значений для операции AccountFilterType.
-
INTERSECTION: StackSets выполняет развертывание в учетных записях, указанных в параметреAccounts. -
DIFFERENCE: StackSets исключает учетные записи, указанные в параметреAccounts. Это позволяет пользователю избежать определённых учетных записей в подразделении OU, таких как приостановленные учетные записи. -
UNION: StackSets включает дополнительные учетные записи в качестве целевых для развертывания. Это значение по умолчанию, еслиAccountFilterTypeне указано. Это позволяет пользователю обновить всё подразделение OU и отдельные учетные записи из другого подразделения OU в одном запросе, что раньше требовало двух отдельных запросов. -
NONE: Развертывание во все учетные записи в указанных подразделениях организации (OU).
Сокращенный синтаксис:
Accounts=string,string,AccountsUrl=string,OrganizationalUnitIds=string,string,AccountFilterType=string
Синтаксис JSON:
{
"Accounts": ["string", ...],
"AccountsUrl": "string",
"OrganizationalUnitIds": ["string", ...],
"AccountFilterType": "NONE"|"INTERSECTION"|"DIFFERENCE"|"UNION"
}
--regions (список)
Названия одного или нескольких регионов Amazon Web Services, в которых требуется обновить значения параметров для стековых экземпляров. Изменённые значения параметров будут применены ко всем стековым экземплярам в указанных аккаунтах и регионах Amazon Web Services.
(строка)
Синтаксис:
"string" "string" ...
--parameter-overrides (список)
Список входных параметров, значения которых требуется обновить для указанных стековых экземпляров.
Любые изменённые значения параметров будут применены ко всем стековым экземплярам в указанных аккаунтах и регионах Amazon Web Services. При указании параметров и их значений учитывайте, как CloudFormation устанавливает значения параметров во время операций обновления стековых экземпляров:
- Чтобы переопределить текущее значение параметра, включите параметр и укажите его значение.
- Чтобы оставить изменённый параметр со своим текущим значением, включите параметр и укажите
UsePreviousValueкакtrue. (Вы не можете указать и значение, и установитьUsePreviousValueвtrue). - Чтобы установить изменённый параметр обратно на значение, указанное в наборе стеков, укажите список параметров, но не включайте параметр в список.
- Чтобы оставить все параметры со своими текущими значениями, не указывайте этот параметр вообще.
Во время обновлений набора стеков любые значения параметров, переопределённые для стекового экземпляра, не обновляются, а сохраняют своё переопределённое значение.
Вы можете переопределить только значения параметров, которые указаны в наборе стеков; чтобы добавить или удалить сам параметр, используйте UpdateStackSet для обновления шаблона набора стеков. Если вы добавляете параметр в шаблон, прежде чем вы сможете переопределить значение параметра, указанное в наборе стеков, вы должны сначала использовать UpdateStackSet для обновления всех стековых экземпляров с обновлённым шаблоном и значением параметра, указанным в наборе стеков. После обновления стекового экземпляра с новым параметром, вы можете переопределить значение параметра с помощью UpdateStackInstances.
(структура)
Тип данных параметра.
ParameterKey -> (строка)
ParameterValue -> (строка)
UsePreviousValue -> (булево)
true, не указывайте значение параметра.ResolvedValue -> (строка)
Сокращенный синтаксис:
ParameterKey=string,ParameterValue=string,UsePreviousValue=boolean,ResolvedValue=string ...
Синтаксис JSON:
[
{
"ParameterKey": "string",
"ParameterValue": "string",
"UsePreviousValue": true|false,
"ResolvedValue": "string"
}
...
]
--operation-preferences (структура)
Настройки, определяющие, как CloudFormation выполняет эту операцию набора стеков.
RegionConcurrencyType -> (строка)
RegionOrder -> (список)
Порядок регионов, в которых вы хотите выполнить операцию со стеком.
(строка)
FailureToleranceCount -> (целое число)
Количество учетных записей в каждом регионе, в которых эта операция может завершиться неудачей, прежде чем CloudFormation остановит операцию в этом регионе. Если операция остановлена в одном регионе, CloudFormation не пытается выполнить её в последующих регионах.
Условие: вы должны указать либо FailureToleranceCount, либо FailureTolerancePercentage (но не оба).
По умолчанию указывается 0.
FailureTolerancePercentage -> (целое число)
Процент учетных записей в каждом регионе, в которых эта операция стека может завершиться неудачей, прежде чем CloudFormation остановит операцию в этом регионе. Если операция остановлена в одном регионе, CloudFormation не пытается выполнить её в последующих регионах.
При расчёте количества учетных записей на основе указанного процента, CloudFormation округляет в меньшую сторону до ближайшего целого числа.
Условие: вы должны указать либо FailureToleranceCount, либо FailureTolerancePercentage, но не оба.
По умолчанию указывается 0.
MaxConcurrentCount -> (целое число)
Максимальное количество учетных записей, в которых можно выполнить эту операцию одновременно. Это может зависеть от значения FailureToleranceCount в зависимости от вашего ConcurrencyMode. MaxConcurrentCount не может превышать значение FailureToleranceCount +1, если вы используете STRICT_FAILURE_TOLERANCE.
Обратите внимание, что это значение позволяет указать максимальное количество операций. В некоторых случаях при больших развертываниях фактическое количество учетных записей, обработанных одновременно, может быть меньше из-за ограничения сервиса.
Условие: вы должны указать либо MaxConcurrentCount, либо MaxConcurrentPercentage, но не оба.
По умолчанию указывается 1.
MaxConcurrentPercentage -> (целое число)
Максимальный процент учетных записей, в которых можно выполнить эту операцию одновременно.
При расчёте количества учетных записей на основе указанного процента, CloudFormation округляет в меньшую сторону до ближайшего целого числа. Это верно, за исключением случаев, когда округление вниз даёт ноль. В этом случае CloudFormation устанавливает значение как один.
Обратите внимание, что это значение позволяет указать максимальное количество операций. В некоторых случаях при больших развертываниях фактическое количество учетных записей, обработанных одновременно, может быть меньше из-за ограничения сервиса.
Условие: вы должны указать либо MaxConcurrentCount, либо MaxConcurrentPercentage, но не оба.
По умолчанию указывается 1.
ConcurrencyMode -> (строка)
Указывает, как уровень одновременности ведёт себя во время выполнения операции.
-
STRICT_FAILURE_TOLERANCE: Этот параметр динамически снижает уровень одновременности, чтобы гарантировать, что количество неудачных учетных записей никогда не превысит значениеFailureToleranceCount+1. Начальный фактический уровень одновременности устанавливается как меньшее из значенияMaxConcurrentCountили значенияFailureToleranceCount+1. Фактический уровень одновременности затем пропорционально уменьшается в зависимости от количества ошибок. Это поведение по умолчанию. Если толерантность к ошибкам или максимальное количество одновременных учетных записей заданы в процентах, поведение аналогичное. -
SOFT_FAILURE_TOLERANCE: Этот параметр отделяетFailureToleranceCountот фактического уровня одновременности. Это позволяет операциям набора стеков выполняться с уровнем одновременности, установленным значениемMaxConcurrentCountилиMaxConcurrentPercentage, независимо от количества неудач.
Сокращенный синтаксис:
RegionConcurrencyType=string,RegionOrder=string,string,FailureToleranceCount=integer,FailureTolerancePercentage=integer,MaxConcurrentCount=integer,MaxConcurrentPercentage=integer,ConcurrencyMode=string
Синтаксис JSON:
{
"RegionConcurrencyType": "SEQUENTIAL"|"PARALLEL",
"RegionOrder": ["string", ...],
"FailureToleranceCount": integer,
"FailureTolerancePercentage": integer,
"MaxConcurrentCount": integer,
"MaxConcurrentPercentage": integer,
"ConcurrencyMode": "STRICT_FAILURE_TOLERANCE"|"SOFT_FAILURE_TOLERANCE"
}
--operation-id (строка)
Уникальный идентификатор этой операции набора стеков.
Идентификатор операции также используется как маркер идемпотентности, чтобы гарантировать, что операция набора стеков выполняется только один раз, даже если вы многократно повторяете запрос. Вы можете повторно отправлять запросы на выполнение операций набора стеков, чтобы убедиться, что CloudFormation их успешно получил.
Если вы не укажете идентификатор операции, SDK сгенерирует его автоматически.
--call-as (строка)
[Управляемые службой разрешения] Указывает, действуете ли вы как администратор учетной записи в учетной записи управления организацией или как делегированный администратор в учетной записи участника.
По умолчанию указано SELF. Используйте SELF для наборов стеков с разрешениями, управляемыми самим пользователем.
- Если вы вошли в учетную запись управления, укажите
SELF. - Если вы вошли в учетную запись делегированного администратора, укажите
DELEGATED_ADMIN. Ваша учетная запись Amazon Web Services должна быть зарегистрирована как делегированный администратор в учетной записи управления. Дополнительную информацию см. в разделе Зарегистрировать делегированного администратора в руководстве пользователя CloudFormation.
Возможные значения:
SELFDELEGATED_ADMIN
--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
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определенного профиля из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отображение версии этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- on
- off
- auto
--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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве «Начало работы» в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования, аналогичные Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. Дополнительную информацию см. в руководстве пользователя AWS CLI в разделе Использование кавычек со строками.
Обновление экземпляров стека
Следующий update-stack-instances пример повторно пытается обновить экземпляры стеков в двух учетных записях в двух регионах с использованием последних настроек. Указанное значение для обработки ошибок гарантирует, что попытка обновления будет выполнена во всех учетных записях и регионах, даже если некоторые стеки не могут быть обновлены.
aws cloudformation update-stack-instances \
--stack-set-name my-stack-set \
--accounts 123456789012 567890123456 \
--regions us-east-1 us-west-2 \
--operation-preferences FailureToleranceCount=3
Вывод:
{
"OperationId": "103ebdf2-21ea-xmpl-8892-de5e30733132"
}
Вывод
OperationId -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.