Spec-Zone.ru › AWS CLI v2

[ aws . events ]

create-connection

Описание

Создаёт соединение. Соединение определяет тип авторизации и данные для авторизации с конечной точкой HTTP API-назначения.

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

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

Синтаксис

  create-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 (строка)

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

Примечание

Токены OAuth обновляются при получении ответа 401 или 407.

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

  • BASIC
  • OAUTH_CLIENT_CREDENTIALS
  • API_KEY

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

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

Вы должны включить только параметры авторизации для AuthorizationType, которые вы указали.

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

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

Username -> (строка)

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

Password -> (строка)

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

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

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

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

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

ClientID -> (строка)

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

ClientSecret -> (строка)

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

AuthorizationEndpoint -> (строка)

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

HttpMethod -> (строка)

Метод для запроса авторизации.

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

Подробности о дополнительных параметрах для соединения.

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 -> (структура)

Параметры авторизации API-ключа для соединения. Обратите внимание, что если вы включаете дополнительные параметры для целевого объекта правила, включая строки запроса, параметры, добавленные для соединения, имеют приоритет.

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, если вы хотите использовать управляемый клиентом ключ для шифрования этого соединения. Идентификатор может быть Amazon Resource Name (ARN) ключа, KeyId, псевдонимом ключа или псевдонимом ключа 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
  • table
  • yaml
  • yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

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

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

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

Spec-Zone.ru

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