connector_profiles

Creates, updates, deletes or gets a connector_profile resource or lists connector_profiles in a region

Overview

Name	connector_profiles
Type	Resource
Description	Resource Type definition for AWS::AppFlow::ConnectorProfile
Id	awscc.appflow.connector_profiles

Fields

get (all properties)

Name	Datatype	Description
connector_profile_arn	string	Unique identifier for connector profile resources
connector_label	string	The label of the connector. The label is unique for each ConnectorRegistration in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/.
connector_profile_name	string	The maximum number of items to retrieve in a single batch.
kms_arn	string	The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
connector_type	string	List of Saas providers that need connector profile to be created
connection_mode	string	Mode in which data transfer should be enabled. Private connection mode is currently enabled for Salesforce, Snowflake, Trendmicro and Singular
▶connector_profile_config	object	Connector specific configurations needed to create connector profile
credentials_arn	string	A unique Arn for Connector-Profile resource
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
connector_profile_name	string	The maximum number of items to retrieve in a single batch.
region	string	AWS region.

For more information, see AWS::AppFlow::ConnectorProfile.

Methods

Name	Resource	Accessible by	Required Params
create_resource	connector_profiles	INSERT	ConnectorProfileName, ConnectionMode, ConnectorType, region
delete_resource	connector_profiles	DELETE	Identifier, region
update_resource	connector_profiles	UPDATE	Identifier, PatchDocument, region
list_resources	connector_profiles_list_only	SELECT	region
get_resource	connector_profiles	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual connector_profile.

SELECT
  region,
  connector_profile_arn,
  connector_label,
  connector_profile_name,
  kms_arn,
  connector_type,
  connection_mode,
  connector_profile_config,
  credentials_arn
FROM awscc.appflow.connector_profiles
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ connector_profile_name }}';

list (identifiers only)

Lists all connector_profiles in a region.

SELECT
  region,
  connector_profile_name
