Spec-Zone.ru › AWS CLI v2

[ aws . appflow ]

создать-профиль-подключения

Описание

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

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

Синтаксис

  create-connector-profile
--connector-profile-name <value>
[--kms-arn <value>]
--connector-type <value>
[--connector-label <value>]
--connection-mode <value>
--connector-profile-config <value>
[--client-token <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]

Параметры

--connector-profile-name (строка)

Название профиля подключения. Название уникально для каждого ConnectorProfile в вашей учетной записи Amazon Web Services.

--kms-arn (строка)

ARN (Amazon Resource Name) ключа управления ключами (KMS), который вы предоставляете для шифрования. Это необходимо, если вы не хотите использовать управляемый Amazon AppFlow ключ KMS. Если вы ничего не предоставите, Amazon AppFlow будет использовать управляемый Amazon AppFlow ключ KMS.

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

Тип подключения, например Salesforce, Amplitude и так далее.

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

  • Salesforce
  • Singular
  • Slack
  • Redshift
  • S3
  • Marketo
  • Googleanalytics
  • Zendesk
  • Servicenow
  • Datadog
  • Trendmicro
  • Snowflake
  • Dynatrace
  • Infornexus
  • Amplitude
  • Veeva
  • EventBridge
  • LookoutMetrics
  • Upsolver
  • Honeycode
  • CustomerProfiles
  • SAPOData
  • CustomConnector
  • Pardot

--connector-label (строка)

Метка подключения. Метка уникальна для каждого ConnectorRegistration в вашей учетной записи Amazon Web Services. Требуется только при вызове для типа подключения CUSTOMCONNECTOR.

--connection-mode (строка)

Указывает режим подключения и определяет, является ли он публичным или частным. Частные потоки используют Amazon Web Services PrivateLink для маршрутизации данных по инфраструктуре Amazon Web Services без экспонирования их в общедоступном интернете.

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

  • Public
  • Private

--connector-profile-config (структура)

Определяет конфигурацию и учетные данные, специфичные для коннектора.

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

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

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

Свойства, специфичные для коннектора, необходимые для Amplitude.

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

Свойства, специфичные для коннектора, необходимые для Datadog.

instanceUrl -> (строка)

Расположение ресурса Datadog.

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

Свойства, специфичные для коннектора, необходимые для Dynatrace.

instanceUrl -> (строка)

Расположение ресурса Dynatrace.

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

Свойства, специфичные для коннектора, необходимые для Google Analytics.

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

Свойства, специфичные для коннектора, необходимые для Amazon Honeycode.

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

Свойства, специфичные для коннектора, необходимые для Infor Nexus.

instanceUrl -> (строка)

Расположение ресурса Infor Nexus.

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

Свойства, специфичные для коннектора, необходимые для Marketo.

instanceUrl -> (строка)

Расположение ресурса Marketo.

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

Свойства, специфичные для коннектора, необходимые для Amazon Redshift.

databaseUrl -> (строка)

JDBC-адрес кластера Amazon Redshift.

bucketName -> (строка)

Имя связанного Amazon S3-бакета.

bucketPrefix -> (строка)

Ключ объекта в целевом бакете Amazon S3, куда Amazon AppFlow помещает файлы.

roleArn -> (строка)

Идентификатор ресурса Amazon Resource Name (ARN) роли IAM, предоставляющей Amazon Redshift чтение только для доступа к данным Amazon S3. Для получения дополнительной информации и политик, прикрепленных к этой роли, см. Раздел Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3.

dataApiRoleArn -> (строка)

Идентификатор ресурса Amazon Resource Name (ARN) роли IAM, позволяющей Amazon AppFlow получать доступ к базе данных Amazon Redshift через API данных. Для получения дополнительной информации и политик, прикрепленных к этой роли, см. Раздел Allow Amazon AppFlow to access Amazon Redshift databases with the Data API.

isRedshiftServerless -> (булево)

Указывает, определяет ли профиль коннектора подключение к Amazon Redshift Serverless хранилищу данных.

clusterIdentifier -> (строка)

Уникальный идентификатор, назначенный кластеру Amazon Redshift.

workgroupName -> (строка)

Имя рабочей группы Amazon Redshift.

databaseName -> (строка)

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

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

Свойства, специфичные для коннектора, необходимые для Salesforce.

instanceUrl -> (строка)

Расположение ресурса Salesforce.

isSandboxEnvironment -> (булево)

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

