interface ConnectorProfileConfigProperty

Language	Type name
.NET	Amazon.CDK.AWS.AppFlow.CfnConnectorProfile.ConnectorProfileConfigProperty
Java	software.amazon.awscdk.services.appflow.CfnConnectorProfile.ConnectorProfileConfigProperty
Python	aws_cdk.aws_appflow.CfnConnectorProfile.ConnectorProfileConfigProperty
TypeScript	@aws-cdk/aws-appflow » CfnConnectorProfile » ConnectorProfileConfigProperty

Defines the connector-specific configuration and credentials for the connector profile.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as appflow from '@aws-cdk/aws-appflow';
const connectorProfileConfigProperty: appflow.CfnConnectorProfile.ConnectorProfileConfigProperty = {
  connectorProfileCredentials: {
    amplitude: {
      apiKey: 'apiKey',
      secretKey: 'secretKey',
    },
    customConnector: {
      authenticationType: 'authenticationType',

      // the properties below are optional
      apiKey: {
        apiKey: 'apiKey',

        // the properties below are optional
        apiSecretKey: 'apiSecretKey',
      },
      basic: {
        password: 'password',
        username: 'username',
      },
      custom: {
        customAuthenticationType: 'customAuthenticationType',

        // the properties below are optional
        credentialsMap: {
          credentialsMapKey: 'credentialsMap',
        },
      },
      oauth2: {
        accessToken: 'accessToken',
        clientId: 'clientId',
        clientSecret: 'clientSecret',
        oAuthRequest: {
          authCode: 'authCode',
          redirectUri: 'redirectUri',
        },
        refreshToken: 'refreshToken',
      },
    },
    datadog: {
      apiKey: 'apiKey',
      applicationKey: 'applicationKey',
    },
    dynatrace: {
      apiToken: 'apiToken',
    },
    googleAnalytics: {
      clientId: 'clientId',
      clientSecret: 'clientSecret',

      // the properties below are optional
      accessToken: 'accessToken',
      connectorOAuthRequest: {
        authCode: 'authCode',
        redirectUri: 'redirectUri',
      },
      refreshToken: 'refreshToken',
    },
    inforNexus: {
      accessKeyId: 'accessKeyId',
      datakey: 'datakey',
      secretAccessKey: 'secretAccessKey',
      userId: 'userId',
    },
    marketo: {
      clientId: 'clientId',
      clientSecret: 'clientSecret',

      // the properties below are optional
      accessToken: 'accessToken',
      connectorOAuthRequest: {
        authCode: 'authCode',
        redirectUri: 'redirectUri',
      },
    },
    pardot: {
      accessToken: 'accessToken',
      clientCredentialsArn: 'clientCredentialsArn',
      connectorOAuthRequest: {
        authCode: 'authCode',
        redirectUri: 'redirectUri',
      },
      refreshToken: 'refreshToken',
    },
    redshift: {
      password: 'password',
      username: 'username',
    },
    salesforce: {
      accessToken: 'accessToken',
      clientCredentialsArn: 'clientCredentialsArn',
      connectorOAuthRequest: {
        authCode: 'authCode',
        redirectUri: 'redirectUri',
      },
      jwtToken: 'jwtToken',
      oAuth2GrantType: 'oAuth2GrantType',
      refreshToken: 'refreshToken',
    },
    sapoData: {
      basicAuthCredentials: {
        password: 'password',
        username: 'username',
      },
      oAuthCredentials: {
        accessToken: 'accessToken',
        clientId: 'clientId',
        clientSecret: 'clientSecret',
        connectorOAuthRequest: {
          authCode: 'authCode',
          redirectUri: 'redirectUri',
        },
        refreshToken: 'refreshToken',
      },
    },
    serviceNow: {
      password: 'password',
      username: 'username',
    },
    singular: {
      apiKey: 'apiKey',
    },
    slack: {
      clientId: 'clientId',
      clientSecret: 'clientSecret',

      // the properties below are optional
      accessToken: 'accessToken',
      connectorOAuthRequest: {
        authCode: 'authCode',
        redirectUri: 'redirectUri',
      },
    },
    snowflake: {
      password: 'password',
      username: 'username',
    },
    trendmicro: {
      apiSecretKey: 'apiSecretKey',
    },
    veeva: {
      password: 'password',
      username: 'username',
    },
    zendesk: {
      clientId: 'clientId',
      clientSecret: 'clientSecret',

      // the properties below are optional
      accessToken: 'accessToken',
      connectorOAuthRequest: {
        authCode: 'authCode',
        redirectUri: 'redirectUri',
      },
    },
  },
  connectorProfileProperties: {
    customConnector: {
      oAuth2Properties: {
        oAuth2GrantType: 'oAuth2GrantType',
        tokenUrl: 'tokenUrl',
        tokenUrlCustomProperties: {
          tokenUrlCustomPropertiesKey: 'tokenUrlCustomProperties',
        },
      },
      profileProperties: {
        profilePropertiesKey: 'profileProperties',
      },
    },
    datadog: {
      instanceUrl: 'instanceUrl',
    },
    dynatrace: {
      instanceUrl: 'instanceUrl',
    },
    inforNexus: {
      instanceUrl: 'instanceUrl',
    },
    marketo: {
      instanceUrl: 'instanceUrl',
    },
    pardot: {
      businessUnitId: 'businessUnitId',

      // the properties below are optional
      instanceUrl: 'instanceUrl',
      isSandboxEnvironment: false,
    },
    redshift: {
      bucketName: 'bucketName',
      roleArn: 'roleArn',

      // the properties below are optional
      bucketPrefix: 'bucketPrefix',
      clusterIdentifier: 'clusterIdentifier',
      dataApiRoleArn: 'dataApiRoleArn',
      databaseName: 'databaseName',
      databaseUrl: 'databaseUrl',
      isRedshiftServerless: false,
      workgroupName: 'workgroupName',
    },
    salesforce: {
      instanceUrl: 'instanceUrl',
      isSandboxEnvironment: false,
      usePrivateLinkForMetadataAndAuthorization: false,
    },
    sapoData: {
      applicationHostUrl: 'applicationHostUrl',
      applicationServicePath: 'applicationServicePath',
      clientNumber: 'clientNumber',
      logonLanguage: 'logonLanguage',
      oAuthProperties: {
        authCodeUrl: 'authCodeUrl',
        oAuthScopes: ['oAuthScopes'],
        tokenUrl: 'tokenUrl',
      },
      portNumber: 123,
      privateLinkServiceName: 'privateLinkServiceName',
    },
    serviceNow: {
      instanceUrl: 'instanceUrl',
    },
    slack: {
      instanceUrl: 'instanceUrl',
    },
    snowflake: {
      bucketName: 'bucketName',
      stage: 'stage',
      warehouse: 'warehouse',

      // the properties below are optional
      accountName: 'accountName',
      bucketPrefix: 'bucketPrefix',
      privateLinkServiceName: 'privateLinkServiceName',
      region: 'region',
    },
    veeva: {
      instanceUrl: 'instanceUrl',
    },
    zendesk: {
      instanceUrl: 'instanceUrl',
    },
  },
};

Properties

Name	Type	Description
connectorProfileCredentials?	IResolvable | ConnectorProfileCredentialsProperty	The connector-specific credentials required by each connector.
connectorProfileProperties?	IResolvable | ConnectorProfilePropertiesProperty	The connector-specific properties of the profile configuration.

---

connectorProfileCredentials?

Type: IResolvable | ConnectorProfileCredentialsProperty (optional)

The connector-specific credentials required by each connector.

---

connectorProfileProperties?

Type: IResolvable | ConnectorProfilePropertiesProperty (optional)

The connector-specific properties of the profile configuration.