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	awscc.appflow.connectors

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
connector_label	string	The name of the connector. The name is unique for each ConnectorRegistration in your AWS account.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	connectors	INSERT	ConnectorProvisioningType, ConnectorProvisioningConfig, region
delete_resource	connectors	DELETE	Identifier, region
update_resource	connectors	UPDATE	Identifier, PatchDocument, region
list_resources	connectors_list_only	SELECT	region
get_resource	connectors	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual connector.

SELECT
  region,
  connector_label,
  connector_arn,
  connector_provisioning_type,
  connector_provisioning_config,
  description
FROM awscc.appflow.connectors
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ connector_label }}';

list (identifiers only)

Lists all connectors in a region.

SELECT
  region,
  connector_label
FROM awscc.appflow.connectors_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.appflow.connectors (
  ConnectorProvisioningType,
  ConnectorProvisioningConfig,
  region
)
SELECT
  '{{ connector_provisioning_type }}',
  '{{ connector_provisioning_config }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.appflow.connectors (
  ConnectorLabel,
  ConnectorProvisioningType,
  ConnectorProvisioningConfig,
  Description,
  region
)
SELECT
  '{{ connector_label }}',
  '{{ connector_provisioning_type }}',
  '{{ connector_provisioning_config }}',
  '{{ description }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: connector
  props:
    - name: connector_label
      value: '{{ connector_label }}'
    - name: connector_provisioning_type
      value: '{{ connector_provisioning_type }}'
    - name: connector_provisioning_config
      value:
        lambda:
          lambda_arn: '{{ lambda_arn }}'
    - name: description
      value: '{{ description }}'

UPDATE example

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

/*+ update */
UPDATE awscc.appflow.connectors
SET PatchDocument = string('{{ {
    "ConnectorProvisioningType": connector_provisioning_type,
    "ConnectorProvisioningConfig": connector_provisioning_config,
    "Description": description
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ connector_label }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.appflow.connectors
WHERE
  Identifier = '{{ connector_label }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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