usePrivateLinkForMetadataAndAuthorization -> (булево)

Если режим подключения для профиля коннектора — частный, этот параметр задает, использует ли Amazon AppFlow частную сеть для отправки вызовов метаданных и авторизации в Salesforce. Amazon AppFlow отправляет частные вызовы через Amazon Web Services PrivateLink. Эти вызовы проходят через инфраструктуру Amazon Web Services без экспонирования в общедоступном интернете.

Установите одно из следующих значений:

true

Amazon AppFlow отправляет все вызовы в Salesforce по частной сети.

Эти частные вызовы:

  • Вызовы для получения метаданных о ваших записях Salesforce. Эти метаданные описывают ваши объекты Salesforce и их поля.

  • Вызовы для получения или обновления токенов доступа, позволяющих Amazon AppFlow получить доступ к вашим записям Salesforce.

  • Вызовы для передачи ваших записей Salesforce в рамках выполнения потока.

    false

Значение по умолчанию. Amazon AppFlow отправляет некоторые вызовы в Salesforce по частной сети, а другие — через общедоступный интернет.

Общедоступные вызовы:

  • Вызовы для получения метаданных о ваших записях Salesforce.
  • Вызовы для получения или обновления токенов доступа.

Частные вызовы:

  • Вызовы для передачи ваших записей Salesforce в рамках выполнения потока.

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

Свойства, специфичные для коннектора, необходимые для serviceNow.

instanceUrl -> (строка)

Расположение ресурса ServiceNow.

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

Свойства, специфичные для коннектора, необходимые для Singular.

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

Свойства, специфичные для коннектора, необходимые для Slack.

instanceUrl -> (строка)

Расположение ресурса Slack.

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

Свойства, специфичные для коннектора, необходимые для Snowflake.

warehouse -> (строка)

Имя хранилища Snowflake.

stage -> (строка)

Имя Amazon S3-этапа, созданного при настройке Amazon S3-этапа в аккаунте Snowflake. Записывается в формате: < База данных>< Схема>< Название этапа>.

bucketName -> (строка)

Имя Amazon S3-бакета, связанного со Snowflake.

bucketPrefix -> (строка)

Путь к бакету Amazon S3, связанного со Snowflake.

privateLinkServiceName -> (строка)

Имя службы Snowflake Private Link, используемой для частных передач данных.

accountName -> (строка)

Имя учетной записи.

region -> (строка)

Регион Amazon Web Services аккаунта Snowflake.

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

Свойства, специфичные для коннектора, необходимые для Trend Micro.

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

Свойства, специфичные для коннектора, необходимые для Veeva.

instanceUrl -> (строка)

Расположение ресурса Veeva.

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

Свойства, специфичные для коннектора, необходимые для Zendesk.

instanceUrl -> (строка)

Расположение ресурса Zendesk.

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

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

applicationHostUrl -> (строка)

Расположение ресурса SAPOData.

applicationServicePath -> (строка)

Путь к службе каталога приложения.

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

Номер порта экземпляра SAPOData.

clientNumber -> (строка)

Номер клиента, создающего подключение.

logonLanguage -> (строка)

Язык входа в систему экземпляра SAPOData.

privateLinkServiceName -> (строка)

Имя службы SAPOData Private Link для использования в частных передачах данных.

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

Свойства SAPOData OAuth, необходимые для аутентификации типа OAuth.

tokenUrl -> (строка)

URL-адрес получения токена, необходимый для получения токенов доступа/обновления токенов с помощью кода авторизации, а также для обновления истекших токенов доступа с помощью токена обновления.

authCodeUrl -> (строка)

URL-адрес кода авторизации, необходимый для перенаправления на страницу входа в SAP для получения кода авторизации для аутентификации типа OAuth.

oAuthScopes -> (список)

Необходимые OAuth-области для аутентификации типа OAuth.

(строка)

disableSSO -> (булево)

Если вы установите этот параметр в true, Amazon AppFlow проигнорирует настройки single sign-on (SSO) в вашем аккаунте SAP при доступе к вашему экземпляру SAP OData.

Нужность этого параметра зависит от типа учетных данных, которые вы применили к профилю подключения SAP OData. Если ваш профиль использует учетные данные базовой аутентификации, SAP SSO может препятствовать подключению Amazon AppFlow к вашему аккаунту с вашим именем пользователя и паролем. В этом случае игнорирование SSO позволит Amazon AppFlow успешно подключиться. Однако, если ваш профиль использует учетные данные OAuth, этот параметр не имеет никакого эффекта.

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

