[ aws . elasticache ]
describe-cache-subnet-groups
Описание
Возвращает список описаний групп подсетей кэша. Если указано имя группы подсетей, список содержит только описание этой группы. Это применимо только при настройке ElastiCache в VPC. Все кластеры ElastiCache теперь запускаются в VPC по умолчанию.
См. также: Документация AWS API
describe-cache-subnet-groups — это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: CacheSubnetGroups
Синтаксис
describe-cache-subnet-groups
[--cache-subnet-group-name <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]
Параметры
--cache-subnet-group-name (строка)
--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.
Для описания групп подсетей кэша
Следующий пример describe-cache-subnet-groups возвращает список групп подсетей.
aws elasticache describe-cache-subnet-groups
Вывод:
{
"CacheSubnetGroups": [
{
"CacheSubnetGroupName": "default",
"CacheSubnetGroupDescription": "Default CacheSubnetGroup",
"VpcId": "vpc-a3e97cdb",
"Subnets": [
{
"SubnetIdentifier": "subnet-8d4bacf5",
"SubnetAvailabilityZone": {
"Name": "us-west-2b"
}
},
{
"SubnetIdentifier": "subnet-dde21380",
"SubnetAvailabilityZone": {
"Name": "us-west-2c"
}
},
{
"SubnetIdentifier": "subnet-6485ec4f",
"SubnetAvailabilityZone": {
"Name": "us-west-2d"
}
},
{
"SubnetIdentifier": "subnet-b4ebebff",
"SubnetAvailabilityZone": {
"Name": "us-west-2a"
}
}
]
},
{
"CacheSubnetGroupName": "kxkxk",
"CacheSubnetGroupDescription": "mygroup",
"VpcId": "vpc-a3e97cdb",
"Subnets": [
{
"SubnetIdentifier": "subnet-b4ebebff",
"SubnetAvailabilityZone": {
"Name": "us-west-2a"
}
}
]
},
{
"CacheSubnetGroupName": "test",
"CacheSubnetGroupDescription": "test",
"VpcId": "vpc-a3e97cdb",
"Subnets": [
{
"SubnetIdentifier": "subnet-b4ebebff",
"SubnetAvailabilityZone": {
"Name": "us-west-2a"
}
}
]
}
]
}
Дополнительную информацию см. в разделе Подсети и группы подсетей в Руководстве пользователя Elasticache или Подсети и группы подсетей в Руководстве пользователя ElastiCache для Memcached.
Вывод
Marker -> (строка)
CacheSubnetGroups -> (список)
Список групп подсетей кэша. Каждый элемент списка содержит подробную информацию об одной группе.
(структура)
Представляет результат одной из следующих операций:
CreateCacheSubnetGroupModifyCacheSubnetGroup
CacheSubnetGroupName -> (строка)
CacheSubnetGroupDescription -> (строка)
VpcId -> (строка)
Subnets -> (список)
Список подсетей, связанных с группой подсетей кэша.
(структура)
Представляет подсеть, связанную с кластером. Этот параметр относится к подсетям, определённым в Amazon Virtual Private Cloud (Amazon VPC) и используемым с ElastiCache.
SubnetIdentifier -> (строка)
SubnetAvailabilityZone -> (структура)
Доступная зона, связанная с подсетью.
Name -> (строка)
SubnetOutpost -> (структура)
ARN узла размещения подсети.
SubnetOutpostArn -> (строка)
SupportedNetworkTypes -> (список)
Либо ipv4 | ipv6 | dual_stack. IPv6 поддерживается для рабочих нагрузок с Valkey 7.2 и выше, Redis OSS engine версии 6.2 до 7.1 или Memcached engine версии 1.6.6 и выше на всех экземплярах, созданных на системе Nitro.
(строка)
ARN -> (строка)
SupportedNetworkTypes -> (список)
Либо ipv4 | ipv6 | dual_stack. IPv6 поддерживается для рабочих нагрузок с Valkey 7.2 и выше, Redis OSS engine версии 6.2 до 7.1 или Memcached engine версии 1.6.6 и выше на всех экземплярах, созданных на системе Nitro.
(строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|