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	awscc.appintegrations.data_integrations

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string	The unique identifer of the data integration.
region	string	AWS region.

For more information, see AWS::AppIntegrations::DataIntegration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	data_integrations	INSERT	Name, KmsKey, SourceURI, region
delete_resource	data_integrations	DELETE	Identifier, region
update_resource	data_integrations	UPDATE	Identifier, PatchDocument, region
list_resources	data_integrations_list_only	SELECT	region
get_resource	data_integrations	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.appintegrations.data_integrations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all data_integrations in a region.

SELECT
  region,
  id
FROM awscc.appintegrations.data_integrations_list_only
WHERE
  region = '{{ region }}';

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 awscc.appintegrations.data_integrations (
  Name,
  KmsKey,
  SourceURI,
  region
)
SELECT
  '{{ name }}',
  '{{ kms_key }}',
  '{{ source_uri }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.appintegrations.data_integrations (
  Description,
  Name,
  KmsKey,
  ScheduleConfig,
  SourceURI,
  Tags,
  FileConfiguration,
  ObjectConfiguration,
  region
)
SELECT
  '{{ description }}',
  '{{ name }}',
  '{{ kms_key }}',
  '{{ schedule_config }}',
  '{{ source_uri }}',
  '{{ tags }}',
  '{{ file_configuration }}',
  '{{ object_configuration }}',
  '{{ 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: data_integration
  props:
    - name: description
      value: '{{ description }}'
    - name: name
      value: '{{ name }}'
    - name: kms_key
      value: '{{ kms_key }}'
    - name: schedule_config
      value:
        first_execution_from: '{{ first_execution_from }}'
        object: '{{ object }}'
        schedule_expression: '{{ schedule_expression }}'
    - name: source_uri
      value: '{{ source_uri }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: file_configuration
      value:
        folders:
          - '{{ folders[0] }}'
        filters: {}
    - name: object_configuration
      value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.appintegrations.data_integrations
SET PatchDocument = string('{{ {
    "Description": description,
    "Name": name,
    "Tags": tags,
    "FileConfiguration": file_configuration,
    "ObjectConfiguration": object_configuration
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.appintegrations.data_integrations
WHERE
  Identifier = '{{ id }}' 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 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