Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

describe-engine-default-cluster-parameters

Описание

Возвращает сведения о параметрах по умолчанию для движка и системы базы данных кластера.

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

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

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

Синтаксис

  describe-engine-default-cluster-parameters
--db-parameter-group-family <value>
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <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]

Параметры

--db-parameter-group-family (строка)

Имя семейства групп параметров DB-кластера, для которого необходимо вернуть сведения о параметрах движка.

--filters (список)

В настоящее время этот параметр не поддерживается.

(структура)

Пара имя-значение, используемый для возврата более конкретного списка результатов операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, например, идентификаторам. Поддерживаемые фильтрами операции describe документированы в описании операции.

Примечание

В настоящее время в фильтрах не поддерживаются подстановочные знаки.

Следующие действия можно отфильтровать:

  • DescribeDBClusterBacktracks
  • DescribeDBClusterEndpoints
  • DescribeDBClusters
  • DescribeDBInstances
  • DescribeDBRecommendations
  • DescribeDBShardGroups
  • DescribePendingMaintenanceActions

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.

(строка)

Сокращенный синтаксис:

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

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

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

Токен для указания точки начала постраничного вывода. Это NextToken из ранее усеченного ответа.

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

--page-size (целое число)

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

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя 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 (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 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.

Для описания параметров по умолчанию движка и системы для движка базы данных Aurora

Следующий пример describe-engine-default-cluster-parameters извлекает сведения о параметрах по умолчанию для движка и системы для кластеров баз данных Aurora с совместимостью MySQL 5.7.

aws rds describe-engine-default-cluster-parameters \
    --db-parameter-group-family aurora-mysql5.7

Вывод:

{
    "EngineDefaults": {
        "Parameters": [
            {
                "ParameterName": "aurora_load_from_s3_role",
                "Description": "IAM role ARN used to load data from AWS S3",
                "Source": "engine-default",
                "ApplyType": "dynamic",
                "DataType": "string",
                "IsModifiable": true,
                "SupportedEngineModes": [
                    "provisioned"
                ]
            },
            ...some output truncated...
        ]
    }
}

Дополнительную информацию см. в разделе Работа с группами параметров DB и группами параметров DB-кластера в Руководстве пользователя Amazon Aurora.

Вывод

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

Содержит результат успешного вызова действия DescribeEngineDefaultParameters.

DBParameterGroupFamily -> (строка)

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

Marker -> (строка)

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

Parameters -> (список)

Содержит список параметров по умолчанию движка.

(структура)

Этот тип данных используется в качестве параметра запроса в действиях ModifyDBParameterGroup и ResetDBParameterGroup.

Этот тип данных используется в качестве элемента ответа в действиях DescribeEngineDefaultParameters и DescribeDBParameters.

ParameterName -> (строка)

Имя параметра.

ParameterValue -> (строка)

Значение параметра.

Description -> (строка)

Предоставляет описание параметра.

Source -> (строка)

Источник значения параметра.

ApplyType -> (строка)

Указывает тип параметров, специфичных для движка.

DataType -> (строка)

Указывает допустимый тип данных для параметра.

AllowedValues -> (строка)

Указывает допустимый диапазон значений для параметра.

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

Указывает, можно (true) или нельзя (false) изменить параметр. Некоторые параметры имеют связанные с безопасностью или эксплуатацией последствия, которые препятствуют их изменению.

MinimumEngineVersion -> (строка)

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

ApplyMethod -> (строка)

Указывает, когда применять обновления параметров.

SupportedEngineModes -> (список)

Допустимые режимы работы DB-движка.

(строка)

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

Spec-Zone.ru

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