connector_profiles

Creates, updates, deletes, gets or lists a connector_profiles resource.

Overview

Name	connector_profiles
Type	Resource
Id	aws.appflow.connector_profiles

Fields

The following fields are returned by SELECT queries:

describe_connector_profiles

Name	Datatype	Description
connector_profile_details	array	Returns information about the connector profiles associated with the flow.
next_token	string	The pagination token for the next page of data. If nextToken=null, this means that all records have been fetched. (pattern: <code>\S+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_connector_profiles	select	region		Returns a list of connector-profile details matching the provided connector-profile names and connector-types. Both input lists are optional, and you can use them to filter the result. If no names or connector-types are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.
create_connector_profile	insert	region, connectorProfileName, connectorType, connectionMode, connectorProfileConfig		Creates a new connector profile associated with your Amazon Web Services account. There is a soft quota of 100 connector profiles per Amazon Web Services account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel. In each connector profile that you create, you can provide the credentials and properties for only one connector.
update_connector_profile	update	region, connectorProfileName, connectionMode, connectorProfileConfig		Updates a given connector profile associated with your account.
delete_connector_profile	delete	region		Enables you to delete an existing connector profile.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_connector_profiles

Returns a list of connector-profile details matching the provided connector-profile names and connector-types. Both input lists are optional, and you can use them to filter the result. If no names or connector-types are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.

SELECT
connector_profile_details,
next_token
FROM aws.appflow.connector_profiles
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_connector_profile

Creates a new connector profile associated with your Amazon Web Services account. There is a soft quota of 100 connector profiles per Amazon Web Services account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel. In each connector profile that you create, you can provide the credentials and properties for only one connector.

INSERT INTO aws.appflow.connector_profiles (
connectorProfileName,
kmsArn,
connectorType,
connectorLabel,
connectionMode,
connectorProfileConfig,
clientToken,
region
)
SELECT 
'{{ connectorProfileName }}' /* required */,
'{{ kmsArn }}',
'{{ connectorType }}' /* required */,
'{{ connectorLabel }}',
'{{ connectionMode }}' /* required */,
'{{ connectorProfileConfig }}' /* required */,
'{{ clientToken }}',
'{{ region }}'
RETURNING
connector_profile_arn
;

Manifest

# Description fields are for documentation purposes
- name: connector_profiles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connector_profiles resource.
  - name: connectorProfileName
    value: "{{ connectorProfileName }}"
  - name: kmsArn
    value: "{{ kmsArn }}"
  - name: connectorType
    value: "{{ connectorType }}"
    valid_values: ['Salesforce', 'Singular', 'Slack', 'Redshift', 'S3', 'Marketo', 'Googleanalytics', 'Zendesk', 'Servicenow', 'Datadog', 'Trendmicro', 'Snowflake', 'Dynatrace', 'Infornexus', 'Amplitude', 'Veeva', 'EventBridge', 'LookoutMetrics', 'Upsolver', 'Honeycode', 'CustomerProfiles', 'SAPOData', 'CustomConnector', 'Pardot']
  - name: connectorLabel
    value: "{{ connectorLabel }}"
  - name: connectionMode
    value: "{{ connectionMode }}"
    valid_values: ['Public', 'Private']
  - name: connectorProfileConfig
    description: |
      Defines the connector-specific configuration and credentials for the connector profile.
    value:
      connectorProfileProperties:
        Amplitude: "{{ Amplitude }}"
        Datadog:
          instanceUrl: "{{ instanceUrl }}"
        Dynatrace:
          instanceUrl: "{{ instanceUrl }}"
        GoogleAnalytics: "{{ GoogleAnalytics }}"
        Honeycode: "{{ Honeycode }}"
        InforNexus:
          instanceUrl: "{{ instanceUrl }}"
        Marketo:
          instanceUrl: "{{ instanceUrl }}"
        Redshift:
          databaseUrl: "{{ databaseUrl }}"
          bucketName: "{{ bucketName }}"
          bucketPrefix: "{{ bucketPrefix }}"
          roleArn: "{{ roleArn }}"
          dataApiRoleArn: "{{ dataApiRoleArn }}"
          isRedshiftServerless: {{ isRedshiftServerless }}
          clusterIdentifier: "{{ clusterIdentifier }}"
          workgroupName: "{{ workgroupName }}"
          databaseName: "{{ databaseName }}"
        Salesforce:
          instanceUrl: "{{ instanceUrl }}"
          isSandboxEnvironment: {{ isSandboxEnvironment }}
          usePrivateLinkForMetadataAndAuthorization: {{ usePrivateLinkForMetadataAndAuthorization }}
        ServiceNow:
          instanceUrl: "{{ instanceUrl }}"
        Singular: "{{ Singular }}"
        Slack:
          instanceUrl: "{{ instanceUrl }}"
        Snowflake:
          warehouse: "{{ warehouse }}"
          stage: "{{ stage }}"
          bucketName: "{{ bucketName }}"
          bucketPrefix: "{{ bucketPrefix }}"
          privateLinkServiceName: "{{ privateLinkServiceName }}"
          accountName: "{{ accountName }}"
          region: "{{ region }}"
        Trendmicro: "{{ Trendmicro }}"
        Veeva:
          instanceUrl: "{{ instanceUrl }}"
        Zendesk:
          instanceUrl: "{{ instanceUrl }}"
        SAPOData:
          applicationHostUrl: "{{ applicationHostUrl }}"
          applicationServicePath: "{{ applicationServicePath }}"
          portNumber: {{ portNumber }}
          clientNumber: "{{ clientNumber }}"
          logonLanguage: "{{ logonLanguage }}"
          privateLinkServiceName: "{{ privateLinkServiceName }}"
          oAuthProperties:
            tokenUrl: "{{ tokenUrl }}"
            authCodeUrl: "{{ authCodeUrl }}"
            oAuthScopes:
              - "{{ oAuthScopes }}"
          disableSSO: {{ disableSSO }}
        CustomConnector:
          profileProperties: "{{ profileProperties }}"
          oAuth2Properties:
            tokenUrl: "{{ tokenUrl }}"
            oAuth2GrantType: "{{ oAuth2GrantType }}"
            tokenUrlCustomProperties: "{{ tokenUrlCustomProperties }}"
        Pardot:
          instanceUrl: "{{ instanceUrl }}"
          isSandboxEnvironment: {{ isSandboxEnvironment }}
          businessUnitId: "{{ businessUnitId }}"
      connectorProfileCredentials:
        Amplitude:
          apiKey: "{{ apiKey }}"
          secretKey: "{{ secretKey }}"
        Datadog:
          apiKey: "{{ apiKey }}"
          applicationKey: "{{ applicationKey }}"
        Dynatrace:
          apiToken: "{{ apiToken }}"
        GoogleAnalytics:
          clientId: "{{ clientId }}"
          clientSecret: "{{ clientSecret }}"
          accessToken: "{{ accessToken }}"
          refreshToken: "{{ refreshToken }}"
          oAuthRequest:
            authCode: "{{ authCode }}"
            redirectUri: "{{ redirectUri }}"
        Honeycode:
          accessToken: "{{ accessToken }}"
          refreshToken: "{{ refreshToken }}"
          oAuthRequest:
            authCode: "{{ authCode }}"
            redirectUri: "{{ redirectUri }}"
        InforNexus:
          accessKeyId: "{{ accessKeyId }}"
          userId: "{{ userId }}"
          secretAccessKey: "{{ secretAccessKey }}"
          datakey: "{{ datakey }}"
        Marketo:
          clientId: "{{ clientId }}"
          clientSecret: "{{ clientSecret }}"
          accessToken: "{{ accessToken }}"
          oAuthRequest:
            authCode: "{{ authCode }}"
            redirectUri: "{{ redirectUri }}"
        Redshift:
          username: "{{ username }}"
          password: "{{ password }}"
        Salesforce:
          accessToken: "{{ accessToken }}"
          refreshToken: "{{ refreshToken }}"
          oAuthRequest:
            authCode: "{{ authCode }}"
            redirectUri: "{{ redirectUri }}"
          clientCredentialsArn: "{{ clientCredentialsArn }}"
          oAuth2GrantType: "{{ oAuth2GrantType }}"
          jwtToken: "{{ jwtToken }}"
        ServiceNow:
          username: "{{ username }}"
          password: "{{ password }}"
          oAuth2Credentials:
            clientId: "{{ clientId }}"
            clientSecret: "{{ clientSecret }}"
            accessToken: "{{ accessToken }}"
            refreshToken: "{{ refreshToken }}"
            oAuthRequest:
              authCode: "{{ authCode }}"
              redirectUri: "{{ redirectUri }}"
        Singular:
          apiKey: "{{ apiKey }}"
        Slack:
          clientId: "{{ clientId }}"
          clientSecret: "{{ clientSecret }}"
          accessToken: "{{ accessToken }}"
          oAuthRequest:
            authCode: "{{ authCode }}"
            redirectUri: "{{ redirectUri }}"
        Snowflake:
          username: "{{ username }}"
          password: "{{ password }}"
        Trendmicro:
          apiSecretKey: "{{ apiSecretKey }}"
        Veeva:
          username: "{{ username }}"
          password: "{{ password }}"
        Zendesk:
          clientId: "{{ clientId }}"
          clientSecret: "{{ clientSecret }}"
          accessToken: "{{ accessToken }}"
          oAuthRequest:
            authCode: "{{ authCode }}"
            redirectUri: "{{ redirectUri }}"
        SAPOData:
          basicAuthCredentials:
            username: "{{ username }}"
            password: "{{ password }}"
          oAuthCredentials:
            clientId: "{{ clientId }}"
            clientSecret: "{{ clientSecret }}"
            accessToken: "{{ accessToken }}"
            refreshToken: "{{ refreshToken }}"
            oAuthRequest:
              authCode: "{{ authCode }}"
              redirectUri: "{{ redirectUri }}"
        CustomConnector:
          authenticationType: "{{ authenticationType }}"
          basic:
            username: "{{ username }}"
            password: "{{ password }}"
          oauth2:
            clientId: "{{ clientId }}"
            clientSecret: "{{ clientSecret }}"
            accessToken: "{{ accessToken }}"
            refreshToken: "{{ refreshToken }}"
            oAuthRequest:
              authCode: "{{ authCode }}"
              redirectUri: "{{ redirectUri }}"
          apiKey:
            apiKey: "{{ apiKey }}"
            apiSecretKey: "{{ apiSecretKey }}"
          custom:
            customAuthenticationType: "{{ customAuthenticationType }}"
            credentialsMap: "{{ credentialsMap }}"
        Pardot:
          accessToken: "{{ accessToken }}"
          refreshToken: "{{ refreshToken }}"
          oAuthRequest:
            authCode: "{{ authCode }}"
            redirectUri: "{{ redirectUri }}"
          clientCredentialsArn: "{{ clientCredentialsArn }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

update_connector_profile

Updates a given connector profile associated with your account.

UPDATE aws.appflow.connector_profiles
SET 
connectorProfileName = '{{ connectorProfileName }}',
connectionMode = '{{ connectionMode }}',
connectorProfileConfig = '{{ connectorProfileConfig }}',
clientToken = '{{ clientToken }}'
WHERE 
region = '{{ region }}' --required
AND connectorProfileName = '{{ connectorProfileName }}' --required
AND connectionMode = '{{ connectionMode }}' --required
AND connectorProfileConfig = '{{ connectorProfileConfig }}' --required
RETURNING
connector_profile_arn;

DELETE examples

delete_connector_profile

Enables you to delete an existing connector profile.

DELETE FROM aws.appflow.connector_profiles
WHERE region = '{{ region }}' --required
;