data_integrations

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

Overview

Name	`data_integrations`
Type	Resource
Id	`aws.appintegrations.data_integrations`

Fields

The following fields are returned by SELECT queries:

get_data_integration
list_data_integrations

Name	Datatype	Description
`arn`	`string`	The Amazon Resource Name (ARN) for the DataIntegration. (pattern: <code>^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$</code>)
`description`	`string`	The KMS key ARN for the DataIntegration. (pattern: <code>.*</code>)
`file_configuration`	`object`	The configuration for what files should be pulled from the source.
`id`	`string`	A unique identifier. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
`kms_key`	`string`	The KMS key ARN for the DataIntegration. (pattern: <code>.\S.</code>)
`name`	`string`	The name of the DataIntegration. (pattern: <code>^[a-zA-Z0-9/._-]+$</code>)
`object_configuration`	`object`	The configuration for what data should be pulled from the source.
`schedule_configuration`	`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. (pattern: <code>^(\w+://[\w.-]+[\w/!@#+=.-]+$)\|(\w+://[\w.-]+[\w/!@#+=.-]+[\w/!@#+=.-]+[\w/!@#+=.,-]+$)</code>)
`tags`	`object`	The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Name	Datatype	Description
`arn`	`string`	The Amazon Resource Name (ARN) of the DataIntegration. (pattern: <code>^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$</code>)
`name`	`string`	The name of the DataIntegration. (pattern: <code>^[a-zA-Z0-9/._-]+$</code>)
`source_uri`	`string`	The URI of the data source. (pattern: <code>^(\w+://[\w.-]+[\w/!@#+=.-]+$)\|(\w+://[\w.-]+[\w/!@#+=.-]+[\w/!@#+=.-]+[\w/!@#+=.,-]+$)</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_data_integration`	`select`	`identifier`, `region`		Returns information about the DataIntegration. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
`list_data_integrations`	`select`	`region`	`nextToken`, `maxResults`	Returns a paginated list of DataIntegrations in the account. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
`create_data_integration`	`insert`	`region`, `KmsKey`		Creates and persists a DataIntegration resource. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
`update_data_integration`	`update`	`identifier`, `region`		Updates the description of a DataIntegration. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
`delete_data_integration`	`delete`	`identifier`, `region`		Deletes the DataIntegration. Only DataIntegrations that don't have any DataIntegrationAssociations can be deleted. Deleting a DataIntegration also deletes the underlying Amazon AppFlow flow and service linked role. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.

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
`identifier`	`string`	A unique identifier for the DataIntegration.
`region`	`string`	AWS region (default: us-east-1)
`maxResults`	`integer`	The maximum number of results to return per page.
`nextToken`	`string`	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

`SELECT` examples

get_data_integration
list_data_integrations

Returns information about the DataIntegration. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.

SELECT
arn,
description,
file_configuration,
id,
kms_key,
name,
object_configuration,
schedule_configuration,
source_uri,
tags
FROM aws.appintegrations.data_integrations
WHERE identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

Returns a paginated list of DataIntegrations in the account. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.

SELECT
arn,
name,
source_uri
FROM aws.appintegrations.data_integrations
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

`INSERT` examples

create_data_integration
Manifest

Creates and persists a DataIntegration resource. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.

INSERT INTO aws.appintegrations.data_integrations (
Name,
Description,
KmsKey,
SourceURI,
ScheduleConfig,
Tags,
ClientToken,
FileConfiguration,
ObjectConfiguration,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ KmsKey }}' /* required */,
'{{ SourceURI }}',
'{{ ScheduleConfig }}',
'{{ Tags }}',
'{{ ClientToken }}',
'{{ FileConfiguration }}',
'{{ ObjectConfiguration }}',
'{{ region }}'
RETURNING
arn,
client_token,
description,
file_configuration,
id,
kms_key,
name,
object_configuration,
schedule_configuration,
source_uri,
tags
;

# Description fields are for documentation purposes
- name: data_integrations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_integrations resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: KmsKey
    value: "{{ KmsKey }}"
  - name: SourceURI
    value: "{{ SourceURI }}"
  - name: ScheduleConfig
    description: |
      The name of the data and how often it should be pulled from the source.
    value:
      FirstExecutionFrom: "{{ FirstExecutionFrom }}"
      Object: "{{ Object }}"
      ScheduleExpression: "{{ ScheduleExpression }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: FileConfiguration
    description: |
      The configuration for what files should be pulled from the source.
    value:
      Folders:
        - "{{ Folders }}"
      Filters: "{{ Filters }}"
  - name: ObjectConfiguration
    value: "{{ ObjectConfiguration }}"
    description: |
      The configuration for what data should be pulled from the source.

`UPDATE` examples

update_data_integration

Updates the description of a DataIntegration. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.

UPDATE aws.appintegrations.data_integrations
SET 
Name = '{{ Name }}',
Description = '{{ Description }}'
WHERE 
identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required;

`DELETE` examples

delete_data_integration

Deletes the DataIntegration. Only DataIntegrations that don't have any DataIntegrationAssociations can be deleted. Deleting a DataIntegration also deletes the underlying Amazon AppFlow flow and service linked role. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.

DELETE FROM aws.appintegrations.data_integrations
WHERE identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​