[ aws . redshift-serverless ]
get-credentials
Описание
Возвращает имя пользователя базы данных и временный пароль с временным разрешением для входа в Amazon Redshift Serverless.
По умолчанию временные учетные данные истекают через 900 секунд. Вы можете указать продолжительность от 900 секунд (15 минут) до 3600 секунд (60 минут).
Пользователь или роль управления идентификацией и доступом (IAM), которые выполняют GetCredentials, должны иметь прикреплённую политику IAM, разрешающую доступ ко всем необходимым действиям и ресурсам.
Если указан параметр DbName, политика IAM должна разрешать доступ к ресурсу dbname для указанного имени базы данных.
См. также: Документацию API AWS
Синтаксис
get-credentials
[--custom-domain-name <value>]
[--db-name <value>]
[--duration-seconds <value>]
[--workgroup-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]
Параметры
--custom-domain-name (строка)
--db-name (строка)
Имя базы данных, для которой требуется получить временное разрешение на вход.
Ограничения:
- Должно содержать от 1 до 64 буквенно-цифровых символов или дефисов.
- Должно содержать только заглавные или строчные буквы, цифры, знак подчеркивания, знак плюс, точку (.), символ @ или дефис.
- Первый символ должен быть буквой.
- Не должно содержать двоеточие (:) или косую черту (/).
- Не может быть зарезервированным словом. Список зарезервированных слов можно найти в Руководстве разработчика баз данных Amazon Redshift в разделе Зарезервированные слова.
--duration-seconds (целое число)
--workgroup-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 (целое число)
Максимальное время чтения сокета в секундах. Если значение равно 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.
Вывод
dbPassword -> (строка)
DbUser, вход в базу данных DbName.dbUser -> (строка)
DbName с помощью пароля DbPassword. Если указанный DbUser существует в базе данных, новое имя пользователя имеет те же привилегии базы данных, что и пользователь, указанный в DbUser. По умолчанию пользователь добавляется в PUBLIC.expiration -> (метка времени)
DbPassword.nextRefreshTime -> (метка времени)
DbUser и DbPassword авторизации.
© Copyright 2025, Amazon Web Services. Created using Sphinx.