Spec-Zone.ru › AWS CLI v2

[ aws . cloudformation ]

обновить-сгенерированный-шаблон

Описание

Обновляет сгенерированный шаблон. Это можно использовать для изменения имени, добавления и удаления ресурсов, обновления ресурсов и изменения параметров DeletionPolicy и UpdateReplacePolicy. Статус обновления сгенерированного шаблона можно проверить с помощью действия API DescribeGeneratedTemplate.

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

Синтаксис

  update-generated-template
--generated-template-name <value>
[--new-generated-template-name <value>]
[--add-resources <value>]
[--remove-resources <value>]
[--refresh-all-resources | --no-refresh-all-resources]
[--template-configuration <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]

Параметры

--generated-template-name (строка)

Имя или Amazon Resource Name (ARN) сгенерированного шаблона.

--new-generated-template-name (строка)

Необязательное новое имя для присвоения сгенерированному шаблону.

--add-resources (список)

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

(структура)

Ресурс, включённый в сгенерированный шаблон. Этот тип данных используется с действиями API CreateGeneratedTemplate и UpdateGeneratedTemplate.

ResourceType -> (строка)

Тип ресурса, например, AWS::DynamoDB::Table. Список поддерживаемых ресурсов см. в разделе Поддержка типов ресурсов для импорта и обнаружения отклонений в Руководстве пользователя CloudFormation.

LogicalResourceId -> (строка)

Логический идентификатор ресурса в сгенерированном шаблоне.

ResourceIdentifier -> (словарь)

Список до 256 пар ключ-значение, идентифицирующих сканируемый ресурс. Ключ — имя одного из основных идентификаторов ресурса. (Основные идентификаторы указаны в списке primaryIdentifier в схеме ресурса.) Значение — значение этого основного идентификатора. Например, для ресурса AWS::DynamoDB::Table основными идентификаторами являются TableName, поэтому пара ключ-значение может быть "TableName": "MyDDBTable". Дополнительную информацию см. в разделе primaryIdentifier в Руководстве пользователя командной строки CloudFormation (CLI).

key -> (строка)

value -> (строка)

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

ResourceType=string,LogicalResourceId=string,ResourceIdentifier={KeyName1=string,KeyName2=string} ...

Синтаксис JSON:

[
  {
    "ResourceType": "string",
    "LogicalResourceId": "string",
    "ResourceIdentifier": {"string": "string"
      ...}
  }
  ...
]

--remove-resources (список)

Список логических идентификаторов ресурсов, которые необходимо удалить из сгенерированного шаблона.

(строка)

Синтаксис:

"string" "string" ...

--refresh-all-resources | --no-refresh-all-resources (булево)

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

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

Сведения о конфигурации сгенерированного шаблона, включая DeletionPolicy и UpdateReplacePolicy.

DeletionPolicy -> (строка)

DeletionPolicy, назначенные ресурсам в сгенерированном шаблоне. Поддерживаемые значения:

  • DELETE — удаление всех ресурсов при удалении стека.
  • RETAIN — сохранение всех ресурсов при удалении стека.

Дополнительную информацию см. в атрибуте DeletionPolicy в Руководстве пользователя CloudFormation.

UpdateReplacePolicy -> (строка)

UpdateReplacePolicy, назначенные ресурсам в сгенерированном шаблоне. Поддерживаемые значения:

  • DELETE — удаление всех ресурсов при замене ресурса во время операции обновления.
  • RETAIN — сохранение всех ресурсов при замене ресурса во время операции обновления.

Дополнительную информацию см. в атрибуте UpdateReplacePolicy в Руководстве пользователя CloudFormation.

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

DeletionPolicy=string,UpdateReplacePolicy=string

Синтаксис JSON:

{
  "DeletionPolicy": "DELETE"|"RETAIN",
  "UpdateReplacePolicy": "DELETE"|"RETAIN"
}

--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
  • таблица
  • 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 (булево)

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

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

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

Вывод

GeneratedTemplateId -> (строка)

Amazon Resource Name (ARN) сгенерированного шаблона. Формат: arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. Например, ``arn:aws:cloudformation:us-east-1 :123456789012 :generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc `` .

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

Spec-Zone.ru

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