[ aws . elasticbeanstalk ]
describe-configuration-settings
Описание
Возвращает описание настроек указанного набора настроек, то есть шаблона конфигурации или набора конфигурации, связанного с работающей средой.
При описании настроек набора конфигурации, связанного с работающей средой, можно получить два набора описаний настроек. Один — это развернутый набор конфигурации, а другой — черновик конфигурации среды, которая либо находится в процессе развертывания, либо не смогла завершить развертывание.
Связанные темы
- DeleteEnvironmentConfiguration
См. также: Документация AWS API
Синтаксис
describe-configuration-settings
--application-name <value>
[--template-name <value>]
[--environment-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]
Параметры
--application-name (строка)
--template-name (строка)
Имя шаблона конфигурации, который необходимо описать.
Условие: Вы должны указать либо этот параметр, либо EnvironmentName, но не оба. Если вы укажете оба, AWS Elastic Beanstalk вернёт ошибку InvalidParameterCombination. Если вы не укажете ни тот, ни другой, AWS Elastic Beanstalk вернёт ошибку MissingRequiredParameter.
--environment-name (строка)
Имя среды для описания.
Условие: Вы должны указать либо этот параметр, либо TemplateName, но не оба. Если вы укажете оба, AWS Elastic Beanstalk вернёт ошибку InvalidParameterCombination. Если вы не укажете ни тот, ни другой, AWS Elastic Beanstalk вернёт ошибку MissingRequiredParameter.
--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
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определенного профиля из файла учетных данных.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/отключить цветной вывод.
- on
- off
- auto
--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-auto-prompt (булево)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров вам необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.
За исключением случаев, когда указано иное, все примеры используют правила цитирования, характерные для Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для просмотра настроек конфигурации среды
Следующая команда извлекает настройки конфигурации для среды с именем my-env:
aws elasticbeanstalk describe-configuration-settings --environment-name my-env --application-name my-app
Вывод (сокращённо):
{
"ConfigurationSettings": [
{
"ApplicationName": "my-app",
"EnvironmentName": "my-env",
"Description": "Environment created from the EB CLI using \"eb create\"",
"DeploymentStatus": "deployed",
"DateCreated": "2015-08-13T19:16:25Z",
"OptionSettings": [
{
"OptionName": "Availability Zones",
"ResourceName": "AWSEBAutoScalingGroup",
"Namespace": "aws:autoscaling:asg",
"Value": "Any"
},
{
"OptionName": "Cooldown",
"ResourceName": "AWSEBAutoScalingGroup",
"Namespace": "aws:autoscaling:asg",
"Value": "360"
},
...
{
"OptionName": "ConnectionDrainingTimeout",
"ResourceName": "AWSEBLoadBalancer",
"Namespace": "aws:elb:policies",
"Value": "20"
},
{
"OptionName": "ConnectionSettingIdleTimeout",
"ResourceName": "AWSEBLoadBalancer",
"Namespace": "aws:elb:policies",
"Value": "60"
}
],
"DateUpdated": "2015-08-13T23:30:07Z",
"SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8"
}
]
}
Дополнительную информацию о пространствах имен и поддерживаемых параметрах см. в разделе Значения параметров в Руководстве разработчика AWS Elastic Beanstalk.
Вывод
ConfigurationSettings -> (список)
Список ConfigurationSettingsDescription.
(структура)
Описание настроек набора конфигурации.
SolutionStackName -> (строка)
PlatformArn -> (строка)
ApplicationName -> (строка)
TemplateName -> (строка)
null, имя шаблона конфигурации для этого набора конфигурации.Description -> (строка)
EnvironmentName -> (строка)
null, имя среды для этого набора конфигурации.DeploymentStatus -> (строка)
Если этот набор конфигурации связан со средой, параметр DeploymentStatus указывает статус развертывания этого набора конфигурации:
-
null: Эта конфигурация не связана с работающей средой. -
pending: Это черновик конфигурации, который не развернут в связанной среде, но находится в процессе развертывания. -
deployed: Это конфигурация, которая в настоящее время развернута в связанной работающей среде. -
failed: Это черновик конфигурации, который не удалось успешно развернуть.
DateCreated -> (метка времени)
DateUpdated -> (метка времени)
OptionSettings -> (список)
Список параметров конфигурации и их значений в этом наборе конфигурации.
(структура)
Спецификация, определяющая отдельный параметр конфигурации вместе с его текущим значением. Список возможных пространств имен и значений параметров см. в разделе Значения параметров в Руководстве разработчика AWS Elastic Beanstalk.
ResourceName -> (строка)
Namespace -> (строка)
OptionName -> (строка)
Value -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|