data_integration_associations

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

Overview

Name	data_integration_associations
Type	Resource
Id	aws.appintegrations.data_integration_associations

Fields

The following fields are returned by SELECT queries:

list_data_integration_associations

Name	Datatype	Description
client_id	string	The identifier for the client that is associated with the DataIntegration association. (pattern: <code>.*</code>)
data_integration_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>)
data_integration_association_arn	string	The Amazon Resource Name (ARN) of the DataIntegration association. (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>)
destination_uri	string	The URI of the data destination. (pattern: <code>^(\w+://[\w.-]+[\w/!@#+=.-]+$)|(\w+://[\w.-]+[\w/!@#+=.-]+[\w/!@#+=.-]+[\w/!@#+=.,-]+$)</code>)
execution_configuration	object	The configuration for how the files should be pulled from the source.
last_execution_status	object	The execution status of the last job.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_data_integration_associations	select	identifier, region	nextToken, maxResults	Returns a paginated list of DataIntegration associations 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_association	insert	identifier, region		Creates and persists a DataIntegrationAssociation resource.
update_data_integration_association	update	identifier, data_integration_association_identifier, region, ExecutionConfiguration		Updates and persists a DataIntegrationAssociation resource. Updating a DataIntegrationAssociation with ExecutionConfiguration will rerun the on-demand job.

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
data_integration_association_identifier	string	A unique identifier. of the DataIntegrationAssociation resource
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

list_data_integration_associations

Returns a paginated list of DataIntegration associations 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
client_id,
data_integration_arn,
data_integration_association_arn,
destination_uri,
execution_configuration,
last_execution_status
FROM aws.appintegrations.data_integration_associations
WHERE identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_data_integration_association

Creates and persists a DataIntegrationAssociation resource.

INSERT INTO aws.appintegrations.data_integration_associations (
ClientId,
ObjectConfiguration,
DestinationURI,
ClientAssociationMetadata,
ClientToken,
ExecutionConfiguration,
identifier,
region
)
SELECT 
'{{ ClientId }}',
'{{ ObjectConfiguration }}',
'{{ DestinationURI }}',
'{{ ClientAssociationMetadata }}',
'{{ ClientToken }}',
'{{ ExecutionConfiguration }}',
'{{ identifier }}',
'{{ region }}'
RETURNING
data_integration_arn,
data_integration_association_id
;

Manifest

# Description fields are for documentation purposes
- name: data_integration_associations
props:
  - name: identifier
    value: "{{ identifier }}"
    description: Required parameter for the data_integration_associations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_integration_associations resource.
  - name: ClientId
    value: "{{ ClientId }}"
  - name: ObjectConfiguration
    value: "{{ ObjectConfiguration }}"
    description: |
      The configuration for what data should be pulled from the source.
  - name: DestinationURI
    value: "{{ DestinationURI }}"
  - name: ClientAssociationMetadata
    value: "{{ ClientAssociationMetadata }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: ExecutionConfiguration
    description: |
      The configuration for how the files should be pulled from the source.
    value:
      ExecutionMode: "{{ ExecutionMode }}"
      OnDemandConfiguration:
        StartTime: "{{ StartTime }}"
        EndTime: "{{ EndTime }}"
      ScheduleConfiguration:
        FirstExecutionFrom: "{{ FirstExecutionFrom }}"
        Object: "{{ Object }}"
        ScheduleExpression: "{{ ScheduleExpression }}"

UPDATE examples

update_data_integration_association

Updates and persists a DataIntegrationAssociation resource. Updating a DataIntegrationAssociation with ExecutionConfiguration will rerun the on-demand job.

UPDATE aws.appintegrations.data_integration_associations
SET 
ExecutionConfiguration = '{{ ExecutionConfiguration }}'
WHERE 
identifier = '{{ identifier }}' --required
AND data_integration_association_identifier = '{{ data_integration_association_identifier }}' --required
AND region = '{{ region }}' --required
AND ExecutionConfiguration = '{{ ExecutionConfiguration }}' --required;