connectors

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

Overview

Name	connectors
Type	Resource
Id	aws.appflow.connectors

Fields

The following fields are returned by SELECT queries:

describe_connector

Name	Datatype	Description
authentication_config	object	The authentication config required for the connector.
can_use_as_destination	boolean	Specifies whether the connector can be used as a destination.
can_use_as_source	boolean	Specifies whether the connector can be used as a source.
connector_arn	string	The Amazon Resource Name (ARN) for the registered connector. (pattern: <code>arn:aws:.:.:[0-9]+:.*</code>)
connector_description	string	A description about the connector. (pattern: <code>[\w!@#-.?,\s]*</code>)
connector_label	string	The label used for registering the connector. (pattern: <code>[a-zA-Z0-9][\w!@#.-]+</code>)
connector_metadata	object	Specifies connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.
connector_modes	array	The connection modes that the connector supports.
connector_name	string	The connector name. (pattern: <code>.*</code>)
connector_owner	string	The owner who developed the connector. (pattern: <code>.*</code>)
connector_provisioning_config	object	The configuration required for registering the connector.
connector_provisioning_type	string	The provisioning type used to register the connector. (LAMBDA)
connector_runtime_settings	array	The required connector runtime settings.
connector_type	string	The connector type. (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_version	string	The connector version. (pattern: <code>\S+</code>)
is_private_link_enabled	boolean	Specifies if PrivateLink is enabled for that connector.
is_private_link_endpoint_url_required	boolean	Specifies if a PrivateLink endpoint URL is required.
logo_url	string	Logo URL of the connector. (pattern: <code>^(https?|ftp|file):​//[-a-zA-Z0-9+&@#/%?=_|!:,.;]*[-a-zA-Z0-9+&@#/%=_|]</code>)
registered_at	string (date-time)	The date on which the connector was registered.
registered_by	string	Information about who registered the connector. (pattern: <code>\S+</code>)
supported_api_versions	array	A list of API versions that are supported by the connector.
supported_data_transfer_apis	array	The APIs of the connector application that Amazon AppFlow can use to transfer your data.
supported_data_transfer_types	array	The data transfer types that the connector supports. RECORD Structured records. FILE Files or binary data.
supported_destination_connectors	array	Lists the connectors that are available for use as destinations.
supported_operators	array	A list of operators supported by the connector.
supported_scheduling_frequencies	array	Specifies the supported flow frequency for that connector.
supported_trigger_types	array	Specifies the supported trigger types for the flow.
supported_write_operations	array	A list of write operations supported by the connector.

describe_connectors

Name	Datatype	Description
connector_configurations	object	The configuration that is applied to the connectors used in the flow.
connectors	array	Information about the connectors supported in Amazon AppFlow.
next_token	string	The pagination token for the next page of data. (pattern: <code>\S+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_connector	select	region		Describes the given custom connector registered in your Amazon Web Services account. This API can be used for custom connectors that are registered in your account and also for Amazon authored connectors.
describe_connectors	select	region		Describes the connectors vended by Amazon AppFlow for specified connector types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response contains a nextToken object, which can be be passed in to the next call to the DescribeConnectors API operation to retrieve the next page.
register_connector	insert	region		Registers a new custom connector with your Amazon Web Services account. Before you can register the connector, you must deploy the associated AWS lambda function in your account.
update_connector_registration	update	region, connectorLabel		Updates a custom connector that you've previously registered. This operation updates the connector with one of the following: The latest version of the AWS Lambda function that's assigned to the connector A new AWS Lambda function that you specify
list_connectors	exec	region		Returns the list of all registered custom connectors in your Amazon Web Services account. This API lists only custom connectors registered in this account, not the Amazon Web Services authored connectors.
reset_connector_metadata_cache	exec	region		Resets metadata about your connector entities that Amazon AppFlow stored in its cache. Use this action when you want Amazon AppFlow to return the latest information about the data that you have in a source application. Amazon AppFlow returns metadata about your entities when you use the ListConnectorEntities or DescribeConnectorEntities actions. Following these actions, Amazon AppFlow caches the metadata to reduce the number of API requests that it must send to the source application. Amazon AppFlow automatically resets the cache once every hour, but you can use this action when you want to get the latest metadata right away.

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

Describes the given custom connector registered in your Amazon Web Services account. This API can be used for custom connectors that are registered in your account and also for Amazon authored connectors.

SELECT
authentication_config,
can_use_as_destination,
can_use_as_source,
connector_arn,
connector_description,
connector_label,
connector_metadata,
connector_modes,
connector_name,
connector_owner,
connector_provisioning_config,
connector_provisioning_type,
connector_runtime_settings,
connector_type,
connector_version,
is_private_link_enabled,
is_private_link_endpoint_url_required,
logo_url,
registered_at,
registered_by,
supported_api_versions,
supported_data_transfer_apis,
supported_data_transfer_types,
supported_destination_connectors,
supported_operators,
supported_scheduling_frequencies,
supported_trigger_types,
supported_write_operations
FROM aws.appflow.connectors
WHERE region = '{{ region }}' -- required
;

describe_connectors

Describes the connectors vended by Amazon AppFlow for specified connector types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response contains a nextToken object, which can be be passed in to the next call to the DescribeConnectors API operation to retrieve the next page.

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

INSERT examples

register_connector

Registers a new custom connector with your Amazon Web Services account. Before you can register the connector, you must deploy the associated AWS lambda function in your account.

INSERT INTO aws.appflow.connectors (
connectorLabel,
description,
connectorProvisioningType,
connectorProvisioningConfig,
clientToken,
region
)
SELECT 
'{{ connectorLabel }}',
'{{ description }}',
'{{ connectorProvisioningType }}',
'{{ connectorProvisioningConfig }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
connector_arn
;

Manifest

# Description fields are for documentation purposes
- name: connectors
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connectors resource.
  - name: connectorLabel
    value: "{{ connectorLabel }}"
  - name: description
    value: "{{ description }}"
  - name: connectorProvisioningType
    value: "{{ connectorProvisioningType }}"
    description: |
      The type of provisioning that the connector supports, such as Lambda.
    valid_values: ['LAMBDA']
  - name: connectorProvisioningConfig
    description: |
      Contains information about the configuration of the connector being registered.
    value:
      lambda:
        lambdaArn: "{{ lambdaArn }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

update_connector_registration

Updates a custom connector that you've previously registered. This operation updates the connector with one of the following: The latest version of the AWS Lambda function that's assigned to the connector A new AWS Lambda function that you specify

UPDATE aws.appflow.connectors
SET 
connectorLabel = '{{ connectorLabel }}',
description = '{{ description }}',
connectorProvisioningConfig = '{{ connectorProvisioningConfig }}',
clientToken = '{{ clientToken }}'
WHERE 
region = '{{ region }}' --required
AND connectorLabel = '{{ connectorLabel }}' --required
RETURNING
connector_arn;

Lifecycle Methods

list_connectors

Returns the list of all registered custom connectors in your Amazon Web Services account. This API lists only custom connectors registered in this account, not the Amazon Web Services authored connectors.

EXEC aws.appflow.connectors.list_connectors 
@region='{{ region }}' --required 
@@json=
'{
"maxResults": {{ maxResults }}, 
"nextToken": "{{ nextToken }}"
}'
;

reset_connector_metadata_cache

Resets metadata about your connector entities that Amazon AppFlow stored in its cache. Use this action when you want Amazon AppFlow to return the latest information about the data that you have in a source application. Amazon AppFlow returns metadata about your entities when you use the ListConnectorEntities or DescribeConnectorEntities actions. Following these actions, Amazon AppFlow caches the metadata to reduce the number of API requests that it must send to the source application. Amazon AppFlow automatically resets the cache once every hour, but you can use this action when you want to get the latest metadata right away.

EXEC aws.appflow.connectors.reset_connector_metadata_cache 
@region='{{ region }}' --required 
@@json=
'{
"connectorProfileName": "{{ connectorProfileName }}", 
"connectorType": "{{ connectorType }}", 
"connectorEntityName": "{{ connectorEntityName }}", 
"entitiesPath": "{{ entitiesPath }}", 
"apiVersion": "{{ apiVersion }}"
}'
;