data_integrations

Creates, updates, deletes or gets a data_integration resource or lists data_integrations in a region

Overview

Name	data_integrations
Type	Resource
Description	Resource Type definition for AWS::AppIntegrations::DataIntegration
Id	aws.appintegrations.data_integrations

Fields

Name	Datatype	Description
description	string	The data integration description.
id	string	The unique identifer of the data integration.
data_integration_arn	string	The Amazon Resource Name (ARN) of the data integration.
name	string	The name of the data integration.
kms_key	string	The KMS key of the data integration.
schedule_config	object	The name of the data and how often it should be pulled from the source.
source_uri	string	The URI of the data source.
tags	array	The tags (keys and values) associated with the data integration.
file_configuration	object	The configuration for what files should be pulled from the source.
object_configuration	object	The configuration for what data should be pulled from the source.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, KmsKey, SourceURI, 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 data_integrations in a region.

SELECT
region,
description,
id,
data_integration_arn,
name,
kms_key,
schedule_config,
source_uri,
tags,
file_configuration,
object_configuration
FROM aws.appintegrations.data_integrations
WHERE region = 'us-east-1';

Gets all properties from an individual data_integration.

SELECT
region,
description,
id,
data_integration_arn,
name,
kms_key,
schedule_config,
source_uri,
tags,
file_configuration,
object_configuration
FROM aws.appintegrations.data_integrations
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.appintegrations.data_integrations (
 Name,
 KmsKey,
 SourceURI,
 region
)
SELECT 
'{{ Name }}',
 '{{ KmsKey }}',
 '{{ SourceURI }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.appintegrations.data_integrations (
 Description,
 Name,
 KmsKey,
 ScheduleConfig,
 SourceURI,
 Tags,
 FileConfiguration,
 ObjectConfiguration,
 region
)
SELECT 
 '{{ Description }}',
 '{{ Name }}',
 '{{ KmsKey }}',
 '{{ ScheduleConfig }}',
 '{{ SourceURI }}',
 '{{ Tags }}',
 '{{ FileConfiguration }}',
 '{{ ObjectConfiguration }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: data_integration
    props:
      - name: Description
        value: '{{ Description }}'
      - name: Name
        value: '{{ Name }}'
      - name: KmsKey
        value: '{{ KmsKey }}'
      - name: ScheduleConfig
        value:
          FirstExecutionFrom: '{{ FirstExecutionFrom }}'
          Object: '{{ Object }}'
          ScheduleExpression: '{{ ScheduleExpression }}'
      - name: SourceURI
        value: '{{ SourceURI }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: FileConfiguration
        value:
          Folders:
            - '{{ Folders[0] }}'
          Filters: {}
      - name: ObjectConfiguration
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.appintegrations.data_integrations
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

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

Create

app-integrations:CreateDataIntegration,
app-integrations:TagResource,
appflow:DescribeConnectorProfiles,
appflow:CreateFlow,
appflow:DeleteFlow,
appflow:DescribeConnectorEntity,
appflow:UseConnectorProfile,
appflow:TagResource,
appflow:UntagResource,
kms:CreateGrant,
kms:DescribeKey,
kms:ListAliases,
kms:ListGrants,
kms:ListKeys,
s3:GetBucketNotification,
s3:PutBucketNotification,
s3:GetEncryptionConfiguration

Read

app-integrations:GetDataIntegration,
app-integrations:ListTagsForResource

List

app-integrations:ListDataIntegrations

Update

app-integrations:GetDataIntegration,
app-integrations:UpdateDataIntegration,
app-integrations:TagResource,
app-integrations:UntagResource,
appflow:DescribeConnectorProfiles,
appflow:DeleteFlow,
appflow:DescribeConnectorEntity,
appflow:UseConnectorProfile,
appflow:TagResource,
appflow:UntagResource,
kms:CreateGrant,
kms:DescribeKey,
kms:ListAliases,
kms:ListGrants,
kms:ListKeys

Delete

app-integrations:DeleteDataIntegration,
app-integrations:UntagResource,
appflow:CreateFlow,
appflow:DeleteFlow,
appflow:DescribeConnectorEntity,
appflow:UseConnectorProfile,
appflow:TagResource,
appflow:UntagResource,
kms:CreateGrant,
kms:DescribeKey,
kms:ListAliases,
kms:ListGrants,
kms:ListKeys