Spec-Zone.ru › AWS CLI v2

[ aws . events ]

update-connection

Описание

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

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

Синтаксис

  update-connection
--name <value>
[--description <value>]
[--authorization-type <value>]
[--auth-parameters <value>]
[--invocation-connectivity-parameters <value>]
[--kms-key-identifier <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]

Параметры

--name (строка)

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

--description (строка)

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

--authorization-type (строка)

Тип авторизации для подключения.

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

  • BASIC
  • OAUTH_CLIENT_CREDENTIALS
  • API_KEY

--auth-parameters (структура)

Параметры авторизации для подключения.

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

Параметры авторизации для Basic авторизации.

Username -> (строка)

Имя пользователя для Basic авторизации.

Password -> (строка)

Пароль, связанный с именем пользователя для Basic авторизации.

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

Параметры авторизации для OAuth авторизации.

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

Параметры клиента для подключения, когда OAuth указан как тип авторизации.

ClientID -> (строка)

Идентификатор клиента для OAuth авторизации.

ClientSecret -> (строка)

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

AuthorizationEndpoint -> (строка)

URL конечной точки авторизации при указании OAuth как типа авторизации.

HttpMethod -> (строка)

Метод, используемый для подключения к HTTP конечной точке.

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

Дополнительные HTTP параметры, используемые для запроса OAuth авторизации.

HeaderParameters -> (список)

Дополнительные параметры заголовка для подключения.

(структура)

Дополнительный параметр, включенный в заголовок. Вы можете включить до 100 дополнительных параметров заголовка в каждом запросе. Объем данных события не должен превышать 64 КБ.

Key -> (строка)

Ключ параметра.

Value -> (строка)

Значение, связанное с ключом.

IsValueSecret -> (булево)

Указывает, является ли значение секретом.

QueryStringParameters -> (список)

Дополнительные параметры строки запроса для подключения.

(структура)

Любой дополнительный параметр строки запроса для подключения. Вы можете включить до 100 дополнительных параметров строки запроса в каждом запросе. Каждый дополнительный параметр учитывается в размере данных события, который не должен превышать 64 КБ.

Key -> (строка)

Ключ параметра строки запроса.

Value -> (строка)

Значение, связанное с ключом параметра строки запроса.

IsValueSecret -> (булево)

Указывает, является ли значение секретом.

BodyParameters -> (список)

Дополнительные параметры тела строки для подключения.

(структура)

Дополнительный параметр, включенный в тело. Вы можете включить до 100 дополнительных параметров тела в каждом запросе. Объем данных события не должен превышать 64 КБ.

Key -> (строка)

Ключ параметра.

Value -> (строка)

Значение, связанное с ключом.

IsValueSecret -> (булево)

Указывает, является ли значение секретом.

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

Параметры авторизации для авторизации API ключа.

ApiKeyName -> (строка)

Имя API ключа для авторизации.

ApiKeyValue -> (строка)

Значение, связанное с API ключом для авторизации.

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

Дополнительные параметры для подключения.

HeaderParameters -> (список)

Дополнительные параметры заголовка для подключения.

(структура)

Дополнительный параметр, включенный в заголовок. Вы можете включить до 100 дополнительных параметров заголовка в каждом запросе. Объем данных события не должен превышать 64 КБ.

Key -> (строка)

Ключ параметра.

Value -> (строка)

Значение, связанное с ключом.

IsValueSecret -> (булево)

Указывает, является ли значение секретом.

QueryStringParameters -> (список)

Дополнительные параметры строки запроса для подключения.

(структура)

Любой дополнительный параметр строки запроса для подключения. Вы можете включить до 100 дополнительных параметров строки запроса в каждом запросе. Каждый дополнительный параметр учитывается в размере данных события, который не должен превышать 64 КБ.

Key -> (строка)

Ключ параметра строки запроса.

Value -> (строка)

Значение, связанное с ключом параметра строки запроса.

IsValueSecret -> (булево)

Указывает, является ли значение секретом.

BodyParameters -> (список)

Дополнительные параметры тела строки для подключения.

(структура)

Дополнительный параметр, включенный в тело. Вы можете включить до 100 дополнительных параметров тела в каждом запросе. Объем данных события не должен превышать 64 КБ.

Key -> (строка)

Ключ параметра.

Value -> (строка)

Значение, связанное с ключом.