Свойства, необходимые для пользовательского коннектора.

profileProperties -> (карта)

Карта свойств, необходимых для создания профиля для пользовательского коннектора.

key -> (строка)

value -> (строка)

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

Свойства OAuth 2.0, необходимые для аутентификации OAuth 2.0.

tokenUrl -> (строка)

URL-адрес получения токена, необходимый для аутентификации OAuth 2.0.

oAuth2GrantType -> (строка)

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

tokenUrlCustomProperties -> (карта)

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

key -> (строка)

value -> (строка)

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

Свойства, специфичные для коннектора, необходимые для Salesforce Pardot.

instanceUrl -> (строка)

Расположение ресурса Salesforce Pardot.

isSandboxEnvironment -> (булево)

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

businessUnitId -> (строка)

Идентификатор бизнес-единицы экземпляра Salesforce Pardot.

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

Требуемые для каждого коннектора специфические учетные данные.

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

Требуемые специфические учетные данные при использовании Amplitude.

apiKey -> (строка)

Уникальный буквенно-цифровой идентификатор, используемый для аутентификации пользователя, разработчика или вызывающей программы для доступа к вашему API.

secretKey -> (строка)

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

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

Требуемые специфические учетные данные при использовании Datadog.

apiKey -> (строка)

Уникальный буквенно-цифровой идентификатор, используемый для аутентификации пользователя, разработчика или вызывающей программы для доступа к вашему API.

applicationKey -> (строка)

Ключи приложений в сочетании с вашим API-ключом обеспечивают полный доступ к программируемому API Datadog. Ключи приложений связаны с учетной записью пользователя, который их создал. Ключ приложения используется для протоколирования всех запросов, отправленных в API.

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

Требуемые специфические учетные данные при использовании Dynatrace.

apiToken -> (строка)

API-токены, используемые API Dynatrace для аутентификации различных вызовов API.

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

Требуемые специфические учетные данные при использовании Google Analytics.

clientId -> (строка)

Идентификатор нужного клиента.

clientSecret -> (строка)

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

accessToken -> (строка)

Учетные данные для доступа к защищенным ресурсам Google Analytics.

refreshToken -> (строка)

Учетные данные для получения новых токенов доступа. Это необходимо только для OAuth2-токенов доступа, и не требуется для OAuth1-токенов доступа.

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

Требование OAuth для запроса токенов безопасности от конечной точки коннектора.

authCode -> (строка)

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

redirectUri -> (строка)

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

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

Требуемые специфические учетные данные при использовании Amazon Honeycode.

accessToken -> (строка)

Учетные данные для доступа к защищенным ресурсам Amazon Honeycode.

refreshToken -> (строка)

Учетные данные для получения новых токенов доступа.

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

Используется некоторыми коннекторами, поддерживающими OAuth-поток, такими как Salesforce, Google Analytics, Marketo, Zendesk и Slack.

authCode -> (строка)

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

redirectUri -> (строка)

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

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

Требуемые специфические учетные данные при использовании Infor Nexus.

accessKeyId -> (строка)

Ключ доступа, являющийся частью учетных данных.

userId -> (строка)

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

secretAccessKey -> (строка)

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

datakey -> (строка)

Ключи шифрования, используемые для шифрования данных.

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

Требуемые специфические учетные данные при использовании Marketo.

clientId -> (строка)

Идентификатор нужного клиента.

clientSecret -> (строка)

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

accessToken -> (строка)

Учетные данные для доступа к защищенным ресурсам Marketo.

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

Требование OAuth для запроса токенов безопасности от конечной точки коннектора.

authCode -> (строка)

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

redirectUri -> (строка)

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

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

Требуемые специфические учетные данные при использовании Amazon Redshift.

username -> (строка)

Имя пользователя.

password -> (строка)

Пароль, соответствующий имени пользователя.

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

Требуемые специфические учетные данные при использовании Salesforce.

accessToken -> (строка)

Учетные данные для доступа к защищенным ресурсам Salesforce.

refreshToken -> (строка)

Учетные данные для получения новых токенов доступа.

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

Требование OAuth для запроса токенов безопасности от конечной точки коннектора.

authCode -> (строка)

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

redirectUri -> (строка)

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

clientCredentialsArn -> (строка)

ARN секретного менеджера, содержащий идентификатор клиента и секретный ключ подключенного приложения.

