Spec-Zone.ru › AWS CLI v2

[ aws . datazone ]

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

Описание

Обновляет соединение. В Amazon DataZone соединение позволяет подключать ваши ресурсы (домены, проекты и среды) к внешним ресурсам и службам.

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

Синтаксис

  update-connection
[--aws-location <value>]
[--description <value>]
--domain-identifier <value>
--identifier <value>
[--props <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]

Параметры

--aws-location (структура)

Местоположение, где должно быть обновлено соединение.

accessRole -> (строка)

Роль доступа к соединению.

awsAccountId -> (строка)

Идентификатор учетной записи AWS соединения.

awsRegion -> (строка)

Регион соединения.

iamConnectionId -> (строка)

Идентификатор соединения IAM.

Сокращенный синтаксис:

accessRole=string,awsAccountId=string,awsRegion=string,iamConnectionId=string

Синтаксис JSON:

{
  "accessRole": "string",
  "awsAccountId": "string",
  "awsRegion": "string",
  "iamConnectionId": "string"
}

--description (строка)

Описание соединения.

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

Идентификатор домена, в котором должно быть обновлено соединение.

--identifier (строка)

Идентификатор соединения, которое нужно обновить.

--props (структура с тегами)

Свойства соединения.

Примечание

Это структура с тегами. Только один из следующих верхних ключей может быть задан: athenaProperties, glueProperties, iamProperties, redshiftProperties, sparkEmrProperties.

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

Свойства Amazon Athena для соединения.

workgroupName -> (строка)

Имя рабочей группы Amazon Athena для соединения.

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

Свойства Amazon Web Services Glue для соединения.

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

Обновление свойств Amazon Web Services Glue для соединения.

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

Настройка аутентификации соединения Amazon Web Services Glue.

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

Базовые учетные данные аутентификации соединения.

password -> (строка)

Пароль для соединения.

userName -> (строка)

Имя пользователя для соединения.

secretArn -> (строка)

ARN секрета соединения.

connectionProperties -> (массив)

Свойства соединения Amazon Web Services Glue.

key -> (строка)

value -> (строка)

description -> (строка)

Описание соединения Amazon Web Services Glue.

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

Свойства IAM для соединения.

glueLineageSyncEnabled -> (логическое)

Указывает, включена ли синхронизация происхождения Amazon Web Services Glue для соединения.

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

Свойства Amazon Redshift для соединения.

credentials -> (структура с тегами)

Учетные данные в свойствах Amazon Redshift.

Примечание

Это структура с тегами. Только один из следующих верхних ключей может быть задан: secretArn, usernamePassword.

secretArn -> (строка)

ARN секрета учетных данных Amazon Redshift.

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

Имя пользователя и пароль учетных данных Amazon Redshift.

password -> (строка)

Пароль соединения.

username -> (строка)

Имя пользователя соединения.

databaseName -> (строка)

Имя базы данных в свойствах Amazon Redshift.

host -> (строка)

Хост в свойствах Amazon Redshift.

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

Синхронизация происхождения в свойствах Amazon Redshift.

enabled -> (логическое)

Указывает, включена ли конфигурация синхронизации происхождения Amazon Redshift.

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

Расписание синхронизации происхождения Amazon Redshift.

schedule -> (строка)

Расписание синхронизации происхождения.

port -> (целое число)

Порт в свойствах Amazon Redshift.

storage -> (структура с тегами)

Хранилище в свойствах Amazon Redshift.

Примечание

Это структура с тегами. Только один из следующих верхних ключей может быть задан: clusterName, workgroupName.

clusterName -> (строка)

Имя кластера в свойствах хранения Amazon Redshift.

workgroupName -> (строка)

Имя рабочей группы в свойствах хранения Amazon Redshift.

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

Свойства Spark EMR для соединения.

computeArn -> (строка)

ARN вычислительных ресурсов в свойствах Spark EMR.

instanceProfileArn -> (строка)

ARN профиля экземпляра в свойствах Spark EMR.

javaVirtualEnv -> (строка)

Виртуальная среда Java в свойствах Spark EMR.

logUri -> (строка)

URI логов в свойствах Spark EMR.

pythonVirtualEnv -> (строка)

Виртуальная среда Python в свойствах Spark EMR.

runtimeRole -> (строка)

Роль выполнения в свойствах Spark EMR.

trustedCertificatesS3Uri -> (строка)

URI сертификатов доверия в S3 в свойствах Spark EMR.

Синтаксис JSON:

