Spec-Zone.ru › AWS CLI v2

[ aws . cloudformation ]

delete-stack-instances

Описание

Удаляет экземпляры стека для указанных учетных записей в указанных регионах Amazon Web Services.

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

Синтаксис

  delete-stack-instances
--stack-set-name <value>
[--accounts <value>]
[--deployment-targets <value>]
--regions <value>
[--operation-preferences <value>]
--retain-stacks | --no-retain-stacks
[--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, для которых требуется удалить экземпляры стеков.

Вы можете указать Accounts или DeploymentTargets , но не оба.

(строка)

Синтаксис:

"string" "string" ...

--deployment-targets (структура)

[Права управляемой службой] Учетные записи Организации, из которых требуется удалить экземпляры стеков.

Вы можете указать Accounts или DeploymentTargets , но не оба.

Accounts -> (список)

Идентификаторы учетных записей Amazon Web Services. Если у вас много номеров учетных записей, вы можете указать их, используя свойство AccountsUrl.

(строка)

AccountsUrl -> (строка)

Путь к URL-адресу Amazon S3 к файлу, содержащему список идентификаторов учетных записей Amazon Web Services. Формат файла должен быть либо .csv , либо .txt , а данные могут быть разделены запятыми или новой строкой. В настоящее время существует ограничение в 10 МБ для данных (приблизительно 800 000 учетных записей).

OrganizationalUnitIds -> (список)

Идентификатор корневого элемента организации или идентификаторы подразделений (OU).

(строка)

AccountFilterType -> (строка)

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

Ниже приведен список возможных значений для операции 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, в которых требуется удалить экземпляры набора стеков.

(строка)

Синтаксис:

"string" "string" ...

--operation-preferences (структура)

Предпочтения, определяющие, как CloudFormation выполняет эту операцию с набором стеков.

RegionConcurrencyType -> (строка)

Тип параллельности развертывания операций StackSets в регионах, может быть параллельным или по одному региону за раз.

RegionOrder -> (список)

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

(строка)

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

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

Условие: вы должны указать либо FailureToleranceCount , либо FailureTolerancePercentage (но не оба).

По умолчанию указано 0.

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

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

При расчете количества учетных записей на основе указанного процента CloudFormation округляет вниз до ближайшего целого числа.

Условие: вы должны указать либо FailureToleranceCount , либо FailureTolerancePercentage (но не оба).

По умолчанию указано 0.

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

Максимальное количество учетных записей, в которых будет выполняться эта операция одновременно. Это может зависеть от значения FailureToleranceCount в зависимости от вашей ConcurrencyMode. MaxConcurrentCount не может быть больше чем на единицу FailureToleranceCount, если вы используете 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"
}

--retain-stacks | --no-retain-stacks (булево)

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

Дополнительную информацию см. в разделе Параметры операции с набором стеков.

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

Уникальный идентификатор этой операции с набором стеков.

Если вы не укажете идентификатор операции, SDK сгенерирует его автоматически.

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

Повторное выполнение этой операции с набором стеков с новым идентификатором операции повторяет все экземпляры стеков, статус которых OUTDATED.

--call-as (строка)

[Права управляемой службой] Указывает, действуете ли вы в качестве администратора учетной записи в учетной записи управления организацией или как делегированный администратор в учетной записи участника.

По умолчанию указано SELF. Используйте SELF для наборов стеков с правами самообслуживания.

  • Если вы вошли в систему в учетной записи управления, укажите SELF.
  • Если вы вошли в систему в учетной записи делегированного администратора, укажите DELEGATED_ADMIN. Ваша учетная запись Amazon Web Services должна быть зарегистрирована в качестве делегированного администратора в учетной записи управления. Дополнительную информацию см. в разделе Регистрация делегированного администратора в руководстве пользователя CloudFormation.

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

  • SELF
  • DELEGATED_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 (boolean)

Включить отладочную запись.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/среды.

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается как двоичный блок, 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.

Для удаления экземпляров стека

Следующий delete-stack-instances пример удаляет экземпляры набора стеков в двух учетных записях в двух регионах и завершает стеки.

aws cloudformation delete-stack-instances \
    --stack-set-name my-stack-set \
    --accounts 123456789012 567890123456 \
    --regions us-east-1 us-west-1 \
    --no-retain-stacks

Вывод:

{
    "OperationId": "ad49f10c-fd1d-413f-a20a-8de6e2fa8f27"
}

Для удаления пустого набора стеков используйте команду delete-stack-set.

Вывод

OperationId -> (string)

Уникальный идентификатор данной операции набора стеков.

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

Spec-Zone.ru

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