describe-generated-template

Описание

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

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

Синтаксис

  describe-generated-template
--generated-template-name <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) сгенерированного шаблона.

--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.

Вывод

GeneratedTemplateId -> (строка)

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

GeneratedTemplateName -> (строка)

Имя сгенерированного шаблона.

Resources -> (список)

Список объектов, описывающих детали ресурсов в шаблоне.

(структура)

Подробности о ресурсе в сгенерированном шаблоне

ResourceType -> (строка)

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

LogicalResourceId -> (строка)

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

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

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

key -> (строка)

value -> (строка)

ResourceStatus -> (строка)

Статус обработки ресурса в сгенерированном шаблоне.

InProgress

Обработка ресурса все еще в процессе.

Complete

Обработка ресурса завершена.

Pending

Обработка ресурса ожидает выполнения.

Failed

Обработка ресурса завершилась ошибкой.

ResourceStatusReason -> (строка)

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

Warnings -> (список)

Предупреждения, сгенерированные для этого ресурса.

(структура)

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

Type -> (строка)

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

MUTUALLY_EXCLUSIVE_PROPERTIES — ресурс требует взаимно исключающих свойств для записи. Генератор IaC выбирает один набор взаимно исключающих свойств и преобразует включенные свойства в параметры. Имена параметров имеют суффикс OneOf, а описания параметров указывают, что соответствующее свойство можно заменить другими исключающими свойствами.
UNSUPPORTED_PROPERTIES — в ресурсе присутствуют неподдерживаемые свойства. Одним из примеров неподдерживаемых свойств является обязательное свойство для записи, которое является массивом, так как параметр не может быть массивом. Другим примером является необязательное свойство для записи.
MUTUALLY_EXCLUSIVE_TYPES — в ресурсе обнаружено одно или несколько обязательных свойств для записи, а тип этого свойства может быть любого из нескольких типов.

Примечание

В настоящее время документация по ресурсам и свойствам не указывает, использует ли свойство тип oneOf или anyOf. Необходимо обратиться к схеме поставщика ресурсов.

Properties -> (список)

Свойства ресурса, которые затронуты этим предупреждением.

(структура)

Конкретное свойство, затронутое предупреждением.

PropertyPath -> (строка)

Путь к свойству. Например, если это для члена S3Bucket свойства Code, путь к свойству будет Code/S3Bucket.

Required -> (булево)

Если true, указанное свойство обязательно.

Description -> (строка)

Описание свойства из схемы поставщика ресурсов.

Status -> (строка)

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

CreatePending — создание шаблона ожидает выполнения.
CreateInProgress — создание шаблона выполняется.
DeletePending — удаление шаблона ожидает выполнения.
DeleteInProgress — удаление шаблона выполняется.
UpdatePending — обновление шаблона ожидает выполнения.
UpdateInProgress — обновление шаблона выполняется.
Failed — операция с шаблоном завершилась ошибкой.
Complete — операция с шаблоном завершена.

StatusReason -> (строка)

Причина текущего статуса генерации шаблона. Если произошла ошибка, это предоставит больше деталей.

CreationTime -> (временная метка)

Время создания сгенерированного шаблона.

LastUpdatedTime -> (временная метка)

Время последнего обновления сгенерированного шаблона.

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

Объект, описывающий прогресс генерации шаблона.

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

Количество ресурсов, успешно сгенерированных в шаблоне.

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

Количество ресурсов, которые не удалось сгенерировать в шаблоне.

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

Количество ресурсов, которые находятся в процессе генерации шаблона.

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

Количество ресурсов, которые все еще ожидают генерации шаблона.

StackId -> (строка)

ARN стека базового стека, если при генерации шаблона был предоставлен базовый стек.

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

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

DeletionPolicy -> (строка)

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

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

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

UpdateReplacePolicy -> (строка)

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

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

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

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

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