{
  "athenaProperties": {
    "workgroupName": "string"
  },
  "glueProperties": {
    "glueConnectionInput": {
      "authenticationConfiguration": {
        "basicAuthenticationCredentials": {
          "password": "string",
          "userName": "string"
        },
        "secretArn": "string"
      },
      "connectionProperties": {"string": "string"
        ...},
      "description": "string"
    }
  },
  "iamProperties": {
    "glueLineageSyncEnabled": true|false
  },
  "redshiftProperties": {
    "credentials": {
      "secretArn": "string",
      "usernamePassword": {
        "password": "string",
        "username": "string"
      }
    },
    "databaseName": "string",
    "host": "string",
    "lineageSync": {
      "enabled": true|false,
      "schedule": {
        "schedule": "string"
      }
    },
    "port": integer,
    "storage": {
      "clusterName": "string",
      "workgroupName": "string"
    }
  },
  "sparkEmrProperties": {
    "computeArn": "string",
    "instanceProfileArn": "string",
    "javaVirtualEnv": "string",
    "logUri": "string",
    "pythonVirtualEnv": "string",
    "runtimeRole": "string",
    "trustedCertificatesS3Uri": "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
  • 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 для вывода.

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

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

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

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

Вывод

connectionId -> (строка)

Идентификатор соединения.

description -> (строка)

Описание соединения.

domainId -> (строка)

Идентификатор домена, где соединение должно быть обновлено.

domainUnitId -> (строка)

Идентификатор единицы домена, где соединение должно быть обновлено.

environmentId -> (строка)

Идентификатор среды, где соединение должно быть обновлено.

name -> (строка)

Имя соединения.

physicalEndpoints -> (список)

Физические конечные точки соединения.

(структура)

Физические конечные точки соединения.

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

Расположение соединения.

accessRole -> (строка)

Роль доступа к соединению.

awsAccountId -> (строка)

Идентификатор учетной записи AWS соединения.

awsRegion -> (строка)

Регион соединения.

iamConnectionId -> (строка)

Идентификатор соединения IAM.

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

Соединение Amazon Web Services Glue.

athenaProperties -> (словарь)

Свойства Amazon Athena для соединения Amazon Web Services Glue.

key -> (строка)

value -> (строка)

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

Настройка аутентификации для соединения Amazon Web Services Glue.

authenticationType -> (строка)

Тип аутентификации соединения.

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

Свойства oAuth2 соединения.

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

Свойства кода авторизации для свойств oAuth2.

authorizationCode -> (строка)

Код авторизации соединения.

redirectUri -> (строка)

URI перенаправления соединения.

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

Приложение клиента oAuth2.

aWSManagedClientApplicationReference -> (строка)

Ссылка на управляемое приложение AWS в приложении OAuth2Client.

userManagedClientApplicationClientId -> (строка)

Идентификатор приложения клиента, управляемого пользователем, в приложении OAuth2Client.

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

Удостоверения oAuth2.

accessToken -> (строка)

Токен доступа к соединению.

jwtToken -> (строка)

Токен jwt соединения.

refreshToken -> (строка)

Токен обновления соединения.

userManagedClientApplicationClientSecret -> (строка)

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

oAuth2GrantType -> (строка)

Тип предоставления oAuth2.

tokenUrl -> (строка)

URL-адрес получения токена oAuth2.

tokenUrlParametersMap -> (словарь)

Параметры URL-адреса получения токена oAuth2.

key -> (строка)

value -> (строка)

secretArn -> (строка)

ARN секрета соединения.

compatibleComputeEnvironments -> (список)

Совместимые среды выполнения для соединения Amazon Web Services Glue.

(строка)

connectionProperties -> (словарь)

Свойства соединения Amazon Web Services Glue.

key -> (строка)

value -> (строка)

connectionSchemaVersion -> (целое число)

Версия схемы соединения Amazon Web Services Glue.

connectionType -> (строка)

Тип соединения Amazon Web Services Glue.

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

Время создания соединения Amazon Web Services Glue.

description -> (строка)

Описание соединения Amazon Web Services Glue.

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

Последнее время валидации соединения Amazon Web Services Glue.

lastUpdatedBy -> (строка)

Пользователь, последний обновивший соединение Amazon Web Services Glue.

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

Время последнего обновления соединения Amazon Web Services Glue.

matchCriteria -> (список)

Критерии соответствия для соединения Amazon Web Services Glue.

(строка)

name -> (строка)

Имя соединения Amazon Web Services Glue.

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

Требования к физическому соединению для соединения Amazon Web Services Glue.

availabilityZone -> (строка)

Зона доступности для физических требований к соединению.

securityGroupIdList -> (список)

Список идентификаторов групп безопасности.

(строка)

subnetId -> (строка)

Идентификатор подсети.

subnetIdList -> (список)

Список идентификаторов подсетей.

(строка)

pythonProperties -> (словарь)

Свойства Python для соединения Amazon Web Services Glue.

key -> (строка)

value -> (строка)

sparkProperties -> (словарь)

Свойства Spark для соединения Amazon Web Services Glue.

key -> (строка)

value -> (строка)

status -> (строка)

Статус соединения Amazon Web Services Glue.

statusReason -> (строка)

Причина статуса соединения Amazon Web Services Glue.

glueConnectionName -> (строка)

Имя соединения Amazon Web Services Glue.

host -> (строка)

Хост в физических конечных точках соединения.

port -> (целое число)

Порт в физических конечных точках соединения.

protocol -> (строка)

Протокол в физических конечных точках соединения.

stage -> (строка)

Этап в физических конечных точках соединения.

projectId -> (строка)

Идентификатор проекта соединения.

props -> (меченый объединённый тип структуры)

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

Примечание

Это структура помеченных союзов. Можно установить только один из следующих ключей верхнего уровня: athenaProperties, glueProperties, hyperPodProperties, iamProperties, redshiftProperties, sparkEmrProperties, sparkGlueProperties.

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

Свойства Amazon Athena подключения.

workgroupName -> (строка)

Имя группы задач Amazon Athena подключения.

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

Свойства Amazon Web Services Glue подключения.

errorMessage -> (строка)

Сообщение об ошибке, сгенерированное, если действие не выполнено успешно.

status -> (строка)

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

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

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

clusterArn -> (строка)

ARN кластера свойств гиперузла.

clusterName -> (строка)

Имя кластера свойств гиперузла.

orchestrator -> (строка)

Органайзер свойств гиперузла.

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

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

environmentId -> (строка)

Идентификатор среды подключения.

glueLineageSyncEnabled -> (булево)

Указывает, включен ли Amazon Web Services Glue синхронизация происхождения для подключения.

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

Свойства Amazon Redshift подключения.

credentials -> (структура помеченных союзов)

Данные доступа Amazon Redshift.

Примечание

Это структура помеченных союзов. Можно установить только один из следующих ключей верхнего уровня: secretArn, usernamePassword.

secretArn -> (строка)

ARN секрета данных доступа Amazon Redshift подключения.

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

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

password -> (строка)

Пароль подключения.

username -> (строка)

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

databaseName -> (строка)

Имя базы данных Amazon Redshift.

isProvisionedSecret -> (булево)

Указывает, содержит ли Amaon Redshift свойства предопределенный секрет.

jdbcIamUrl -> (строка)

URL jdbcIam свойств Amazon Redshift.

jdbcUrl -> (строка)

jdbcURL свойств Amazon Redshift.

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

Синхронизация происхождения свойств Amazon Redshift.

enabled -> (булево)

Указывает, включена ли конфигурация синхронизации происхождения Amaon Redshift.

lineageJobId -> (строка)

Идентификатор задачи синхронизации происхождения Amaon Redshift конфигурации.

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

Расписание конфигурации синхронизации происхождения Amaon Redshift.

schedule -> (строка)

Расписание синхронизации происхождения.

redshiftTempDir -> (строка)

redshiftTempDir свойств Amazon Redshift.

status -> (строка)

Статус в свойствах Amazon Redshift.

storage -> (структура помеченных союзов)

Хранилище свойств Amazon Redshift.

Примечание

Это структура помеченных союзов. Можно установить только один из следующих ключей верхнего уровня: clusterName, workgroupName.

clusterName -> (строка)

Имя кластера в свойствах хранилища Amazon Redshift.

workgroupName -> (строка)

Имя группы задач в свойствах хранилища Amazon Redshift.

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

Свойства Spark EMR подключения.

computeArn -> (строка)

ARN вычислительных ресурсов Spark EMR.

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

Данные доступа Spark EMR.

password -> (строка)

Пароль подключения.

username -> (строка)

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

credentialsExpiration -> (временная метка)

Срок действия данных доступа Spark EMR.

governanceType -> (строка)

Тип управления Spark EMR.

instanceProfileArn -> (строка)

ARN профиля экземпляра Spark EMR.

javaVirtualEnv -> (строка)

Виртуальная среда Java Spark EMR.

livyEndpoint -> (строка)

Конечная точка livy Spark EMR.

logUri -> (строка)

URI журнала Spark EMR.

pythonVirtualEnv -> (строка)

Виртуальная среда Python Spark EMR.

runtimeRole -> (строка)

Роль выполнения Spark EMR.

trustedCertificatesS3Uri -> (строка)

URL S3 доверенных сертификатов Spark EMR.

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

Свойства Spark Amazon Web Services Glue подключения.

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

Дополнительные аргументы свойств Spark Amazon Web Services Glue.

connection -> (строка)

Подключение в аргументах Spark Amazon Web Services Glue.

glueConnectionName -> (строка)

Имя подключения Amazon Web Services Glue в свойствах Spark Amazon Web Services Glue.

glueVersion -> (строка)

Версия Amazon Web Services Glue в свойствах Spark Amazon Web Services Glue.

idleTimeout -> (целое число)

Время ожидания бездействия в свойствах Spark Amazon Web Services Glue.

javaVirtualEnv -> (строка)

Виртуальная среда Java в свойствах Spark Amazon Web Services Glue.

numberOfWorkers -> (целое число)

Количество рабочих в свойствах Spark Amazon Web Services Glue.

pythonVirtualEnv -> (строка)

Виртуальная среда Python в свойствах Spark Amazon Web Services Glue.

workerType -> (строка)

Тип рабочих в свойствах Spark Amazon Web Services Glue.

type -> (строка)

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

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API