IsValueSecret -> (булево)

Указывает, является ли значение секретом.

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

Если вы укажете частную конечную точку OAuth, параметры, которые EventBridge будет использовать при аутентификации на этой конечной точке.

Для получения дополнительной информации см. Методы авторизации для подключений в * Руководстве пользователя Amazon EventBridge *.

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

Параметры, которые EventBridge будет использовать при вызове конечной точки ресурса.

ResourceConfigurationArn -> (строка)

Идентификатор ресурса Amazon Resource Name (ARN) конфигурации ресурса Amazon VPC Lattice для конечной точки ресурса.

Синтаксис JSON:

{
  "BasicAuthParameters": {
    "Username": "string",
    "Password": "string"
  },
  "OAuthParameters": {
    "ClientParameters": {
      "ClientID": "string",
      "ClientSecret": "string"
    },
    "AuthorizationEndpoint": "string",
    "HttpMethod": "GET"|"POST"|"PUT",
    "OAuthHttpParameters": {
      "HeaderParameters": [
        {
          "Key": "string",
          "Value": "string",
          "IsValueSecret": true|false
        }
        ...
      ],
      "QueryStringParameters": [
        {
          "Key": "string",
          "Value": "string",
          "IsValueSecret": true|false
        }
        ...
      ],
      "BodyParameters": [
        {
          "Key": "string",
          "Value": "string",
          "IsValueSecret": true|false
        }
        ...
      ]
    }
  },
  "ApiKeyAuthParameters": {
    "ApiKeyName": "string",
    "ApiKeyValue": "string"
  },
  "InvocationHttpParameters": {
    "HeaderParameters": [
      {
        "Key": "string",
        "Value": "string",
        "IsValueSecret": true|false
      }
      ...
    ],
    "QueryStringParameters": [
      {
        "Key": "string",
        "Value": "string",
        "IsValueSecret": true|false
      }
      ...
    ],
    "BodyParameters": [
      {
        "Key": "string",
        "Value": "string",
        "IsValueSecret": true|false
      }
      ...
    ]
  },
  "ConnectivityParameters": {
    "ResourceParameters": {
      "ResourceConfigurationArn": "string"
    }
  }
}

--invocation-connectivity-parameters (структура)

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

Для получения дополнительной информации см. Подключение к частным API в * Руководстве пользователя Amazon EventBridge *.

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

Параметры, которые EventBridge будет использовать при вызове конечной точки ресурса.

ResourceConfigurationArn -> (строка)

Идентификатор ресурса Amazon Resource Name (ARN) конфигурации ресурса Amazon VPC Lattice для конечной точки ресурса.

Краткая запись:

ResourceParameters={ResourceConfigurationArn=string}

Синтаксис JSON:

{
  "ResourceParameters": {
    "ResourceConfigurationArn": "string"
  }
}

--kms-key-identifier (строка)

Идентификатор управляемого клиентом ключа KMS для EventBridge, который используется, если вы выбрали использование управляемого клиентом ключа для шифрования этого подключения. Идентификатор может быть идентификатором ключа, именем ключа, именем псевдонима ключа или именем псевдонима ключа ARN.

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

Для получения дополнительной информации, см. Идентификация и просмотр ключей в *Руководстве разработчика Key Management Service*.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределяют значения из JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит скелет JSON в стандартный вывод без отправки запроса API. Если предоставлено значение null или input, выводит пример входного JSON, который может использоваться в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, будет напечатан пример входного YAML, который может быть использован с --cli-input-yaml. Если предоставлено значение output, оно валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный скелет JSON не является стабильным между версиями AWS CLI и не гарантирует обратной совместимости в сгенерированном скелете JSON.

Общие параметры

--debug (boolean)

Включить отладку.

--endpoint-url (string)

Переопределить стандартный URL команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла учетных данных.

--region (string)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

  • включить
  • выключить
  • автоматически

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл с сертификатом CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования для бинарных блоков. По умолчанию используется формат 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

ConnectionArn -> (string)

ARN соединения, которое было обновлено.

ConnectionState -> (string)

Состояние соединения, которое было обновлено.

CreationTime -> (timestamp)

Отметка времени создания соединения.

LastModifiedTime -> (timestamp)

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

LastAuthorizedTime -> (timestamp)

Отметка времени последней авторизации соединения.

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

Spec-Zone.ru

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