FROM awscc.appflow.connector_profiles_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new connector_profile resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.appflow.connector_profiles (
  ConnectorProfileName,
  ConnectorType,
  ConnectionMode,
  region
)
SELECT
  '{{ connector_profile_name }}',
  '{{ connector_type }}',
  '{{ connection_mode }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.appflow.connector_profiles (
  ConnectorLabel,
  ConnectorProfileName,
  KMSArn,
  ConnectorType,
  ConnectionMode,
  ConnectorProfileConfig,
  region
)
SELECT
  '{{ connector_label }}',
  '{{ connector_profile_name }}',
  '{{ kms_arn }}',
  '{{ connector_type }}',
  '{{ connection_mode }}',
  '{{ connector_profile_config }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: connector_profile
    props:
      - name: connector_label
        value: '{{ connector_label }}'
      - name: connector_profile_name
        value: '{{ connector_profile_name }}'
      - name: kms_arn
        value: '{{ kms_arn }}'
      - name: connector_type
        value: '{{ connector_type }}'
      - name: connection_mode
        value: '{{ connection_mode }}'
      - name: connector_profile_config
        value:
          connector_profile_properties:
            datadog:
              instance_url: '{{ instance_url }}'
            dynatrace:
              instance_url: null
            infor_nexus:
              instance_url: null
            marketo:
              instance_url: null
            redshift:
              database_url: '{{ database_url }}'
              bucket_name: '{{ bucket_name }}'
              bucket_prefix: '{{ bucket_prefix }}'
              role_arn: '{{ role_arn }}'
              is_redshift_serverless: '{{ is_redshift_serverless }}'
              data_api_role_arn: '{{ data_api_role_arn }}'
              cluster_identifier: '{{ cluster_identifier }}'
              workgroup_name: '{{ workgroup_name }}'
              database_name: '{{ database_name }}'
            s_ap_odata:
              application_host_url: '{{ application_host_url }}'
              application_service_path: '{{ application_service_path }}'
              port_number: '{{ port_number }}'
              client_number: '{{ client_number }}'
              logon_language: '{{ logon_language }}'
              private_link_service_name: '{{ private_link_service_name }}'
              oauth_properties:
                auth_code_url: '{{ auth_code_url }}'
                token_url: '{{ token_url }}'
                oauth_scopes:
                  - '{{ oauth_scopes[0] }}'
              disable_ss_o: '{{ disable_ss_o }}'
            salesforce:
              instance_url: null
              is_sandbox_environment: '{{ is_sandbox_environment }}'
              use_private_link_for_metadata_and_authorization: '{{ use_private_link_for_metadata_and_authorization }}'
            pardot:
              instance_url: null
              is_sandbox_environment: '{{ is_sandbox_environment }}'
              business_unit_id: '{{ business_unit_id }}'
            service_now:
              instance_url: null
            slack:
              instance_url: null
            snowflake:
              warehouse: '{{ warehouse }}'
              stage: '{{ stage }}'
              bucket_name: null
              bucket_prefix: null
              private_link_service_name: null
              account_name: '{{ account_name }}'
              region: '{{ region }}'
            veeva:
              instance_url: null
            zendesk:
              instance_url: null
            custom_connector:
              profile_properties: {}
              oauth2_properties:
                token_url: '{{ token_url }}'
                oauth2_grant_type: '{{ oauth2_grant_type }}'
                token_url_custom_properties: {}
          connector_profile_credentials:
            amplitude:
              api_key: '{{ api_key }}'
              secret_key: '{{ secret_key }}'
            datadog:
              api_key: null
              application_key: '{{ application_key }}'
            dynatrace:
              api_token: '{{ api_token }}'
            google_analytics:
              client_id: '{{ client_id }}'
              client_secret: '{{ client_secret }}'
              access_token: '{{ access_token }}'
              refresh_token: '{{ refresh_token }}'
              connector_oauth_request:
                auth_code: '{{ auth_code }}'
                redirect_uri: '{{ redirect_uri }}'
            infor_nexus:
              access_key_id: '{{ access_key_id }}'
              user_id: '{{ user_id }}'
              secret_access_key: '{{ secret_access_key }}'
              datakey: null
            marketo:
              client_id: null
              client_secret: null
              access_token: null
              connector_oauth_request: null
            redshift:
              username: null
              password: '{{ password }}'
            s_ap_odata:
              basic_auth_credentials:
                username: null
                password: null
              oauth_credentials:
                access_token: null
                refresh_token: null
                connector_oauth_request: null
                client_id: null
                client_secret: null
            salesforce:
              access_token: null
              refresh_token: null
              connector_oauth_request: null
              client_credentials_arn: '{{ client_credentials_arn }}'
              oauth2_grant_type: null
              jwt_token: '{{ jwt_token }}'
            pardot:
              access_token: null
              refresh_token: null
              connector_oauth_request: null
              client_credentials_arn: null
            service_now:
              username: null
              password: null
              oauth2_credentials:
                client_id: null
                client_secret: null
                access_token: null
                refresh_token: null
                oauth_request: null
            singular:
              api_key: null
            slack:
              client_id: null
              client_secret: null
              access_token: null
              connector_oauth_request: null
            snowflake:
              username: null
              password: null
            trendmicro:
              api_secret_key: '{{ api_secret_key }}'
            veeva:
              username: null
              password: null
            zendesk:
              client_id: null
              client_secret: null
              access_token: null
              connector_oauth_request: null
            custom_connector:
              authentication_type: '{{ authentication_type }}'
              basic: null
              oauth2: null
              api_key:
                api_key: null
                api_secret_key: null
              custom:
                custom_authentication_type: '{{ custom_authentication_type }}'
                credentials_map: {}

UPDATE example

Use the following StackQL query and manifest file to update a connector_profile resource, using stack-deploy.

/*+ update */
UPDATE awscc.appflow.connector_profiles
SET PatchDocument = string('{{ {
    "KMSArn": kms_arn,
    "ConnectionMode": connection_mode,
    "ConnectorProfileConfig": connector_profile_config
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ connector_profile_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.appflow.connector_profiles
WHERE
  Identifier = '{{ connector_profile_name }}' AND
  region = 'us-east-1';

Permissions

To operate on the connector_profiles resource, the following permissions are required:

Create

appflow:CreateConnectorProfile,
kms:ListKeys,
kms:DescribeKey,
kms:ListAliases,
kms:CreateGrant,
kms:ListGrants,
iam:PassRole,
secretsmanager:CreateSecret,
secretsmanager:GetSecretValue,
secretsmanager:PutResourcePolicy

Delete

appflow:DeleteConnectorProfile

List

appflow:DescribeConnectorProfiles

Read

appflow:DescribeConnectorProfiles

Update

appflow:UpdateConnectorProfile,
kms:ListKeys,
kms:DescribeKey,
kms:ListAliases,
kms:CreateGrant,
kms:ListGrants,
iam:PassRole,
secretsmanager:CreateSecret,
secretsmanager:GetSecretValue,
secretsmanager:PutResourcePolicy