create-connection

Описание

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

Подключения, используемые для создания федеративных ресурсов, требуют разрешения IAM glue:PassConnection.

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

Синтаксис

  create-connection
[--catalog-id <value>]
--connection-input <value>
[--tags <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.

--connection-input (структура)

Объект ConnectionInput, определяющий создаваемое подключение.

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

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

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

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

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

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

JDBC - Обозначает подключение к базе данных через Java Database Connectivity (JDBC). JDBC Подключения используют следующие параметры подключения.
- Обязательно: все из (HOST , PORT , JDBC_ENGINE ) или JDBC_CONNECTION_URL .
- Обязательно: все из (USERNAME , PASSWORD ) или SECRET_ID .
- Необязательно: JDBC_ENFORCE_SSL , CUSTOM_JDBC_CERT , CUSTOM_JDBC_CERT_STRING , SKIP_CUSTOM_JDBC_CERT_VALIDATION . Эти параметры используются для настройки SSL с JDBC.
KAFKA - Обозначает подключение к потоковой платформе Apache Kafka. KAFKA Подключения используют следующие параметры подключения.
- Обязательно: KAFKA_BOOTSTRAP_SERVERS .
- Необязательно: KAFKA_SSL_ENABLED , KAFKA_CUSTOM_CERT , KAFKA_SKIP_CUSTOM_CERT_VALIDATION . Эти параметры используются для настройки SSL с KAFKA .
- Необязательно: KAFKA_CLIENT_KEYSTORE , KAFKA_CLIENT_KEYSTORE_PASSWORD , KAFKA_CLIENT_KEY_PASSWORD , ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD , ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD . Эти параметры используются для настройки конфигурации клиента TLS с SSL в KAFKA .
- Необязательно: KAFKA_SASL_MECHANISM . Может быть задано как SCRAM-SHA-512 , GSSAPI или AWS_MSK_IAM .
- Необязательно: KAFKA_SASL_SCRAM_USERNAME , KAFKA_SASL_SCRAM_PASSWORD , ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD . Эти параметры используются для настройки аутентификации SASL/SCRAM-SHA-512 с KAFKA .
- Необязательно: KAFKA_SASL_GSSAPI_KEYTAB , KAFKA_SASL_GSSAPI_KRB5_CONF , KAFKA_SASL_GSSAPI_SERVICE , KAFKA_SASL_GSSAPI_PRINCIPAL . Эти параметры используются для настройки аутентификации SASL/GSSAPI с KAFKA .
MONGODB - Обозначает подключение к документоориентированной базе данных MongoDB. MONGODB Подключения используют следующие параметры подключения.
- Обязательно: CONNECTION_URL .
- Обязательно: все из (USERNAME , PASSWORD ) или SECRET_ID .
VIEW_VALIDATION_REDSHIFT - Обозначает подключение, используемое для проверки представлений Amazon Redshift.
VIEW_VALIDATION_ATHENA - Обозначает подключение, используемое для проверки представлений Amazon Athena.
NETWORK - Обозначает сетевое подключение к источнику данных в среде Amazon Virtual Private Cloud (Amazon VPC). NETWORK Подключения не требуют параметров ConnectionParameters. Вместо этого укажите PhysicalConnectionRequirements.
MARKETPLACE - Использует параметры конфигурации, содержащиеся в подключении, приобретенном из Amazon Web Services Marketplace, для чтения из и записи в хранилища данных, которые не поддерживаются Glue по умолчанию. MARKETPLACE Подключения используют следующие параметры подключения.
- Обязательно: CONNECTOR_TYPE , CONNECTOR_URL , CONNECTOR_CLASS_NAME , CONNECTION_URL .
- Обязательно для JDBC CONNECTOR_TYPE подключений: все из (USERNAME , PASSWORD ) или SECRET_ID .
CUSTOM - Использует параметры конфигурации, содержащиеся в пользовательском подключении, для чтения из и записи в хранилища данных, которые не поддерживаются Glue по умолчанию.

Кроме того, поддерживается ConnectionType для следующих подключений к SaaS:

FACEBOOKADS - Обозначает подключение к Facebook Ads.
GOOGLEADS - Обозначает подключение к Google Ads.
GOOGLESHEETS - Обозначает подключение к Google Sheets.
GOOGLEANALYTICS4 - Обозначает подключение к Google Analytics 4.
HUBSPOT - Обозначает подключение к HubSpot.
INSTAGRAMADS - Обозначает подключение к Instagram Ads.
INTERCOM - Обозначает подключение к Intercom.
JIRACLOUD - Обозначает подключение к Jira Cloud.
MARKETO - Обозначает подключение к Adobe Marketo Engage.
NETSUITEERP - Обозначает подключение к Oracle NetSuite.
SALESFORCE - Обозначает подключение к Salesforce с помощью аутентификации OAuth.
SALESFORCEMARKETINGCLOUD - Обозначает подключение к Salesforce Marketing Cloud.
SALESFORCEPARDOT - Обозначает подключение к Salesforce Marketing Cloud Account Engagement (MCAE).
SAPODATA - Обозначает подключение к SAP OData.
SERVICENOW - Обозначает подключение к ServiceNow.
SLACK - Обозначает подключение к Slack.
SNAPCHATADS - Обозначает подключение к Snapchat Ads.
STRIPE - Обозначает подключение к Stripe.
ZENDESK - Обозначает подключение к Zendesk.
ZOHOCRM - Обозначает подключение к Zoho CRM.

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

SFTP не поддерживается.

Дополнительную информацию о том, как используются необязательные свойства ConnectionProperties для настройки функций в Glue, см. в свойствах подключения Glue.

Дополнительную информацию о том, как используются необязательные свойства ConnectionProperties для настройки функций в Glue Studio, см. в использовании подключений и коннекторов.

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

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

(строка)

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

Эти пары ключ-значение определяют параметры подключения.

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

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

СвойстваSpark -> (отображение)

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

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

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

СвойстваAthena -> (отображение)

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

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

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

СвойстваPython -> (отображение)

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

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

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

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

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

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

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

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

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

(строка)

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

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

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

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

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

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

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

Свойства для аутентификации OAuth2 в запросе CreateConnection.

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

Тип OAuth2 grant в запросе CreateConnection. Например, AUTHORIZATION_CODE , JWT_BEARER или CLIENT_CREDENTIALS .

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

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

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

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

СсылкаНаУправляемоеAmazonWebServicesПриложение -> (строка)

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

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

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

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

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

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

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

СвойстваКодАвторизации -> (структура)

Набор свойств, необходимых для типа OAuth2 grant AUTHORIZATION_CODE .

КодАвторизации -> (строка)

Код авторизации, который используется на третьем этапе рабочего процесса grant AUTHORIZATION_CODE . Это одноразовый код, который становится недействительным после обмена на токен доступа, поэтому это приемлемое значение в качестве параметра запроса.

АдресПеренаправления -> (строка)

Адрес перенаправления, куда пользователь перенаправляется сервером авторизации при выдаче кода авторизации. URI используется при обмене кода авторизации на токен доступа.

УтвержденияOAuth2 -> (структура)

Утверждения, используемые, когда тип аутентификации — OAuth2.

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

Секрет клиента приложения, если приложение клиента управляемо пользователем.

ТокенДоступа -> (строка)

Токен доступа, используемый при аутентификации OAuth2.

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

Токен обновления, используемый при аутентификации OAuth2.

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

JSON Web Token (JWT), используемый при аутентификации OAuth2.

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

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

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

ARN ключа KMS, используемого для шифрования подключения. Принимается только в запросе и хранится в Secret Manager.

УчетныеДанныеОсновнойАутентификации -> (структура)

Учетные данные, используемые при аутентификации по типу Basic.

ИмяПользователя -> (строка)

Имя пользователя для подключения к источнику данных.

Пароль -> (строка)

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

УчетныеДанныеПользовательскойАутентификации -> (отображение)

Учетные данные, используемые при аутентификации по типу пользовательской аутентификации.

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

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

ПроверкаУчетныхДанных -> (булево)

Флаг для проверки учетных данных при создании подключения. По умолчанию — true.

ПроверкаДляСредыВычислений -> (список)

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

(строка)

Синтаксис JSON:

{
  "Name": "string",
  "Description": "string",
  "ConnectionType": "JDBC"|"SFTP"|"MONGODB"|"KAFKA"|"NETWORK"|"MARKETPLACE"|"CUSTOM"|"SALESFORCE"|"VIEW_VALIDATION_REDSHIFT"|"VIEW_VALIDATION_ATHENA"|"GOOGLEADS"|"GOOGLESHEETS"|"GOOGLEANALYTICS4"|"SERVICENOW"|"MARKETO"|"SAPODATA"|"ZENDESK"|"JIRACLOUD"|"NETSUITEERP"|"HUBSPOT"|"FACEBOOKADS"|"INSTAGRAMADS"|"ZOHOCRM"|"SALESFORCEPARDOT"|"SALESFORCEMARKETINGCLOUD"|"SLACK"|"STRIPE"|"INTERCOM"|"SNAPCHATADS",
  "MatchCriteria": ["string", ...],
  "ConnectionProperties": {"HOST"|"PORT"|"USERNAME"|"PASSWORD"|"ENCRYPTED_PASSWORD"|"JDBC_DRIVER_JAR_URI"|"JDBC_DRIVER_CLASS_NAME"|"JDBC_ENGINE"|"JDBC_ENGINE_VERSION"|"CONFIG_FILES"|"INSTANCE_ID"|"JDBC_CONNECTION_URL"|"JDBC_ENFORCE_SSL"|"CUSTOM_JDBC_CERT"|"SKIP_CUSTOM_JDBC_CERT_VALIDATION"|"CUSTOM_JDBC_CERT_STRING"|"CONNECTION_URL"|"KAFKA_BOOTSTRAP_SERVERS"|"KAFKA_SSL_ENABLED"|"KAFKA_CUSTOM_CERT"|"KAFKA_SKIP_CUSTOM_CERT_VALIDATION"|"KAFKA_CLIENT_KEYSTORE"|"KAFKA_CLIENT_KEYSTORE_PASSWORD"|"KAFKA_CLIENT_KEY_PASSWORD"|"ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD"|"ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD"|"KAFKA_SASL_MECHANISM"|"KAFKA_SASL_PLAIN_USERNAME"|"KAFKA_SASL_PLAIN_PASSWORD"|"ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD"|"KAFKA_SASL_SCRAM_USERNAME"|"KAFKA_SASL_SCRAM_PASSWORD"|"KAFKA_SASL_SCRAM_SECRETS_ARN"|"ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD"|"KAFKA_SASL_GSSAPI_KEYTAB"|"KAFKA_SASL_GSSAPI_KRB5_CONF"|"KAFKA_SASL_GSSAPI_SERVICE"|"KAFKA_SASL_GSSAPI_PRINCIPAL"|"SECRET_ID"|"CONNECTOR_URL"|"CONNECTOR_TYPE"|"CONNECTOR_CLASS_NAME"|"ENDPOINT"|"ENDPOINT_TYPE"|"ROLE_ARN"|"REGION"|"WORKGROUP_NAME"|"CLUSTER_IDENTIFIER"|"DATABASE": "string"
    ...},
  "SparkProperties": {"string": "string"
    ...},
  "AthenaProperties": {"string": "string"
    ...},
  "PythonProperties": {"string": "string"
    ...},
  "PhysicalConnectionRequirements": {
    "SubnetId": "string",
    "SecurityGroupIdList": ["string", ...],
    "AvailabilityZone": "string"
  },
  "AuthenticationConfiguration": {
    "AuthenticationType": "BASIC"|"OAUTH2"|"CUSTOM"|"IAM",
    "OAuth2Properties": {
      "OAuth2GrantType": "AUTHORIZATION_CODE"|"CLIENT_CREDENTIALS"|"JWT_BEARER",
      "OAuth2ClientApplication": {
        "UserManagedClientApplicationClientId": "string",
        "AWSManagedClientApplicationReference": "string"
      },
      "TokenUrl": "string",
      "TokenUrlParametersMap": {"string": "string"
        ...},
      "AuthorizationCodeProperties": {
        "AuthorizationCode": "string",
        "RedirectUri": "string"
      },
      "OAuth2Credentials": {
        "UserManagedClientApplicationClientSecret": "string",
        "AccessToken": "string",
        "RefreshToken": "string",
        "JwtToken": "string"
      }
    },
    "SecretArn": "string",
    "KmsKeyArn": "string",
    "BasicAuthenticationCredentials": {
      "Username": "string",
      "Password": "string"
    },
    "CustomAuthenticationCredentials": {"string": "string"
      ...}
  },
  "ValidateCredentials": true|false,
  "ValidateForComputeEnvironments": ["SPARK"|"ATHENA"|"PYTHON", ...]
}

--tags (отображение)

Теги, которые вы назначаете соединению.

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

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

Сокращенная синтаксическая запись:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--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
текст
таблица
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 для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробности см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры потребуется адаптировать к правилам цитирования вашей терминальной среды. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для создания соединения для AWS Glue data stores

Следующий create-connection пример создает соединение в каталоге данных AWS Glue, который предоставляет информацию о соединении для хранилища Kafka.

aws glue create-connection \
    --connection-input '{ \
        "Name":"conn-kafka-custom", \
        "Description":"kafka connection with ssl to custom kafka", \
        "ConnectionType":"KAFKA",  \
        "ConnectionProperties":{  \
            "KAFKA_BOOTSTRAP_SERVERS":"<Kafka-broker-server-url>:<SSL-Port>", \
            "KAFKA_SSL_ENABLED":"true", \
            "KAFKA_CUSTOM_CERT": "s3://bucket/prefix/cert-file.pem" \
        }, \
        "PhysicalConnectionRequirements":{ \
            "SubnetId":"subnet-1234", \
            "SecurityGroupIdList":["sg-1234"], \
            "AvailabilityZone":"us-east-1a"} \
    }' \
    --region us-east-1
    --endpoint https://glue.us-east-1.amazonaws.com

Эта команда не выводит никаких данных.

Дополнительную информацию см. в разделе Определение соединений в каталоге данных AWS Glue в Руководстве разработчика AWS Glue.

Вывод

CreateConnectionStatus -> (строка)

Статус запроса создания соединения. Запрос может занимать некоторое время для определенных типов аутентификации, например, при создании соединения OAuth с обменом токеном через VPC.