connectors

Creates, updates, deletes or gets a connector resource or lists connectors in a region

Overview

Name	connectors
Type	Resource
Description	Resource schema for AWS::AppFlow::Connector
Id	aws.appflow.connectors

Fields

Name	Datatype	Description
connector_label	string	The name of the connector. The name is unique for each ConnectorRegistration in your AWS account.
connector_arn	string	The arn of the connector. The arn is unique for each ConnectorRegistration in your AWS account.
connector_provisioning_type	string	The provisioning type of the connector. Currently the only supported value is LAMBDA.
connector_provisioning_config	object	Contains information about the configuration of the connector being registered.
description	string	A description about the connector that's being registered.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ConnectorProvisioningType, ConnectorProvisioningConfig, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all connectors in a region.

SELECT
region,
connector_label,
connector_arn,
connector_provisioning_type,
connector_provisioning_config,
description
FROM aws.appflow.connectors
WHERE region = 'us-east-1';

Gets all properties from an individual connector.

SELECT
region,
connector_label,
connector_arn,
connector_provisioning_type,
connector_provisioning_config,
description
FROM aws.appflow.connectors
WHERE region = 'us-east-1' AND data__Identifier = '<ConnectorLabel>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.appflow.connectors (
 ConnectorProvisioningType,
 ConnectorProvisioningConfig,
 region
)
SELECT 
'{{ ConnectorProvisioningType }}',
 '{{ ConnectorProvisioningConfig }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.appflow.connectors (
 ConnectorLabel,
 ConnectorProvisioningType,
 ConnectorProvisioningConfig,
 Description,
 region
)
SELECT 
 '{{ ConnectorLabel }}',
 '{{ ConnectorProvisioningType }}',
 '{{ ConnectorProvisioningConfig }}',
 '{{ Description }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: connector
    props:
      - name: ConnectorLabel
        value: '{{ ConnectorLabel }}'
      - name: ConnectorProvisioningType
        value: '{{ ConnectorProvisioningType }}'
      - name: ConnectorProvisioningConfig
        value:
          Lambda:
            LambdaArn: '{{ LambdaArn }}'
      - name: Description
        value: '{{ Description }}'

DELETE example

/*+ delete */
DELETE FROM aws.appflow.connectors
WHERE data__Identifier = '<ConnectorLabel>'
AND region = 'us-east-1';

Permissions

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

Create

appflow:RegisterConnector,
lambda:InvokeFunction

Read

appflow:DescribeConnector

Delete

appflow:UnRegisterConnector

List

appflow:ListConnectors

Update

appflow:UpdateConnectorRegistration,
lambda:InvokeFunction