Spec-Zone.ru › AWS CLI v2

[ aws . redshift ]

describe-cluster-security-groups

Описание

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

Дополнительную информацию об управлении группами безопасности см. в разделе Amazon Redshift Cluster Security Groups руководства Amazon Redshift Cluster Management Guide.

Если в одном запросе указаны как ключи тегов, так и значения тегов, Amazon Redshift возвращает все группы безопасности, соответствующие любому сочетанию указанных ключей и значений. Например, если для ключей тегов указаны owner и environment, а для значений тегов — admin и test, возвращаются все группы безопасности, имеющие любое сочетание этих значений.

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

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

describe-cluster-security-groups — это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: ClusterSecurityGroups

Синтаксис

  describe-cluster-security-groups
[--cluster-security-group-name <value>]
[--tag-keys <value>]
[--tag-values <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]

Параметры

--cluster-security-group-name (строка)

Имя группы безопасности кластера, для которого запрашиваются сведения. Вы должны указать либо параметр Marker, либо параметр ClusterSecurityGroupName, но не оба.

Пример: securitygroup1

--tag-keys (список)

Ключ или ключи тега, для которых вы хотите получить все соответствующие группы безопасности кластера, связанные с указанным ключом или ключами. Например, предположим, что у вас есть группы безопасности, помеченные ключами owner и environment. Если вы укажете оба этих ключа тега в запросе, Amazon Redshift вернёт ответ с группами безопасности, у которых есть либо один, либо оба этих ключа тега.

(строка)

Синтаксис:

"string" "string" ...

--tag-values (список)

Значение или значения тега, для которых вы хотите получить все соответствующие группы безопасности кластера, связанные с указанным значением или значениями тега. Например, предположим, что у вас есть группы безопасности, помеченные значениями admin и test. Если вы укажете оба этих значения тега в запросе, Amazon Redshift вернёт ответ с группами безопасности, у которых есть либо одно, либо оба этих значения тега.

(строка)

Синтаксис:

"string" "string" ...

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

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

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

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

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

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

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

--max-items (целое число)

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.

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

--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 (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

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

Получение описания всех групп безопасности кластера

В этом примере возвращается описание всех групп безопасности кластера для учётной записи. По умолчанию вывод находится в формате JSON.

Команда:

aws redshift describe-cluster-security-groups

Результат:

{
   "ClusterSecurityGroups": [
      {
         "OwnerId": "100447751468",
         "Description": "default",
         "ClusterSecurityGroupName": "default",
         "EC2SecurityGroups": \[],
         "IPRanges": [
            {
               "Status": "authorized",
               "CIDRIP": "0.0.0.0/0"
            }
         ]
      },
      {
         "OwnerId": "100447751468",
         "Description": "This is my cluster security group",
         "ClusterSecurityGroupName": "mysecuritygroup",
         "EC2SecurityGroups": \[],
         "IPRanges": \[]
      },
      (...remaining output omitted...)
   ]
}

Вывод

Маркер -> (строка)

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

ClusterSecurityGroups -> (список)

Список экземпляров ClusterSecurityGroup.

(структура)

Описание группы безопасности.

ClusterSecurityGroupName -> (строка)

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

Описание -> (строка)

Описание группы безопасности.

EC2SecurityGroups -> (список)

Список групп безопасности EC2, которым разрешен доступ к кластерам, связанным с этой группой безопасности кластера.

(структура)

Описание группы безопасности Amazon EC2.

Статус -> (строка)

Статус группы безопасности EC2.

EC2SecurityGroupName -> (строка)

Имя группы безопасности EC2.

EC2SecurityGroupOwnerId -> (строка)

Идентификатор учётной записи Amazon Web Services владельца группы безопасности EC2, указанной в поле EC2SecurityGroupName.

Теги -> (список)

Список тегов для группы безопасности EC2.

(структура)

Тег, состоящий из пары имя/значение для ресурса.

Ключ -> (строка)

Ключ или имя тега ресурса.

Значение -> (строка)

Значение тега ресурса.

IPRanges -> (список)

Список диапазонов IP-адресов (блоков CIDR), которым разрешен доступ к кластерам, связанным с этой группой безопасности кластера.

(структура)

Описание диапазона IP-адресов, используемого в группе безопасности.

Статус -> (строка)

Статус диапазона IP-адресов, например, «разрешено».

CIDRIP -> (строка)

Диапазон IP-адресов в нотации CIDR (Classless Inter-Domain Routing).

Теги -> (список)

Список тегов для диапазона IP-адресов.

(структура)

Тег, состоящий из пары имя/значение для ресурса.

Ключ -> (строка)

Ключ или имя тега ресурса.

Значение -> (строка)

Значение тега ресурса.

Теги -> (список)

Список тегов для группы безопасности кластера.

(структура)

Тег, состоящий из пары имя/значение для ресурса.

Ключ -> (строка)

Ключ или имя тега ресурса.

Значение -> (строка)

Значение тега ресурса.

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

Spec-Zone.ru

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