get-connection

Описание

Извлекает определение подключения из каталога данных.

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

Синтаксис

  get-connection
[--catalog-id <value>]
--name <value>
[--hide-password | --no-hide-password]
[--apply-override-for-compute-environment <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]

Параметры

--catalog-id (строка)

Идентификатор каталога данных, в котором находится подключение. Если не указано, используется идентификатор учетной записи Amazon Web Services по умолчанию.

--name (строка)

Имя определения подключения для извлечения.

--hide-password | --no-hide-password (логическое значение)

Позволяет извлечь метаданные подключения без возвращения пароля. Например, консоль Glue использует этот флаг для извлечения подключения и не отображает пароль. Установите этот параметр, когда у вызывающего объекта может не быть разрешения на использование ключа KMS для расшифровки пароля, но есть разрешение на доступ к остальным свойствам подключения.

--apply-override-for-compute-environment (строка)

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

Возможные значения:

SPARK
ATHENA
PYTHON

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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.

Вывод

Подключение -> (структура)

Запрашиваемое определение подключения.

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

Имя определения подключения.

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

Описание подключения.

ТипПодключения -> (строка)

Тип подключения. В настоящее время SFTP не поддерживается.

КритерииСоответствия -> (список)

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

(строка)

СвойстваПодключения -> (карта)

Эти пары ключ-значение определяют параметры для подключения при использовании схемы подключения версии 1:

HOST - URI хоста: либо полное доменное имя (FQDN), либо IPv4-адрес хоста базы данных.
PORT - Номер порта, от 1024 до 65535, порта, на котором хост базы данных слушает подключения к базе данных.
USER_NAME - Имя для входа в базу данных. Строковое значение для USER_NAME равно “USERNAME”.
PASSWORD - Пароль, если он используется, для имени пользователя.
ENCRYPTED_PASSWORD - Если защита паролем подключения включена путем настройки ConnectionPasswordEncryption в настройках шифрования каталога данных, это поле хранит зашифрованный пароль.
JDBC_DRIVER_JAR_URI - Путь Amazon Simple Storage Service (Amazon S3) к JAR-файлу, содержащему JDBC-драйвер для использования.
JDBC_DRIVER_CLASS_NAME - Имя класса JDBC-драйвера для использования.
JDBC_ENGINE - Имя JDBC-движка для использования.
JDBC_ENGINE_VERSION - Версия JDBC-движка для использования.
CONFIG_FILES - (Зарезервировано для будущего использования.)
INSTANCE_ID - Идентификатор экземпляра для использования.
JDBC_CONNECTION_URL - URL для подключения к источнику данных JDBC.
JDBC_ENFORCE_SSL - Строка булевого значения (true, false), указывающая, включено ли Secure Sockets Layer (SSL) с соответствием имени хоста для JDBC-подключения на клиенте. По умолчанию — false.
CUSTOM_JDBC_CERT - Местоположение Amazon S3, указывающее корневой сертификат клиента. Glue использует этот корневой сертификат для проверки сертификата клиента при подключении к базе данных клиента. Glue обрабатывает только сертификаты X.509. Предоставленный сертификат должен быть закодирован в DER и предоставлен в формате Base64 кодирования PEM.
SKIP_CUSTOM_JDBC_CERT_VALIDATION - По умолчанию это false . Glue проверяет алгоритм подписи и алгоритм алгоритма открытого ключа субъекта для сертификата клиента. Допускаются только алгоритмы SHA256withRSA, SHA384withRSA или SHA512withRSA для алгоритма подписи. Для алгоритма открытого ключа субъекта длина ключа должна быть не менее 2048. Вы можете установить значение этого свойства на true, чтобы пропустить проверку Glue сертификата клиента.
CUSTOM_JDBC_CERT_STRING - Пользовательская строка сертификата JDBC, используемая для сопоставления домена или имени, чтобы предотвратить атаку «человек посередине». В базе данных Oracle это используется как SSL_SERVER_CERT_DN; в Microsoft SQL Server это используется как hostNameInCertificate.
CONNECTION_URL - URL для подключения к общему (не-JDBC) источнику данных.
SECRET_ID - Идентификатор секрета, используемый для менеджера секретов учетных данных.
CONNECTOR_URL - URL коннектора для подключения MARKETPLACE или CUSTOM.
CONNECTOR_TYPE - Тип коннектора для подключения MARKETPLACE или CUSTOM.
CONNECTOR_CLASS_NAME - Имя класса коннектора для подключения MARKETPLACE или CUSTOM.
KAFKA_BOOTSTRAP_SERVERS - Список, разделенный запятыми, пар хост и порт, которые являются адресами брокеров Apache Kafka в кластере Kafka, к которому клиент Kafka подключится и инициализирует себя.
KAFKA_SSL_ENABLED - Включить или выключить SSL на подключении Apache Kafka. Значение по умолчанию — “true”.
KAFKA_CUSTOM_CERT - URL Amazon S3 для файла сертификата частной центральной авторизации (.pem-формат). Значение по умолчанию — пустая строка.
KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Пропустить ли проверку файла сертификата центральной авторизации. Glue проверяет три алгоритма: SHA256withRSA, SHA384withRSA и SHA512withRSA. Значение по умолчанию — “false”.
KAFKA_CLIENT_KEYSTORE - Местоположение Amazon S3 файла хранилища ключей клиента для проверки подлинности клиента Kafka (необязательно).
KAFKA_CLIENT_KEYSTORE_PASSWORD - Пароль для доступа к предоставленному хранилищу ключей (необязательно).
KAFKA_CLIENT_KEY_PASSWORD - Хранилище ключей может состоять из нескольких ключей, поэтому это пароль для доступа к клиенту ключу, который будет использоваться с ключом сервера Kafka (необязательно).
ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - Зашифрованная версия пароля хранилища ключей клиента Kafka (если пользователь выбрал настройку шифрования паролей Glue).
ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - Зашифрованная версия пароля ключа клиента Kafka (если пользователь выбрал настройку шифрования паролей Glue).
KAFKA_SASL_MECHANISM - "SCRAM-SHA-512", "GSSAPI", "AWS_MSK_IAM" или "PLAIN". Это поддерживаемые механизмы SASL.
KAFKA_SASL_PLAIN_USERNAME - Открытый текст имени пользователя, используемый для аутентификации с механизмом «PLAIN».
KAFKA_SASL_PLAIN_PASSWORD - Открытый текст пароля, используемый для аутентификации с механизмом «PLAIN».
ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD - Зашифрованная версия пароля SASL PLAIN Kafka (если пользователь выбрал настройку шифрования паролей Glue).
KAFKA_SASL_SCRAM_USERNAME - Открытый текст имени пользователя, используемый для аутентификации с механизмом «SCRAM-SHA-512».
KAFKA_SASL_SCRAM_PASSWORD - Открытый текст пароля, используемый для аутентификации с механизмом «SCRAM-SHA-512».
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - Зашифрованная версия пароля SASL SCRAM Kafka (если пользователь выбрал настройку шифрования паролей Glue).
KAFKA_SASL_SCRAM_SECRETS_ARN - Имя ресурса Amazon в Amazon Web Services Secrets Manager.
KAFKA_SASL_GSSAPI_KEYTAB - Местоположение S3 файла Kerberos keytab. Keytab хранит долгосрочные ключи для одного или нескольких принципов. Дополнительная информация в документации MIT Kerberos: Keytab.
KAFKA_SASL_GSSAPI_KRB5_CONF - Местоположение S3 файла Kerberos krb5.conf. Krb5.conf хранит информацию о конфигурации Kerberos, такую как местоположение сервера KDC. Дополнительная информация в документации MIT Kerberos: krb5.conf.
KAFKA_SASL_GSSAPI_SERVICE - Имя Kerberos-службы, заданное с sasl.kerberos.service.name в вашей конфигурации Kafka.
KAFKA_SASL_GSSAPI_PRINCIPAL - Имя Kerberos-принципала, используемого Glue. Дополнительная информация в документации Kafka: Настройка брокеров Kafka.
ROLE_ARN - Роль, используемая для выполнения запросов.
REGION - Регион Amazon Web Services, в котором будут выполняться запросы.
WORKGROUP_NAME - Имя бессерверной группы рабочих мест Amazon Redshift или группы рабочих мест Amazon Athena, в которой будут выполняться запросы.
CLUSTER_IDENTIFIER - Идентификатор кластера Amazon Redshift кластера, в котором будут выполняться запросы.
DATABASE - База данных Amazon Redshift, к которой вы подключаетесь.

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

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

