describe-stack-set-operation

Описание

Возвращает описание указанной операции StackSet.

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

Синтаксис

  describe-stack-set-operation
--stack-set-name <value>
--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 (строка)

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

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

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

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

Включает отладку регистрации.

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

Примеры

Примечание

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

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

Для получения информации об операции набора стеков

В следующем примере describe-stack-set-operation` отображаются данные для операции обновления указанного набора стеков.

aws cloudformation describe-stack-set-operation \
    --stack-set-name enable-config \
    --operation-id 35d45ebc-ed88-xmpl-ab59-0197a1fc83a0

Вывод:

{
    "StackSetOperation": {
        "OperationId": "35d45ebc-ed88-xmpl-ab59-0197a1fc83a0",
        "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743",
        "Action": "UPDATE",
        "Status": "SUCCEEDED",
        "OperationPreferences": {
            "RegionOrder": [
                "us-east-1",
                "us-west-2",
                "eu-west-1",
                "us-west-1"
            ],
            "FailureToleranceCount": 7,
            "MaxConcurrentCount": 2
        },
        "AdministrationRoleARN": "arn:aws:iam::123456789012:role/AWSCloudFormationStackSetAdministrationRole",
        "ExecutionRoleName": "AWSCloudFormationStackSetExecutionRole",
        "CreationTimestamp": "2019-10-03T16:28:44.377Z",
        "EndTimestamp": "2019-10-03T16:42:08.607Z"
    }
}

Вывод

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

Указанная операция над набором стеков.

OperationId -> (строка)

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

StackSetId -> (строка)

Идентификатор набора стеков.

Action -> (строка)

Тип операции над набором стеков: CREATE , UPDATE , или DELETE . Операции создания и удаления влияют только на указанные экземпляры стеков, связанные с указанным набором стеков. Операции обновления влияют как на сам набор стеков, так и на все связанные экземпляры стеков.

Status -> (строка)

Статус операции.

FAILED : Операция превысила заданную толерантность к ошибкам. Значение толерантности к ошибкам, которое вы установили для операции, применяется для каждой Региональной зоны при операциях создания и обновления стеков. Если количество неудачных стеков в Региональной зоне превышает толерантность к ошибкам, статус операции в этой Региональной зоне устанавливается в FAILED . Это, в свою очередь, устанавливает статус операции в целом в FAILED , и CloudFormation отменяет операцию во всех оставшихся Региональных зонах.
QUEUED : [Права, управляемые службой] Для автоматических развертываний, которые требуют последовательности операций, операция помещается в очередь для выполнения. Дополнительную информацию см. в кодах статуса StackSets в Руководстве пользователя CloudFormation.
RUNNING : Операция в настоящее время выполняется.
STOPPED : Пользователь отменил операцию.
STOPPING : Операция находится в процессе остановки по запросу пользователя.
SUCCEEDED : Операция завершила создание или обновление всех указанных стеков без превышения толерантности к ошибкам для операции.

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

Предпочтения по тому, как 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 , независимо от количества неудач.

RetainStacks -> (логическое значение)

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

AdministrationRoleARN -> (строка)

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

Используйте настраиваемые роли администратора для управления тем, какие пользователи или группы могут управлять определёнными наборами стеков в одной учётной записи администратора. Дополнительную информацию см. в разделе Настройка прав доступа в Руководстве пользователя CloudFormation.

ExecutionRoleName -> (строка)

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

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

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

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

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

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

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

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

Accounts -> (список)

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

(строка)

AccountsUrl -> (строка)

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

OrganizationalUnitIds -> (список)

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

(строка)

AccountFilterType -> (строка)

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

Следующее — список возможных значений для операции AccountFilterType .

INTERSECTION : StackSets выполняет развертывание в аккаунтах, указанных в параметре Accounts .
DIFFERENCE : StackSets исключает аккаунты, указанные в параметре Accounts . Это позволяет пользователям избегать определённых аккаунтов в OU, таких как приостановленные аккаунты.
UNION : StackSets включает дополнительные целевые аккаунты для развертывания. Это значение по умолчанию, если не указано AccountFilterType . Это позволяет пользователям обновлять всё OU и отдельные аккаунты из другого OU в одном запросе, что раньше требовало двух отдельных запросов.
NONE : Выполняет развертывание во все аккаунты в указанных организационных подразделениях (OU).

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

Подробная информация о состоянии дрейфа набора стеков. Включает информацию об операциях дрейфа, выполняемых в данный момент для набора стеков.

Эта информация будет присутствовать только для операций с набором стеков, тип которых является Action.

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

DriftStatus -> (string)

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

DRIFTED : Один или несколько экземпляров стеков, принадлежащих набору стеков, отличаются от ожидаемой конфигурации шаблона и параметров. Экземпляр стека считается подверженным дрейфу, если один или несколько ресурсов в связанном стеке отклонились.
NOT_CHECKED : CloudFormation не проверял набор стеков на дрейф.
IN_SYNC : Все экземпляры стеков, принадлежащие набору стеков, соответствуют ожидаемой конфигурации шаблона и параметров.

DriftDetectionStatus -> (string)

Статус операции обнаружения дрейфа набора стеков.

COMPLETED : Операция обнаружения дрейфа завершилась без ошибок на каких-либо экземплярах стеков.
FAILED : Операция обнаружения дрейфа превысила заданную допустимую погрешность.
PARTIAL_SUCCESS : Операция обнаружения дрейфа завершилась без превышения допустимой погрешности для операции.
IN_PROGRESS : В настоящее время выполняется операция обнаружения дрейфа.
STOPPED : Пользователь отменил операцию обнаружения дрейфа.

LastDriftCheckTimestamp -> (timestamp)

Самое последнее время, когда CloudFormation выполнил операцию обнаружения дрейфа для набора стеков. Это значение будет NULL для любого набора стеков, для которого еще не выполнено обнаружение дрейфа.

TotalStackInstancesCount -> (integer)

Общее количество экземпляров стеков, принадлежащих этому набору стеков.

Общее число экземпляров стеков равно сумме:

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

DriftedStackInstancesCount -> (integer)

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

InSyncStackInstancesCount -> (integer)

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

InProgressStackInstancesCount -> (integer)

Количество экземпляров стеков, которые в настоящее время проверяются на дрейф.

FailedStackInstancesCount -> (integer)

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

StatusReason -> (string)

Подробное описание статуса операции.

StatusDetails -> (structure)

Подробная информация об операции StackSet.

FailedStackInstancesCount -> (integer)

Количество экземпляров стеков, для которых операция StackSet завершилась ошибкой.