Spec-Zone.ru › AWS CLI v2

[ aws . opsworks ]

describe-stacks

Описание

Запрашивает описание одного или нескольких стеков.

Требуемые разрешения : Для использования этого действия пользователь IAM должен иметь уровень разрешений «Показать», «Развернуть» или «Управлять» для стека или прикреплённый политику, которая явно предоставляет разрешения. Дополнительную информацию о разрешениях пользователей см. в разделе Управление разрешениями пользователей .

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

Синтаксис

  describe-stacks
[--stack-ids <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-ids (список)

Массив идентификаторов стеков, определяющих стеки, которые должны быть описаны. Если вы опустите этот параметр и имеете разрешения на получение информации обо всех стеках, DescribeStacks возвращает описание каждого стека. Если политика IAM, прикрепленная к пользователю IAM, ограничивает действие DescribeStacks определёнными ARN стеков, этот параметр требуется, и пользователь должен указать ARN стека, разрешённый политикой. В противном случае, DescribeStacks возвращает ошибку AccessDenied.

(строка)

Синтаксис:

"string" "string" ...

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

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

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

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

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

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

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

Примеры

Примечание

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

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

Для описания стеков

Следующая describe-stacks команда описывает стеки учётной записи.

aws opsworks --region us-east-1 describe-stacks

Вывод:

{
  "Stacks": [
    {
      "ServiceRoleArn": "arn:aws:iam::444455556666:role/aws-opsworks-service-role",
      "StackId": "aeb7523e-7c8b-49d4-b866-03aae9d4fbcb",
      "DefaultRootDeviceType": "instance-store",
      "Name": "TomStack-sd",
      "ConfigurationManager": {
        "Version": "11.4",
        "Name": "Chef"
      },
      "UseCustomCookbooks": true,
      "CustomJson": "{\n\"tomcat\": {\n\"base_version\": 7,\n\"java_opts\": \"-Djava.awt.headless=true -Xmx256m\"\n  },\n\"datasources\": {\n\"ROOT\": \"jdbc/mydb\"\n  }\n}",
      "Region": "us-east-1",
      "DefaultInstanceProfileArn": "arn:aws:iam::444455556666:instance-profile/aws-opsworks-ec2-role",
      "CustomCookbooksSource": {
        "Url": "git://github.com/example-repo/tomcustom.git",
        "Type": "git"
      },
      "DefaultAvailabilityZone": "us-east-1a",
      "HostnameTheme": "Layer_Dependent",
      "Attributes": {
        "Color": "rgb(45, 114, 184)"
      },
      "DefaultOs": "Amazon Linux",
      "CreatedAt": "2013-08-01T22:53:42+00:00"
    },
    {
      "ServiceRoleArn": "arn:aws:iam::444455556666:role/aws-opsworks-service-role",
      "StackId": "40738975-da59-4c5b-9789-3e422f2cf099",
      "DefaultRootDeviceType": "instance-store",
      "Name": "MyStack",
      "ConfigurationManager": {
        "Version": "11.4",
        "Name": "Chef"
      },
      "UseCustomCookbooks": false,
      "Region": "us-east-1",
      "DefaultInstanceProfileArn": "arn:aws:iam::444455556666:instance-profile/aws-opsworks-ec2-role",
      "CustomCookbooksSource": {},
      "DefaultAvailabilityZone": "us-east-1a",
      "HostnameTheme": "Layer_Dependent",
      "Attributes": {
        "Color": "rgb(45, 114, 184)"
      },
      "DefaultOs": "Amazon Linux",
      "CreatedAt": "2013-10-25T19:24:30+00:00"
    }
  ]
}

Дополнительная информация

Дополнительную информацию см. в разделе «Стеки» в Руководстве пользователя AWS OpsWorks.

Выходные данные

Stacks -> (список)

Массив объектов Stack, описывающих стеки.

(структура)

Описание стека.

StackId -> (строка)

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

Name -> (строка)

Имя стека. Имена стеков могут содержать не более 64 символов.

Arn -> (строка)

ARN стека.

Region -> (строка)

Регион Amazon Web Services стека, например, ap-northeast-2. Для получения дополнительной информации о регионах Amazon Web Services см. Regions and Endpoints.

VpcId -> (строка)

Идентификатор VPC; применимо только в том случае, если стек работает в VPC.

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

Атрибуты стека.

key -> (строка)

value -> (строка)

ServiceRoleArn -> (строка)

Роль управления доступом и идентификацией (IAM) стека.

DefaultInstanceProfileArn -> (строка)

ARN профиля IAM, который является профилем по умолчанию для всех EC2-инстансов стека. Для получения дополнительной информации об ARN IAM см. Using Identifiers.

DefaultOs -> (строка)

Операционная система стека по умолчанию.

HostnameTheme -> (строка)

Тема имени хоста стека, с пробелами, заменёнными на нижние подчёркивания.

DefaultAvailabilityZone -> (строка)

По умолчанию зона доступности стека. Для получения дополнительной информации см. Regions and Endpoints.

DefaultSubnetId -> (строка)

Идентификатор подсети по умолчанию; применимо только в том случае, если стек работает в VPC.

CustomJson -> (строка)

Объект JSON, содержащий пользовательские атрибуты, которые необходимо добавить в конфигурацию и атрибуты развертывания стека. Вы можете использовать пользовательский JSON для переопределения соответствующих значений атрибутов конфигурации стека по умолчанию или для передачи данных в рецепты. Строка должна иметь следующий формат:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

Дополнительную информацию о пользовательском JSON см. Use Custom JSON to Modify the Stack Configuration Attributes.

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

Менеджер конфигурации.

Name -> (строка)

Имя. Этот параметр должен быть установлен в значение Chef.

Version -> (строка)

Версия Chef. Этот параметр должен быть установлен в значение 12, 11.10 или 11.4 для Linux-стеков и в значение 12.2 для Windows-стеков. Значение по умолчанию для Linux-стеков — 12.

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

Объект ChefConfiguration, определяющий, следует ли включить Berkshelf и версию Berkshelf. Для получения дополнительной информации см. Create a New Stack.

ManageBerkshelf -> (булево)

Включить Berkshelf.

BerkshelfVersion -> (строка)

Версия Berkshelf.

UseCustomCookbooks -> (булево)

Использовать пользовательские кулинарные книги.

UseOpsworksSecurityGroups -> (булево)

Автоматически ассоциировать встроенные группы безопасности OpsWorks Stacks со слоями стека.

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

Содержит информацию, необходимую для получения приложения или кулинарной книги из репозитория. Для получения дополнительной информации см. Adding Apps or Cookbooks and Recipes.

Type -> (строка)

Тип репозитория.

Url -> (строка)

URL источника. Пример URL источника Amazon S3: https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz.

Username -> (строка)

Этот параметр зависит от типа репозитория.

  • Для пакетов Amazon S3 установите Username в соответствующий идентификатор ключа доступа IAM.
  • Для пакетов HTTP, Git-репозиториев и репозиториев Subversion установите Username в имя пользователя.

Password -> (строка)

Если параметр включён в запрос, он зависит от типа репозитория.

  • Для пакетов Amazon S3 установите Password в соответствующий секретный ключ доступа IAM.
  • Для пакетов HTTP и репозиториев Subversion установите Password в пароль.

Дополнительную информацию о безопасном обращении с учетными данными IAM см. в https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.

В ответах OpsWorks Stacks возвращается *****FILTERED***** вместо фактического значения.

SshKey -> (строка)

В запросах — SSH-ключ репозитория.

В ответах OpsWorks Stacks возвращается *****FILTERED***** вместо фактического значения.

Revision -> (строка)

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

DefaultSshKeyName -> (строка)

Ключ пары EC2 Amazon по умолчанию для экземпляров стека. Вы можете переопределить это значение при создании или обновлении экземпляра.

CreatedAt -> (строка)

Дата создания стека.

DefaultRootDeviceType -> (строка)

Тип корневого устройства по умолчанию. Это значение используется по умолчанию для всех экземпляров в стеке, но вы можете переопределить его при создании экземпляра. Дополнительную информацию см. в разделе Storage for the Root Device.

AgentVersion -> (строка)

Версия агента. Этот параметр установлен в значение LATEST для автоматического обновления или номер версии для фиксированной версии агента.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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