integrations

Creates, updates, deletes or gets an integration resource or lists integrations in a region

Overview

Name	integrations
Type	Resource
Description	Creates a zero-ETL integration with Amazon Redshift.
Id	aws.rds.integrations

Fields

Name	Datatype	Description
integration_name	string	The name of the integration.
description	string	The description of the integration.
tags	array	An array of key-value pairs to apply to this resource.
data_filter	string	The data filter for the integration.
source_arn	string	The Amazon Resource Name (ARN) of the Aurora DB cluster to use as the source for replication.
target_arn	string	The ARN of the Redshift data warehouse to use as the target for replication.
integration_arn	string	The ARN of the integration.
kms_key_id	string	An optional AWS Key Management System (AWS KMS) key ARN for the key used to to encrypt the integration. The resource accepts the key ID and the key ARN forms. The key ID form can be used if the KMS key is owned by te same account. If the KMS key belongs to a different account than the calling account, the full key ARN must be specified. Do not use the key alias or the key alias ARN as this will cause a false drift of the resource.
additional_encryption_context	object	An optional set of non-secret key–value pairs that contains additional contextual information about the data.
create_time	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	SourceArn, TargetArn, 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 integrations in a region.

SELECT
region,
integration_name,
description,
tags,
data_filter,
source_arn,
target_arn,
integration_arn,
kms_key_id,
additional_encryption_context,
create_time
FROM aws.rds.integrations
WHERE region = 'us-east-1';

Gets all properties from an individual integration.

SELECT
region,
integration_name,
description,
tags,
data_filter,
source_arn,
target_arn,
integration_arn,
kms_key_id,
additional_encryption_context,
create_time
FROM aws.rds.integrations
WHERE region = 'us-east-1' AND data__Identifier = '<IntegrationArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.rds.integrations (
 SourceArn,
 TargetArn,
 region
)
SELECT 
'{{ SourceArn }}',
 '{{ TargetArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.rds.integrations (
 IntegrationName,
 Description,
 Tags,
 DataFilter,
 SourceArn,
 TargetArn,
 KMSKeyId,
 AdditionalEncryptionContext,
 region
)
SELECT 
 '{{ IntegrationName }}',
 '{{ Description }}',
 '{{ Tags }}',
 '{{ DataFilter }}',
 '{{ SourceArn }}',
 '{{ TargetArn }}',
 '{{ KMSKeyId }}',
 '{{ AdditionalEncryptionContext }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: integration
    props:
      - name: IntegrationName
        value: '{{ IntegrationName }}'
      - name: Description
        value: '{{ Description }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: DataFilter
        value: '{{ DataFilter }}'
      - name: SourceArn
        value: '{{ SourceArn }}'
      - name: TargetArn
        value: '{{ TargetArn }}'
      - name: KMSKeyId
        value: '{{ KMSKeyId }}'
      - name: AdditionalEncryptionContext
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.rds.integrations
WHERE data__Identifier = '<IntegrationArn>'
AND region = 'us-east-1';

Permissions

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

Create

rds:CreateIntegration,
rds:DescribeIntegrations,
rds:AddTagsToResource,
kms:CreateGrant,
kms:DescribeKey,
redshift:CreateInboundIntegration

Read

rds:DescribeIntegrations

Update

rds:DescribeIntegrations,
rds:AddTagsToResource,
rds:RemoveTagsFromResource,
rds:ModifyIntegration

Delete

rds:DeleteIntegration,
rds:DescribeIntegrations

List

rds:DescribeIntegrations