oAuth2GrantType -> (строка)

Указывает тип OAuth 2.0 гранта, который Amazon AppFlow использует при запросе токена доступа от Salesforce. Amazon AppFlow требует токен доступа каждый раз при попытке доступа к вашим записям Salesforce.

Вы можете указать одно из следующих значений:

AUTHORIZATION_CODE

Amazon AppFlow передает код авторизации при запросе токена доступа от Salesforce. Amazon AppFlow получает код авторизации от Salesforce после входа в вашу учетную запись Salesforce и предоставления Amazon AppFlow доступа к вашим записям.

JWT_BEARER

Amazon AppFlow передает JSON-токен (JWT) при запросе токена доступа от Salesforce. Вы предоставляете JWT Amazon AppFlow при определении подключения к вашей учетной записи Salesforce. При использовании этого типа гранта вам не нужно входить в свою учетную запись Salesforce для предоставления Amazon AppFlow доступа к вашим записям.

Примечание

Значение CLIENT_CREDENTIALS не поддерживается для Salesforce.

jwtToken -> (строка)

JSON-токен (JWT), который авторизует Amazon AppFlow для доступа к вашим записям Salesforce.

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

Требуемые специфические учетные данные при использовании ServiceNow.

username -> (строка)

Имя пользователя.

password -> (строка)

Пароль, соответствующий имени пользователя.

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

Требуемые OAuth 2.0 учетные данные для аутентификации пользователя.

clientId -> (строка)

Идентификатор нужного клиента.

clientSecret -> (строка)

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

accessToken -> (строка)

Токен доступа, используемый для доступа к коннектору от вашего имени.

refreshToken -> (строка)

Токен обновления, используемый для обновления истекшего токена доступа.

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

Используется некоторыми коннекторами, поддерживающими OAuth-поток, такими как Salesforce, Google Analytics, Marketo, Zendesk и Slack.

authCode -> (строка)

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

redirectUri -> (строка)

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

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

Требуемые специфические учетные данные при использовании Singular.

apiKey -> (строка)

Уникальный буквенно-цифровой идентификатор, используемый для аутентификации пользователя, разработчика или вызывающей программы для доступа к вашему API.

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

Требуемые специфические учетные данные при использовании Slack.

clientId -> (строка)

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

clientSecret -> (строка)

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

accessToken -> (строка)

Учетные данные для доступа к защищенным ресурсам Slack.

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

Требование OAuth для запроса токенов безопасности от конечной точки коннектора.

authCode -> (строка)

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

redirectUri -> (строка)

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

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

Требуемые специфические учетные данные при использовании Snowflake.

username -> (строка)

Имя пользователя.

password -> (строка)

Пароль, соответствующий имени пользователя.

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

Требуемые специфические учетные данные при использовании Trend Micro.

apiSecretKey -> (строка)

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

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

Требуемые специфические учетные данные при использовании Veeva.

username -> (строка)

Имя пользователя.

password -> (строка)

Пароль, соответствующий имени пользователя.

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

Требуемые специфические учетные данные при использовании Zendesk.

clientId -> (строка)

Идентификатор нужного клиента.

clientSecret -> (строка)

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

accessToken -> (строка)

Учетные данные для доступа к защищенным ресурсам Zendesk.

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

Требование OAuth для запроса токенов безопасности от конечной точки коннектора.

authCode -> (строка)

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

redirectUri -> (строка)

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

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

Учётные данные профиля коннектора, необходимые при использовании SAPOData.

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

Учётные данные для базовой аутентификации SAPOData.

username -> (строка)

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

password -> (строка)

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

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

Учётные данные для аутентификации типа OAuth SAPOData.

clientId -> (строка)

Идентификатор требуемого клиента.

clientSecret -> (строка)

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

accessToken -> (строка)

Токен доступа для доступа к защищённым ресурсам SAPOData.

refreshToken -> (строка)

Токен обновления для обновления истекшего токена доступа.

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

Требования OAuth для запроса токенов безопасности от конечной точки коннектора.

authCode -> (строка)

Код, предоставленный коннектором после аутентификации через подключённое приложение.

redirectUri -> (строка)

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

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

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

authenticationType -> (строка)

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

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

Основные учётные данные, необходимые для аутентификации пользователя.

username -> (строка)

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

password -> (строка)

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

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

Учётные данные OAuth 2.0, необходимые для аутентификации пользователя.

clientId -> (строка)