СвойстваSpark -> (карта)

Свойства подключения, специфичные для среды вычислений Spark.

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

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

СвойстваAthena -> (карта)

Свойства подключения, специфичные для среды вычислений Athena.

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

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

СвойстваPython -> (карта)

Свойства подключения, специфичные для среды вычислений Python.

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

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

ТребованияФизическогоПодключения -> (структура)

Требования к физическому подключению, такие как виртуальная частная сеть (VPC) и SecurityGroup, которые необходимы для успешного подключения.

ИдентификаторПодсети -> (строка)

Идентификатор подсети, используемой подключением.

СписокИдентификаторовГруппыБезопасности -> (список)

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

(строка)

ЗонаДоступности -> (строка)

Зона доступности подключения.

ВремяСоздание -> (метка времени)

Отметка времени создания этого определения подключения.

ВремяПоследнегоОбновления -> (метка времени)

Отметка времени последнего обновления определения подключения.

ПоследнееОбновление -> (строка)

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

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

Статус подключения. Может быть одним из: READY, IN_PROGRESS или FAILED.

ПричинаСтатуса -> (строка)

Причина статуса подключения.

ВремяПоследнейПроверкиПодключения -> (метка времени)

Отметка времени последней проверки этого подключения.

КонфигурацияАутентификации -> (структура)

Свойства аутентификации подключения.

ТипАутентификации -> (строка)

Структура, содержащая конфигурацию аутентификации.

ArnСекрета -> (строка)

ARN менеджера секретов для хранения учетных данных.

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

Свойства аутентификации OAuth2.

ТипOAuth2Grant -> (строка)

Тип OAuth2 grant. Например, AUTHORIZATION_CODE, JWT_BEARER или CLIENT_CREDENTIALS.

ПриложениеКлиентаOAuth2 -> (структура)

Тип приложения клиента. Например, AWS_MANAGED или USER_MANAGED.

ИдентификаторПриложенияКлиентаПользовательскогоУправления -> (строка)

Идентификатор клиента приложения клиента, если ClientAppType равен USER_MANAGED.

СсылкаНаПриложениеКлиентаAWS -> (строка)

Ссылка на приложение SaaS-стороны, управляемое Amazon Web Services.

UrlТокена -> (строка)

URL сервера аутентификации поставщика для обмена кодом авторизации на маркер доступа.

ПараметрыUrlТокена -> (карта)

Карта параметров, которые добавляются к запросу токена GET.

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

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

ВерсияСхемыПодключения -> (целое число)

Версия схемы подключения для этого подключения. Версия 2 поддерживает свойства для определенных сред вычислений.

СовместимыеСредыВычислений -> (список)

Список сред вычислений, совместимых с подключением.

(строка)