integrations

Creates, updates, deletes, gets or lists an integrations resource.

Overview

Name	integrations
Type	Resource
Id	aws.glue.integrations

Fields

The following fields are returned by SELECT queries:

describe_integrations

Name	Datatype	Description
integrations	array	A list of zero-ETL integrations.
marker	string	A value that indicates the starting point for the next set of response records in a subsequent request.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_integrations	select	region		The API is used to retrieve a list of integrations.
create_integration	insert	region, IntegrationName, SourceArn, TargetArn		Creates a Zero-ETL integration in the caller's account between two resources with Amazon Resource Names (ARNs): the SourceArn and TargetArn.
modify_integration	update	region, IntegrationIdentifier		Modifies a Zero-ETL integration in the caller's account.
delete_integration	delete	region		Deletes the specified Zero-ETL integration.

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_integrations

The API is used to retrieve a list of integrations.

SELECT
integrations,
marker
FROM aws.glue.integrations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_integration

Creates a Zero-ETL integration in the caller's account between two resources with Amazon Resource Names (ARNs): the SourceArn and TargetArn.

INSERT INTO aws.glue.integrations (
IntegrationName,
SourceArn,
TargetArn,
Description,
DataFilter,
KmsKeyId,
AdditionalEncryptionContext,
Tags,
IntegrationConfig,
region
)
SELECT 
'{{ IntegrationName }}' /* required */,
'{{ SourceArn }}' /* required */,
'{{ TargetArn }}' /* required */,
'{{ Description }}',
'{{ DataFilter }}',
'{{ KmsKeyId }}',
'{{ AdditionalEncryptionContext }}',
'{{ Tags }}',
'{{ IntegrationConfig }}',
'{{ region }}'
RETURNING
additional_encryption_context,
create_time,
data_filter,
description,
errors,
integration_arn,
integration_config,
integration_name,
kms_key_id,
source_arn,
status,
tags,
target_arn
;

Manifest

# Description fields are for documentation purposes
- name: integrations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the integrations resource.
  - name: IntegrationName
    value: "{{ IntegrationName }}"
    description: |
      A unique name for an integration in Glue.
  - name: SourceArn
    value: "{{ SourceArn }}"
    description: |
      The ARN of the source resource for the integration.
  - name: TargetArn
    value: "{{ TargetArn }}"
    description: |
      The ARN of the target resource for the integration.
  - name: Description
    value: "{{ Description }}"
    description: |
      A description of the integration.
  - name: DataFilter
    value: "{{ DataFilter }}"
    description: |
      Selects source tables for the integration using Maxwell filter syntax.
  - name: KmsKeyId
    value: "{{ KmsKeyId }}"
    description: |
      The ARN of a KMS key used for encrypting the channel.
  - name: AdditionalEncryptionContext
    value: "{{ AdditionalEncryptionContext }}"
    description: |
      An optional set of non-secret key–value pairs that contains additional contextual information for encryption. This can only be provided if KMSKeyId is provided.
  - name: Tags
    description: |
      Metadata assigned to the resource consisting of a list of key-value pairs.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: IntegrationConfig
    description: |
      The configuration settings.
    value:
      RefreshInterval: "{{ RefreshInterval }}"
      SourceProperties: "{{ SourceProperties }}"
      ContinuousSync: {{ ContinuousSync }}

UPDATE examples

modify_integration

Modifies a Zero-ETL integration in the caller's account.

UPDATE aws.glue.integrations
SET 
IntegrationIdentifier = '{{ IntegrationIdentifier }}',
Description = '{{ Description }}',
DataFilter = '{{ DataFilter }}',
IntegrationConfig = '{{ IntegrationConfig }}',
IntegrationName = '{{ IntegrationName }}'
WHERE 
region = '{{ region }}' --required
AND IntegrationIdentifier = '{{ IntegrationIdentifier }}' --required
RETURNING
additional_encryption_context,
create_time,
data_filter,
description,
errors,
integration_arn,
integration_config,
integration_name,
kms_key_id,
source_arn,
status,
tags,
target_arn;

DELETE examples

delete_integration

Deletes the specified Zero-ETL integration.

DELETE FROM aws.glue.integrations
WHERE region = '{{ region }}' --required
;