Идентификатор требуемого клиента.

clientSecret -> (строка)

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

accessToken -> (строка)

Токен доступа для доступа к коннектору от вашего имени.

refreshToken -> (строка)

Токен обновления для обновления истекшего токена доступа.

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

Используется для некоторых коннекторов, поддерживающих OAuth, таких как Salesforce, Google Analytics, Marketo, Zendesk и Slack.

authCode -> (строка)

Код, предоставленный коннектором после аутентификации через подключённое приложение.

redirectUri -> (строка)

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

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

API-ключи, необходимые для аутентификации пользователя.

apiKey -> (строка)

API-ключ, необходимый для аутентификации по API-ключам.

apiSecretKey -> (строка)

Секретный API-ключ, необходимый для аутентификации по API-ключам.

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

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

customAuthenticationType -> (строка)

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

credentialsMap -> (карта)

Карта, хранящая пользовательские учётные данные аутентификации.

key -> (строка)

value -> (строка)

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

Учётные данные профиля коннектора, необходимые при использовании Salesforce Pardot.

accessToken -> (строка)

Учётные данные для доступа к защищённым ресурсам Salesforce Pardot.

refreshToken -> (строка)

Учётные данные для получения новых токенов доступа.

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

Используется для некоторых коннекторов, поддерживающих OAuth, таких как Salesforce, Google Analytics, Marketo, Zendesk и Slack.

authCode -> (строка)

Код, предоставленный коннектором после аутентификации через подключённое приложение.

redirectUri -> (строка)

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

clientCredentialsArn -> (строка)

ARN менеджера секретов, содержащий идентификатор клиента и секретный ключ подключённого приложения.

Синтаксис JSON:

