обновить-соединение

Описание

Обновляет определение соединения в каталоге данных.

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

Синтаксис

  update-connection
[--catalog-id <value>]
--name <value>
--connection-input <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 (строка)

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

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

Объект ConnectionInput , который переопределяет подключение.

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

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

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

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

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

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

JDBC - Обозначает подключение к базе данных через Java Database Connectivity (JDBC). JDBC Подключения используют следующие ConnectionParameters.
- Обязательно: Все из (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 Подключения используют следующие ConnectionParameters.
- Обязательно: 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 Подключения используют следующие ConnectionParameters.
- Обязательно: 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 Подключения используют следующие ConnectionParameters.
- Обязательно: 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 Таблицам.
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 по добавлению подключения Glue.

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

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

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

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

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

(строка)

ConnectionProperties -> (карта)

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

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

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

SparkProperties -> (карта)

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

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

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

AthenaProperties -> (карта)

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

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

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

PythonProperties -> (карта)

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

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

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

PhysicalConnectionRequirements -> (структура)

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

SubnetId -> (строка)

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

SecurityGroupIdList -> (список)

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

(строка)

AvailabilityZone -> (строка)

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

AuthenticationConfiguration -> (структура)

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

AuthenticationType -> (строка)

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

OAuth2Properties -> (структура)

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

OAuth2GrantType -> (строка)

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

OAuth2ClientApplication -> (структура)

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

UserManagedClientApplicationClientId -> (строка)

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

AWSManagedClientApplicationReference -> (строка)

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

TokenUrl -> (строка)

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

TokenUrlParametersMap -> (карта)

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

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

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

AuthorizationCodeProperties -> (структура)

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

AuthorizationCode -> (строка)

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

RedirectUri -> (строка)

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

OAuth2Credentials -> (структура)

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

UserManagedClientApplicationClientSecret -> (строка)

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

AccessToken -> (строка)

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

RefreshToken -> (строка)

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

JwtToken -> (строка)

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

SecretArn -> (строка)

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

KmsKeyArn -> (строка)

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

BasicAuthenticationCredentials -> (структура)

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

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

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

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

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

CustomAuthenticationCredentials -> (карта)

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

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

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

ValidateCredentials -> (булево)

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

ValidateForComputeEnvironments -> (список)

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

(строка)

Синтаксис 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", ...]
}

--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.

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

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

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

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

Вывод

Нет