integrations

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

Overview

Name	integrations
Type	Resource
Id	aws.rds.integrations

Fields

The following fields are returned by SELECT queries:

describe_integrations

Name	Datatype	Description
additional_encryption_context	string	The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.
create_time	string	The time when the integration was created, in Universal Coordinated Time (UTC).
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.
description	string	A description of the integration.
errors	string	Any errors associated with the integration.
integration_arn	string	The ARN of the integration.
integration_name	string	The name of the integration.
kms_key_id	string	The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration.
source_arn	string	The Amazon Resource Name (ARN) of the database used as the source for replication.
status	string	The current status of the integration.
tags	string	A list of tags. For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
target_arn	string	The ARN of the Redshift data warehouse used as the target for replication.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_integrations	select	region	IntegrationIdentifier, Filters, MaxRecords, Marker	Describe one or more zero-ETL integrations with Amazon Redshift.
create_integration	insert	SourceArn, TargetArn, IntegrationName, region	KMSKeyId, AdditionalEncryptionContext, Tags, DataFilter, Description	Creates a zero-ETL integration with Amazon Redshift.
modify_integration	update	IntegrationIdentifier, region	IntegrationName, DataFilter, Description	Modifies a zero-ETL integration with Amazon Redshift.
delete_integration	delete	IntegrationIdentifier, region		Deletes a zero-ETL integration with Amazon Redshift.

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
IntegrationIdentifier	string	The unique identifier of the integration.
IntegrationName	string	The name of the integration.
SourceArn	string	The Amazon Resource Name (ARN) of the database to use as the source for replication.
TargetArn	string	The ARN of the Redshift data warehouse to use as the target for replication.
region	string	AWS region (default: us-east-1)
AdditionalEncryptionContext	object	An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide. You can only include this parameter if you specify the KMSKeyId parameter.
DataFilter	string	A new data filter for the integration. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift or Data filtering for Amazon RDS zero-ETL integrations with Amazon Redshift.
Description	string	A new description for the integration.
Filters	array	A filter that specifies one or more resources to return.
IntegrationIdentifier	string	The unique identifier of the integration.
IntegrationName	string	A new name for the integration.
KMSKeyId	string	The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default Amazon Web Services owned key.
Marker	string	An optional pagination token provided by a previous DescribeIntegrations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords	integer	The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
Tags	array

SELECT examples

describe_integrations

Describe one or more zero-ETL integrations with Amazon Redshift.

SELECT
additional_encryption_context,
create_time,
data_filter,
description,
errors,
integration_arn,
integration_name,
kms_key_id,
source_arn,
status,
tags,
target_arn
FROM aws.rds.integrations
WHERE region = '{{ region }}' -- required
AND IntegrationIdentifier = '{{ IntegrationIdentifier }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;

INSERT examples

create_integration

Creates a zero-ETL integration with Amazon Redshift.

INSERT INTO aws.rds.integrations (
SourceArn,
TargetArn,
IntegrationName,
region,
KMSKeyId,
AdditionalEncryptionContext,
Tags,
DataFilter,
Description
)
SELECT 
'{{ SourceArn }}',
'{{ TargetArn }}',
'{{ IntegrationName }}',
'{{ region }}',
'{{ KMSKeyId }}',
'{{ AdditionalEncryptionContext }}',
'{{ Tags }}',
'{{ DataFilter }}',
'{{ Description }}'
RETURNING
additional_encryption_context,
create_time,
data_filter,
description,
errors,
integration_arn,
integration_name,
kms_key_id,
source_arn,
status,
tags,
target_arn
;

Manifest

# Description fields are for documentation purposes
- name: integrations
props:
  - name: SourceArn
    value: "{{ SourceArn }}"
    description: Required parameter for the integrations resource.
  - name: TargetArn
    value: "{{ TargetArn }}"
    description: Required parameter for the integrations resource.
  - name: IntegrationName
    value: "{{ IntegrationName }}"
    description: Required parameter for the integrations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the integrations resource.
  - name: KMSKeyId
    value: "{{ KMSKeyId }}"
    description: The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default Amazon Web Services owned key.
    description: The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default Amazon Web Services owned key.
  - name: AdditionalEncryptionContext
    value: "{{ AdditionalEncryptionContext }}"
    description: An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide. You can only include this parameter if you specify the KMSKeyId parameter.
    description: An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide. You can only include this parameter if you specify the KMSKeyId parameter.
  - name: Tags
    value: "{{ Tags }}"
  - name: DataFilter
    value: "{{ DataFilter }}"
    description: Data filtering options for the integration. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift or Data filtering for Amazon RDS zero-ETL integrations with Amazon Redshift.
    description: Data filtering options for the integration. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift or Data filtering for Amazon RDS zero-ETL integrations with Amazon Redshift.
  - name: Description
    value: "{{ Description }}"
    description: A description of the integration.
    description: A description of the integration.

UPDATE examples

modify_integration

Modifies a zero-ETL integration with Amazon Redshift.

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

DELETE examples

delete_integration

Deletes a zero-ETL integration with Amazon Redshift.

DELETE FROM aws.rds.integrations
WHERE IntegrationIdentifier = '{{ IntegrationIdentifier }}' --required
AND region = '{{ region }}' --required
;