Spec-Zone.ru › AWS CLI v2

[ aws . cloudformation ]

describe-change-set

Описание

Возвращает входные данные для набора изменений и список изменений, которые CloudFormation внесет, если вы выполните набор изменений. Дополнительную информацию см. в разделе Обновление стеков CloudFormation с помощью наборов изменений в Руководстве пользователя CloudFormation .

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

describe-change-set является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную обработку, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничную обработку аргумент --query должен извлечь данные из результатов следующих выражений запроса: Changes

Синтаксис

  describe-change-set
--change-set-name <value>
[--stack-name <value>]
[--include-property-values | --no-include-property-values]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--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]

Параметры

--change-set-name (строка)

Имя или Amazon Resource Name (ARN) набора изменений, который вы хотите описать.

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

Если вы указали имя набора изменений, укажите имя или ID (ARN) стека набора изменений, который вы хотите описать.

--include-property-values | --no-include-property-values (логическое значение)

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

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет взята буквально. Это нельзя указывать вместе с --cli-input-yaml.

--starting-token (строка)

Маркер для указания, где начать постраничную обработку. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface .

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken непосредственно вне AWS CLI.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface .

--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 (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 (логическое значение)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI .

Если не указано иное, все примеры используют правила цитирования, похожие на Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI .

Получение информации о наборе изменений

В следующем примере describe-change-set отображаются данные набора изменений, заданного по имени набора изменений и имени стека.

aws cloudformation describe-change-set \
    --change-set-name my-change-set \
    --stack-name my-stack

В следующем примере describe-change-set отображаются данные набора изменений, заданного полным ARN набора изменений:

aws cloudformation describe-change-set \
    --change-set-name arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/bc9555ba-a949-xmpl-bfb8-f41d04ec5784

Вывод:

{
    "Changes": [
        {
            "Type": "Resource",
            "ResourceChange": {
                "Action": "Modify",
                "LogicalResourceId": "function",
                "PhysicalResourceId": "my-function-SEZV4XMPL4S5",
                "ResourceType": "AWS::Lambda::Function",
                "Replacement": "False",
                "Scope": [
                    "Properties"
                ],
                "Details": [
                    {
                        "Target": {
                            "Attribute": "Properties",
                            "Name": "Timeout",
                            "RequiresRecreation": "Never"
                        },
                        "Evaluation": "Static",
                        "ChangeSource": "DirectModification"
                    }
                ]
            }
        }
    ],
    "ChangeSetName": "my-change-set",
    "ChangeSetId": "arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/4eca1a01-e285-xmpl-8026-9a1967bfb4b0",
    "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
    "StackName": "my-stack",
    "Description": null,
    "Parameters": null,
    "CreationTime": "2019-10-02T05:20:56.651Z",
    "ExecutionStatus": "AVAILABLE",
    "Status": "CREATE_COMPLETE",
    "StatusReason": null,
    "NotificationARNs": [],
    "RollbackConfiguration": {},
    "Capabilities": [
        "CAPABILITY_IAM"
    ],
    "Tags": null
}

Вывод

ChangeSetName -> (строка)

Имя набора изменений.

ChangeSetId -> (строка)

Amazon Resource Name (ARN) набора изменений.

StackId -> (строка)

Amazon Resource Name (ARN) стека, связанного с набором изменений.

StackName -> (строка)

Имя стека, связанного с набором изменений.

Description -> (строка)

Информация о наборе изменений.

Parameters -> (список)

Список структур Parameter, описывающих входные параметры и их значения, используемые для создания набора изменений. Для получения дополнительной информации см. тип данных Параметр.

(структура)

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

ParameterKey -> (строка)

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

ParameterValue -> (строка)

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

UsePreviousValue -> (булево)

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

ResolvedValue -> (строка)

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

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

Время начала создания набора изменений в формате UTC.

ExecutionStatus -> (строка)

Если статус выполнения набора изменений равен AVAILABLE , вы можете выполнить набор изменений. Если вы не можете выполнить набор изменений, статус указывает причину. Например, набор изменений может быть в состоянии UNAVAILABLE, потому что CloudFormation всё ещё его создаёт, или в состоянии OBSOLETE, потому что стек уже был обновлён.

Status -> (строка)

Текущий статус набора изменений, например, CREATE_PENDING, CREATE_COMPLETE или FAILED.

StatusReason -> (строка)

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

NotificationARNs -> (список)

ARN топиков Amazon SNS, которые будут связаны со стеком, если вы выполните набор изменений.

(строка)

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

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

RollbackTriggers -> (список)

Триггеры мониторинга во время действий по созданию или обновлению стека.

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

  • Для использования триггеров отката, ранее указанных для этого стека, если таковые имеются, не указывайте этот параметр.
  • Для указания новых или обновлённых триггеров отката вы должны указать все триггеры, которые вы хотите использовать для этого стека, даже триггеры, которые вы указывали ранее (например, при создании стека или во время предыдущего обновления стека). Любые триггеры, которые вы не включаете в обновлённый список триггеров, больше не применяются к стеку.
  • Для удаления всех текущих указанных триггеров укажите для этого параметра пустой список.

Если указанный триггер отсутствует, вся операция стека завершается ошибкой и отменяется.

(структура)

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

Arn -> (строка)

Amazon Resource Name (ARN) триггера отката.

Если указанный триггер отсутствует, вся операция стека завершается ошибкой и отменяется.

Type -> (строка)

Тип ресурса триггера отката. Укажите либо тип ресурса AWS::CloudWatch::Alarm, либо AWS::CloudWatch::CompositeAlarm.

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

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

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

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

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

Capabilities -> (список)

Если вы выполните набор изменений, список возможностей, которые были явно подтверждены при создании набора изменений.

(строка)

Tags -> (список)

Если вы выполните набор изменений, метки, которые будут присвоены стеку.

(структура)

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

Key -> (строка)

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

Value -> (строка)

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

Changes -> (список)

Список структур Change, описывающих ресурсы, которые изменяются CloudFormation при выполнении набора изменений.

(структура)

Структура Change описывает изменения, которые CloudFormation выполнит при выполнении набора изменений.

Тип -> (строка)

Тип сущности, которую изменяет CloudFormation.

  • Resource Это изменение относится к ресурсу.

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

Содержит либо null, если ни один из хуков не вызывается для ресурса, либо число хуков, которые будут вызваны для ресурса.

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

Структура ResourceChange, описывающая ресурс и действие, которое CloudFormation выполнит.

PolicyAction -> (строка)

Действие, которое будет выполнено над физическим ресурсом при выполнении набора изменений.

  • Delete Ресурс будет удалён.
  • Retain Ресурс будет сохранён.
  • Snapshot Для ресурса будет создан снимок.
  • ReplaceAndDelete Ресурс будет заменён, а затем удалён.
  • ReplaceAndRetain Ресурс будет заменён, а затем сохранён.
  • ReplaceAndSnapshot Ресурс будет заменён, а затем для него будет создан снимок.

Action -> (строка)

Действие, которое CloudFormation выполняет над ресурсом, например, Add (добавляет новый ресурс), Modify (изменяет ресурс), Remove (удаляет ресурс), Import (импортирует ресурс) или Dynamic (точного действия для ресурса определить нельзя).

LogicalResourceId -> (строка)

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

PhysicalResourceId -> (строка)

Физический идентификатор ресурса (имя ресурса). У ресурсов, которые вы добавляете, нет физических идентификаторов, потому что они ещё не созданы.

ResourceType -> (строка)

Тип ресурса CloudFormation, например, AWS::S3::Bucket.

Replacement -> (строка)

Для действия Modify указывает, будет ли CloudFormation заменять ресурс, создавая новый и удаляя старый. Это значение зависит от значения свойства RequiresRecreation в структуре ResourceTargetDefinition. Например, если поле RequiresRecreation равно Always, а поле Evaluation равно Static, то Replacement равно True. Если поле RequiresRecreation равно Always, а поле Evaluation равно Dynamic, то Replacement равно Conditional.

Если у вас несколько изменений с различными значениями RequiresRecreation, значение Replacement зависит от изменения с наибольшим влиянием. Значение RequiresRecreation, равное Always, имеет наибольшее влияние, за ним следуют Conditional и Never.

Scope -> (список)

Для действия Modify указывает, какой атрибут ресурса вызывает это обновление, например, изменение атрибута ресурса Metadata, Properties или Tags.

(строка)

Details -> (список)

Для действия Modify, список структур ResourceChangeDetail, описывающих изменения, которые CloudFormation внесёт в ресурс.

(структура)

Для ресурса, у которого Modify как действие, структура ResourceChange описывает изменения, которые CloudFormation внесёт в этот ресурс.

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

Структура ResourceTargetDefinition, описывающая поле, которое CloudFormation изменит, и будет ли ресурс пересоздан.

Attribute -> (строка)

Указывает, какой атрибут ресурса вызывает это обновление, например, изменение атрибута ресурса Metadata, Properties или Tags.

Name -> (строка)

Если значение Attribute равно Properties, то имя свойства. Для всех других атрибутов значение равно null.

RequiresRecreation -> (строка)

Если значение Attribute равно Properties, указывает, вызывает ли изменение этого свойства пересоздание ресурса. Значение может быть Never, Always или Conditionally. Чтобы определить условия для пересоздания Conditionally, обратитесь к поведению обновления для этого свойства в справочнике типов ресурсов и свойств Amazon Web Services в руководстве пользователя CloudFormation.

Path -> (строка)

Путь к свойству.

BeforeValue -> (строка)

Значение свойства до выполнения изменения.

AfterValue -> (строка)

Значение свойства после выполнения изменения.

AttributeChangeType -> (строка)

Тип изменения, которое будет внесено в свойство при выполнении изменения.

  • Add Элемент будет добавлен.
  • Remove Элемент будет удалён.
  • Modify Элемент будет изменён.

Evaluation -> (строка)

Указывает, может ли CloudFormation определить целевое значение и изменится ли целевое значение перед выполнением набора изменений.

Для оценок Static CloudFormation может определить, что целевое значение изменится, и его значение. Например, если вы напрямую изменяете свойство InstanceType экземпляра EC2, CloudFormation знает, что это значение свойства изменится, и его значение, поэтому это оценка Static.

Для оценок Dynamic CloudFormation не может определить целевое значение, потому что оно зависит от результата внутренней функции, такой как Ref или Fn::GetAtt внутренняя функция, когда стек обновляется. Например, если ваш шаблон содержит ссылку на ресурс, который условно пересоздаётся, значение ссылки (физический идентификатор ресурса) может измениться в зависимости от того, пересоздаётся ли ресурс. Если ресурс пересоздаётся, у него будет новый физический идентификатор, поэтому все ссылки на этот ресурс также будут обновлены.

ChangeSource -> (строка)

Группа, к которой принадлежит значение CausingEntity. Существует пять групп сущностей:

  • ResourceReference сущности — это Ref внутренние функции, которые ссылаются на ресурсы в шаблоне, например, { "Ref" : "MyEC2InstanceResource" }.
  • ParameterReference сущности — это Ref внутренние функции, которые получают значения параметров шаблона, например, { "Ref" : "MyPasswordParameter" }.
  • ResourceAttribute сущности — это Fn::GetAtt внутренние функции, которые получают значения атрибутов ресурсов, например, { "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] }.
  • DirectModification сущности — это изменения, внесённые непосредственно в шаблон.
  • Automatic сущности — это AWS::CloudFormation::Stack типы ресурсов, которые также известны как вложенные стеки. Если вы не внесли никаких изменений в ресурс AWS::CloudFormation::Stack, CloudFormation задаёт ChangeSource в Automatic, потому что шаблон вложенного стека может быть изменён. Изменения шаблона вложенного стека не видны CloudFormation до тех пор, пока вы не запустите обновление родительского стека.

CausingEntity -> (строка)

Идентификатор сущности, которая вызвала это изменение. Эта сущность является членом группы, указанной в поле ChangeSource. Например, если вы изменили значение параметра KeyPairName, то CausingEntity — это имя параметра (KeyPairName).

Если значение ChangeSource равно DirectModification, для CausingEntity значения не указано.

ChangeSetId -> (строка)

Идентификатор набора изменений вложенного набора изменений.

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

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

TypeHierarchy -> (строка)

Соединённый список типа или типов модуля, содержащих ресурс. Типы модулей перечислены, начиная с самого вложенного модуля, разделённые /.

В примере ниже ресурс был создан из модуля типа AWS::First::Example::MODULE, вложенного внутри родительского модуля типа AWS::Second::Example::MODULE.

AWS::First::Example::MODULE/AWS::Second::Example::MODULE

LogicalIdHierarchy -> (строка)

Соединённый список логических идентификаторов модуля или модулей, содержащих ресурс. Модули перечислены, начиная с самого вложенного модуля, разделённые /.

В примере ниже ресурс был создан из модуля moduleA, вложенного внутри родительского модуля moduleB.

moduleA/moduleB

Для получения дополнительной информации см. раздел Ссылка на модульные ресурсы в шаблонах CloudFormation в Руководстве пользователя CloudFormation.

BeforeContext -> (строка)

Строка JSON, закодированная в формате UTF-8, содержащая контекст ресурса перед выполнением изменения.

AfterContext -> (строка)

Строка JSON, закодированная в формате UTF-8, содержащая контекст ресурса после выполнения изменения.

NextToken -> (строка)

Если вывод превышает 1 МБ, строка, определяющая следующую страницу изменений. Если дополнительных страниц нет, это значение равно null.

IncludeNestedStacks -> (булево)

Проверяет, установлено ли IncludeNestedStacks в True.

ParentChangeSetId -> (строка)

Указывает идентификатор набора изменений родительского набора изменений в текущей иерархии вложенных наборов изменений.

RootChangeSetId -> (строка)

Указывает идентификатор набора изменений корневого набора изменений в текущей иерархии вложенных наборов изменений.

OnStackFailure -> (строка)

Определяет действие, которое будет выполнено, если создание стека завершится неудачно. Если этот параметр указан, параметр DisableRollback операции API ExecuteChangeSet не должен быть указан. Он должен быть одним из этих значений:

  • DELETE - Удаляет набор изменений, если создание стека завершится неудачно. Это допустимо только при установке параметра ChangeSetType в значение CREATE . Если удаление стека завершится неудачно, статус стека будет DELETE_FAILED .
  • DO_NOTHING - Если создание стека завершится неудачно, ничего не делать. Это эквивалентно указанию true для параметра DisableRollback операции API ExecuteChangeSet.
  • ROLLBACK - Если создание стека завершится неудачно, откатить стек. Это эквивалентно указанию false для параметра DisableRollback операции API ExecuteChangeSet.

ImportExistingResources -> (boolean)

Указывает, импортирует ли набор изменений ресурсы, которые уже существуют.

Примечание

Этот параметр может импортировать только ресурсы, которые имеют пользовательские имена в шаблонах. Чтобы импортировать ресурсы, которые не принимают пользовательские имена, такие как экземпляры EC2, используйте функцию импорта ресурсов.

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

Spec-Zone.ru

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