Spec-Zone.ru › AWS CLI v2

[ aws . cloudformation ]

create-stack-set

Описание

Создаёт набор стеков.

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

Синтаксис

  create-stack-set
--stack-set-name <value>
[--description <value>]
[--template-body <value>]
[--template-url <value>]
[--stack-id <value>]
[--parameters <value>]
[--capabilities <value>]
[--tags <value>]
[--administration-role-arn <value>]
[--execution-role-name <value>]
[--permission-model <value>]
[--auto-deployment <value>]
[--call-as <value>]
[--client-request-token <value>]
[--managed-execution <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 (строка)

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

Примечание

Имя стека может содержать только буквенно-цифровые символы (регистрозависимые) и дефисы. Оно должно начинаться с буквы и не может быть длиннее 128 символов.

--description (строка)

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

--template-body (строка)

Структура, содержащая тело шаблона, с минимальной длиной 1 байт и максимальной длиной 51 200 байт.

Условие: Вы должны указать либо параметр TemplateBody, либо TemplateURL, но не оба.

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

URL-адрес файла, содержащего тело шаблона. URL-адрес должен указывать на шаблон (максимальный размер: 1 МБ), который находится в ведре Amazon S3 или документе Systems Manager. Путь к ведру Amazon S3 должен начинаться с https:// .

Условие: Вы должны указать либо параметр TemplateBody, либо TemplateURL, но не оба.

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

Идентификатор стека, который импортируется в новый набор стеков. Укажите Amazon Resource Name (ARN) стека.

--parameters (список)

Входные параметры для шаблона набора стеков.

(структура)

Тип данных параметра.

ParameterKey -> (строка)

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

ParameterValue -> (строка)

Входное значение, связанное с параметром.

UsePreviousValue -> (булево)

Во время обновления стека используйте существующее значение параметра, используемое стеком для данного ключа параметра. Если вы указываете true , не указывайте значение параметра.

ResolvedValue -> (строка)

Только для чтения. Значение, соответствующее ключу параметра Systems Manager. Это поле возвращается только для типов параметров Systems Manager в шаблоне. Для получения дополнительной информации, см. Укажите существующие ресурсы во время выполнения с типами параметров, предоставляемыми CloudFormation, в руководстве пользователя CloudFormation.

Синтаксис в сокращённом виде:

ParameterKey=string,ParameterValue=string,UsePreviousValue=boolean,ResolvedValue=string ...

Синтаксис JSON:

[
  {
    "ParameterKey": "string",
    "ParameterValue": "string",
    "UsePreviousValue": true|false,
    "ResolvedValue": "string"
  }
  ...
]

--capabilities (список)

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

  • CAPABILITY_IAM и CAPABILITY_NAMED_IAM Некоторые шаблоны стеков могут содержать ресурсы, которые могут повлиять на разрешения в вашей учётной записи Amazon Web Services; например, создавая новых пользователей IAM. Для этих наборов стеков вы должны явно подтвердить это, указав одну из этих возможностей. Следующие ресурсы IAM требуют, чтобы вы указали либо возможность CAPABILITY_IAM , либо CAPABILITY_NAMED_IAM .
    • Если у вас есть ресурсы IAM, вы можете указать любую из этих возможностей.
    • Если у вас есть ресурсы IAM с пользовательскими именами, вы обязательно должны указать CAPABILITY_NAMED_IAM .
    • Если вы не укажете ни одну из этих возможностей, CloudFormation вернёт ошибку InsufficientCapabilities .

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

  • AWS::IAM::AccessKey
  • AWS::IAM::Group
  • AWS::IAM::InstanceProfile
  • AWS::IAM::Policy
  • AWS::IAM::Role
  • AWS::IAM::User
  • AWS::IAM::UserToGroupAddition

Для получения дополнительной информации см. Подтверждение ресурсов IAM в шаблонах CloudFormation.

  • CAPABILITY_AUTO_EXPAND Некоторые шаблоны ссылаются на макросы. Если шаблон вашего набора стеков ссылается на один или несколько макросов, вы должны создать набор стеков непосредственно из обработанного шаблона, не просматривая предварительно результирующие изменения в наборе изменений. Чтобы создать набор стеков непосредственно, вы должны подтвердить эту возможность. Для получения дополнительной информации, см. Выполнение пользовательской обработки шаблонов CloudFormation с макросами шаблонов.

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

Наборы стеков с управлением службой разрешениями в настоящее время не поддерживают использование макросов в шаблонах. (Это включает трансформации AWS::Include и AWS::Serverless, которые являются макросами, размещёнными CloudFormation.) Даже если вы укажете эту возможность для набора стеков с управлением службой разрешениями, если вы ссылаетесь на макрос в шаблоне, операция создания набора стеков завершится ошибкой.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  CAPABILITY_IAM
  CAPABILITY_NAMED_IAM
  CAPABILITY_AUTO_EXPAND

--tags (список)

Пары ключ-значение, которые нужно связать с этим набором стеков и созданными из него стеками. CloudFormation также распространяет эти теги на поддерживаемые ресурсы, созданные в стеках. Можно указать не более 50 тегов.

Если вы указываете теги в рамках действия CreateStackSet , CloudFormation проверяет, имеете ли вы необходимые разрешения IAM для тегирования ресурсов. Если нет, всё действие CreateStackSet завершится с ошибкой access denied , и набор стеков не будет создан.

(структура)

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

Key -> (строка)

Обязательное поле. Строка, используемая для идентификации этого тега. Вы можете указать не более 128 символов для ключа тега. Теги, принадлежащие Amazon Web Services, имеют зарезервированный префикс: aws: .

Value -> (строка)

Обязательное поле. Строка, содержащая значение для этого тега. Вы можете указать не более 256 символов для значения тега.

Синтаксис в сокращённом виде:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

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

Amazon Resource Name (ARN) роли IAM, которую нужно использовать для создания этого набора стеков.

Укажите роль IAM только в том случае, если вы используете настраиваемые роли администратора для управления тем, какие пользователи или группы могут управлять конкретными наборами стеков в той же учётной записи администратора. Для получения дополнительной информации, см. Предоставление собственных разрешений в руководстве пользователя CloudFormation.

Действительно только если модель разрешений — SELF_MANAGED .

--execution-role-name (строка)

Имя роли выполнения IAM, которую нужно использовать для создания набора стеков. Если вы не указываете роль выполнения, CloudFormation использует роль AWSCloudFormationStackSetExecutionRole для операции с набором стеков.

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

Действительно только если модель разрешений — SELF_MANAGED .

--permission-model (строка)

Описание способа создания ролей IAM, необходимых для операций с набором стеков. По умолчанию указано SELF-MANAGED .

  • С разрешениями self-managed вы должны создать необходимые роли администратора и выполнения для развертывания в целевых учётных записях. Для получения дополнительной информации, см. Предоставление собственных разрешений.
  • С разрешениями service-managed StackSets автоматически создаёт роли IAM, необходимые для развертывания в учётных записях, управляемых Организациями. Для получения дополнительной информации, см. Активировать доверенный доступ для наборов стеков с Организациями.

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

  • SERVICE_MANAGED
  • SELF_MANAGED

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

Описание того, автоматически ли StackSets развертывает в учётные записи Организаций, добавленные в целевую организацию или организационное подразделение (OU). Для получения дополнительной информации, см. Управление автоматическими развертываниями для CloudFormation StackSets, использующих разрешения, управляемые службой, в руководстве пользователя CloudFormation.

Требуется, если модель разрешений — SERVICE_MANAGED . (Не используется с собственными разрешениями.)

Enabled -> (булево)

Если установлено значение true , StackSets автоматически развертывает дополнительные экземпляры стеков в учётные записи Организаций, добавленные в целевую организацию или организационное подразделение (OU) в указанных регионах. Если учётная запись удалена из целевой организации или OU, StackSets удаляет экземпляры стеков из учётной записи в указанных регионах.

RetainStacksOnAccountRemoval -> (булево)

Если установлено значение true , ресурсы стека сохраняются, когда учётная запись удаляется из целевой организации или OU. Если установлено значение false , ресурсы стека удаляются. Укажите только если Enabled установлено значение True .

Синтаксис в сокращённом виде:

Enabled=boolean,RetainStacksOnAccountRemoval=boolean

Синтаксис JSON:

{
  "Enabled": true|false,
  "RetainStacksOnAccountRemoval": true|false
}

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

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

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

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

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

Действительно только если модель разрешений — SERVICE_MANAGED .

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

  • SELF
  • DELEGATED_ADMIN

--client-request-token (строка)

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

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

--managed-execution (структура)

Описывает, выполняют ли StackSets неконфликтующие операции одновременно и добавляют в очередь конфликтующие операции.

Active -> (boolean)

Когда true, StackSets выполняет неконфликтующие операции одновременно и помещает конфликтующие операции в очередь. После завершения конфликтующих операций StackSets запускает операции из очереди в порядке запроса.

Примечание

Если уже выполняются или находятся в очереди операции, StackSets помещает все входящие операции в очередь, даже если они не конфликтуют.

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

Когда false (по умолчанию), StackSets выполняет по одной операции за раз в порядке запроса.

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

Active=boolean

Синтаксис JSON:

{
  "Active": true|false
}

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (строка)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Для создания набора стеков

Следующий create-stack-set пример создает набор стеков, используя указанный шаблон YAML-файла. template.yaml — это шаблон AWS CloudFormation в текущем каталоге, который определяет стек.

aws cloudformation create-stack-set \
    --stack-set-name my-stack-set \
    --template-body file://template.yaml \
    --description "SNS topic"

Вывод:

{
    "StackSetId": "my-stack-set:8d0f160b-d157-xmpl-a8e6-c0ce8e5d8cc1"
}

Чтобы добавить экземпляры стеков в набор стеков, используйте команду create-stack-instances.

Вывод

StackSetId -> (строка)

Идентификатор набора стеков, который вы создаете.

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

Spec-Zone.ru

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