CreateConnectorProfileRequest

CreateConnectorProfileRequest schema from Amazon AppFlow API

ConnectorsData FlowData IntegrationETLIntegrationSaaSData Transfer

Properties

Name	Type	Description
connectorProfileName	string	The name of the connector profile. The name is unique for each ConnectorProfile in your AWS account.
clientToken	string	Idempotency token.
connectorType	string	The type of connector, such as Salesforce, Marketo, and so on.
connectorLabel	string	The label of the connector. The label is unique for each ConnectorRegistration in your AWS account.
connectionMode	string	Indicates the connection mode and specifies whether it is public or private.
kmsArn	string	The ARN of the KMS key to use to encrypt your connector profile credentials.
connectorProfileConfig	object	Defines the connector-specific configuration and credentials.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-appflow/refs/heads/main/json-schema/appflow-create-connector-profile-request-schema.json",
  "title": "CreateConnectorProfileRequest",
  "description": "CreateConnectorProfileRequest schema from Amazon AppFlow API",
  "type": "object",
  "properties": {
    "connectorProfileName": {
      "type": "string",
      "maxLength": 256,
      "example": "my-salesforce-profile",
      "description": "The name of the connector profile. The name is unique for each ConnectorProfile in your AWS account."
    },
    "clientToken": {
      "type": "string",
      "example": "client-token-500123",
      "description": "Idempotency token."
    },
    "connectorType": {
      "type": "string",
      "example": "Salesforce",
      "description": "The type of connector, such as Salesforce, Marketo, and so on."
    },
    "connectorLabel": {
      "type": "string",
      "example": "MyCustomConnector",
      "description": "The label of the connector. The label is unique for each ConnectorRegistration in your AWS account."
    },
    "connectionMode": {
      "type": "string",
      "enum": [
        "Public",
        "Private"
      ],
      "example": "Public",
      "description": "Indicates the connection mode and specifies whether it is public or private."
    },
    "kmsArn": {
      "type": "string",
      "example": "arn:aws:kms:us-east-1:123456789012:key/mrk-1234abcd",
      "description": "The ARN of the KMS key to use to encrypt your connector profile credentials."
    },
    "connectorProfileConfig": {
      "type": "object",
      "description": "Defines the connector-specific configuration and credentials."
    }
  },
  "required": [
    "connectorProfileName",
    "connectorType",
    "connectionMode",
    "connectorProfileConfig"
  ]
}