get-cluster-credentials

Описание

Возвращает имя пользователя базы данных и временный пароль с временным разрешением для входа в базу данных Amazon Redshift. Действие возвращает имя пользователя базы данных с префиксом IAM:, если AutoCreate равно False, или IAMA:, если AutoCreate равно True. Вы можете необязательно указать один или несколько групп пользователей базы данных, к которым пользователь присоединится при входе. По умолчанию временные учетные данные истекают через 900 секунд. Вы можете необязательно указать период от 900 секунд (15 минут) до 3600 секунд (60 минут). Дополнительную информацию см. в руководстве по управлению кластером Amazon Redshift в разделе Использование аутентификации IAM для генерации учетных данных пользователя базы данных.

Пользователь или роль Identity and Access Management (IAM), выполняющие GetClusterCredentials, должны иметь прикреплённую политику IAM, разрешающую доступ ко всем необходимым действиям и ресурсам. Дополнительную информацию о разрешениях см. в руководстве по управлению кластером Amazon Redshift в разделе Политики ресурсов для GetClusterCredentials.

Если параметр DbGroups указан, политика IAM должна разрешать действие redshift:JoinGroup с доступом к указанным ресурсам dbgroups.

Кроме того, если параметр AutoCreate установлен в значение True, политика должна включать разрешение redshift:CreateClusterUser.

Если параметр DbName указан, политика IAM должна разрешать доступ к ресурсу dbname для указанного имени базы данных.

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

Синтаксис

  get-cluster-credentials
--db-user <value>
[--db-name <value>]
[--cluster-identifier <value>]
[--duration-seconds <value>]
[--auto-create | --no-auto-create]
[--db-groups <value>]
[--custom-domain-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]

Параметры

--db-user (строка)

--db-name (строка)

--cluster-identifier (строка)

--duration-seconds (целое число)

--auto-create | --no-auto-create (булево)

--db-groups (список)

Синтаксис:

"string" "string" ...

--custom-domain-name (строка)

--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 (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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Получение учетных данных кластера для учётной записи AWS

Следующий пример get-cluster-credentials получает временные учетные данные, предоставляющие доступ к базе данных Amazon Redshift.

aws redshift get-cluster-credentials \
    --db-user adminuser --db-name dev \
    --cluster-identifier mycluster

Вывод:

{
    "DbUser": "IAM:adminuser",
    "DbPassword": "AMAFUyyuros/QjxPTtgzcsuQsqzIasdzJEN04aCtWDzXx1O9d6UmpkBtvEeqFly/EXAMPLE==",
    "Expiration": "2019-12-10T17:25:05.770Z"
}

Дополнительную информацию см. в разделе Генерация учетных данных базы данных IAM с помощью Amazon Redshift CLI или API в руководстве по управлению кластерами Amazon Redshift.

Вывод

DbUser -> (строка)

DbPassword -> (строка)

Expiration -> (метка времени)