integrations

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

Overview

Name	integrations
Type	Resource
Description	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	A description of the integration.
tags	array	A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*.
data_filter	string	Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.
source_arn	string	The Amazon Resource Name (ARN) of the database 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
kms_key_id	string	The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default AWS owned key.
additional_encryption_context	object	An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see [Encryption context](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the *Key Management Service Developer Guide*. You can only include this parameter if you specify the KMSKeyId parameter.
create_time	string
region	string	AWS region.

For more information, see AWS::RDS::Integration.

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