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	awscc.rds.integrations

Fields

get (all properties)

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 &#91;Encryption context&#93;(https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt&#95;context) in the &#42;Key Management Service Developer Guide&#42;.<br />You can only include this parameter if you specify the &#96;&#96;KMSKeyId&#96;&#96; parameter.
create_time	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
integration_arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	integrations	INSERT	SourceArn, TargetArn, region
delete_resource	integrations	DELETE	Identifier, region
update_resource	integrations	UPDATE	Identifier, PatchDocument, region
list_resources	integrations_list_only	SELECT	region
get_resource	integrations	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.rds.integrations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ integration_arn }}';

list (identifiers only)

Lists all integrations in a region.

SELECT
  region,
  integration_arn
FROM awscc.rds.integrations_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.rds.integrations (
  IntegrationName,
  Description,
  Tags,
  DataFilter,
  SourceArn,
  TargetArn,
  KMSKeyId,
  AdditionalEncryptionContext,
  region
)
SELECT
  '{{ integration_name }}',
  '{{ description }}',
  '{{ tags }}',
  '{{ data_filter }}',
  '{{ source_arn }}',
  '{{ target_arn }}',
  '{{ kms_key_id }}',
  '{{ additional_encryption_context }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: integration
    props:
      - name: integration_name
        value: '{{ integration_name }}'
      - name: description
        value: '{{ description }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: data_filter
        value: '{{ data_filter }}'
      - name: source_arn
        value: '{{ source_arn }}'
      - name: target_arn
        value: '{{ target_arn }}'
      - name: kms_key_id
        value: '{{ kms_key_id }}'
      - name: additional_encryption_context
        value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.rds.integrations
SET PatchDocument = string('{{ {
    "IntegrationName": integration_name,
    "Description": description,
    "Tags": tags,
    "DataFilter": data_filter
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ integration_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.rds.integrations
WHERE
  Identifier = '{{ integration_arn }}' 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