{
  "connectorProfileProperties": {
    "Amplitude": {

    },
    "Datadog": {
      "instanceUrl": "string"
    },
    "Dynatrace": {
      "instanceUrl": "string"
    },
    "GoogleAnalytics": {

    },
    "Honeycode": {

    },
    "InforNexus": {
      "instanceUrl": "string"
    },
    "Marketo": {
      "instanceUrl": "string"
    },
    "Redshift": {
      "databaseUrl": "string",
      "bucketName": "string",
      "bucketPrefix": "string",
      "roleArn": "string",
      "dataApiRoleArn": "string",
      "isRedshiftServerless": true|false,
      "clusterIdentifier": "string",
      "workgroupName": "string",
      "databaseName": "string"
    },
    "Salesforce": {
      "instanceUrl": "string",
      "isSandboxEnvironment": true|false,
      "usePrivateLinkForMetadataAndAuthorization": true|false
    },
    "ServiceNow": {
      "instanceUrl": "string"
    },
    "Singular": {

    },
    "Slack": {
      "instanceUrl": "string"
    },
    "Snowflake": {
      "warehouse": "string",
      "stage": "string",
      "bucketName": "string",
      "bucketPrefix": "string",
      "privateLinkServiceName": "string",
      "accountName": "string",
      "region": "string"
    },
    "Trendmicro": {

    },
    "Veeva": {
      "instanceUrl": "string"
    },
    "Zendesk": {
      "instanceUrl": "string"
    },
    "SAPOData": {
      "applicationHostUrl": "string",
      "applicationServicePath": "string",
      "portNumber": integer,
      "clientNumber": "string",
      "logonLanguage": "string",
      "privateLinkServiceName": "string",
      "oAuthProperties": {
        "tokenUrl": "string",
        "authCodeUrl": "string",
        "oAuthScopes": ["string", ...]
      },
      "disableSSO": true|false
    },
    "CustomConnector": {
      "profileProperties": {"string": "string"
        ...},
      "oAuth2Properties": {
        "tokenUrl": "string",
        "oAuth2GrantType": "CLIENT_CREDENTIALS"|"AUTHORIZATION_CODE"|"JWT_BEARER",
        "tokenUrlCustomProperties": {"string": "string"
          ...}
      }
    },
    "Pardot": {
      "instanceUrl": "string",
      "isSandboxEnvironment": true|false,
      "businessUnitId": "string"
    }
  },
  "connectorProfileCredentials": {
    "Amplitude": {
      "apiKey": "string",
      "secretKey": "string"
    },
    "Datadog": {
      "apiKey": "string",
      "applicationKey": "string"
    },
    "Dynatrace": {
      "apiToken": "string"
    },
    "GoogleAnalytics": {
      "clientId": "string",
      "clientSecret": "string",
      "accessToken": "string",
      "refreshToken": "string",
      "oAuthRequest": {
        "authCode": "string",
        "redirectUri": "string"
      }
    },
    "Honeycode": {
      "accessToken": "string",
      "refreshToken": "string",
      "oAuthRequest": {
        "authCode": "string",
        "redirectUri": "string"
      }
    },
    "InforNexus": {
      "accessKeyId": "string",
      "userId": "string",
      "secretAccessKey": "string",
      "datakey": "string"
    },
    "Marketo": {
      "clientId": "string",
      "clientSecret": "string",
      "accessToken": "string",
      "oAuthRequest": {
        "authCode": "string",
        "redirectUri": "string"
      }
    },
    "Redshift": {
      "username": "string",
      "password": "string"
    },
    "Salesforce": {
      "accessToken": "string",
      "refreshToken": "string",
      "oAuthRequest": {
        "authCode": "string",
        "redirectUri": "string"
      },
      "clientCredentialsArn": "string",
      "oAuth2GrantType": "CLIENT_CREDENTIALS"|"AUTHORIZATION_CODE"|"JWT_BEARER",
      "jwtToken": "string"
    },
    "ServiceNow": {
      "username": "string",
      "password": "string",
      "oAuth2Credentials": {
        "clientId": "string",
        "clientSecret": "string",
        "accessToken": "string",
        "refreshToken": "string",
        "oAuthRequest": {
          "authCode": "string",
          "redirectUri": "string"
        }
      }
    },
    "Singular": {
      "apiKey": "string"
    },
    "Slack": {
      "clientId": "string",
      "clientSecret": "string",
      "accessToken": "string",
      "oAuthRequest": {
        "authCode": "string",
        "redirectUri": "string"
      }
    },
    "Snowflake": {
      "username": "string",
      "password": "string"
    },
    "Trendmicro": {
      "apiSecretKey": "string"
    },
    "Veeva": {
      "username": "string",
      "password": "string"
    },
    "Zendesk": {
      "clientId": "string",
      "clientSecret": "string",
      "accessToken": "string",
      "oAuthRequest": {
        "authCode": "string",
        "redirectUri": "string"
      }
    },
    "SAPOData": {
      "basicAuthCredentials": {
        "username": "string",
        "password": "string"
      },
      "oAuthCredentials": {
        "clientId": "string",
        "clientSecret": "string",
        "accessToken": "string",
        "refreshToken": "string",
        "oAuthRequest": {
          "authCode": "string",
          "redirectUri": "string"
        }
      }
    },
    "CustomConnector": {
      "authenticationType": "OAUTH2"|"APIKEY"|"BASIC"|"CUSTOM",
      "basic": {
        "username": "string",
        "password": "string"
      },
      "oauth2": {
        "clientId": "string",
        "clientSecret": "string",
        "accessToken": "string",
        "refreshToken": "string",
        "oAuthRequest": {
          "authCode": "string",
          "redirectUri": "string"
        }
      },
      "apiKey": {
        "apiKey": "string",
        "apiSecretKey": "string"
      },
      "custom": {
        "customAuthenticationType": "string",
        "credentialsMap": {"string": "string"
          ...}
      }
    },
    "Pardot": {
      "accessToken": "string",
      "refreshToken": "string",
      "oAuthRequest": {
        "authCode": "string",
        "redirectUri": "string"
      },
      "clientCredentialsArn": "string"
    }
  }
}

--client-token (строка)

Параметр clientToken — это маркер идемпотентности. Он гарантирует, что ваш запрос CreateConnectorProfile завершится только один раз. Вы выбираете значение для передачи. Например, если вы не получаете ответ от запроса, вы можете безопасно повторить запрос со значением параметра clientToken.

Если вы опустите значение clientToken, используемый Amazon Web Services SDK вставит значение за вас. Таким образом, SDK может безопасно повторно отправлять запросы несколько раз после сетевой ошибки. Вы должны предоставить собственное значение для других случаев использования.

Если вы укажете входные параметры, отличающиеся от вашего первого запроса, произойдёт ошибка. Если вы используете другое значение для clientToken, Amazon AppFlow рассматривает это как новый вызов для CreateConnectorProfile. Токен действует в течение 8 часов.

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

Вывод

connectorProfileArn -> (строка)

Amazon Resource Name (ARN) профиля коннектора.

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

Spec-Zone.ru

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