Creating Aurora zero-ETL integrations with Amazon Redshift
When you create an Aurora zero-ETL integration, you specify the source Aurora DB cluster and the target Amazon Redshift data warehouse. You can also customize encryption settings and add tags. Aurora creates an integration between the source DB cluster and its target. Once the integration is active, any data that you insert into the source DB cluster will be replicated into the configured Amazon Redshift target.
Prerequisites
Before you create a zero-ETL integration, you must create a source DB cluster and a target Amazon Redshift data warehouse. You also must allow replication into the data warehouse by adding the DB cluster as an authorized integration source.
For instructions to complete each of these steps, see Getting started with Aurora zero-ETL integrations with Amazon Redshift.
Required permissions
Certain IAM permissions are required to create a zero-ETL integration. At minimum, you need permissions to perform the following actions:
Create zero-ETL integrations for the source Aurora DB cluster.
View and delete all zero-ETL integrations.
Create inbound integrations into the target data warehouse. You don't need this permission if the same account owns the Amazon Redshift data warehouse and this account is an authorized principal for that data warehouse. For information about adding authorized principals, see Configure authorization for your Amazon Redshift data warehouse.
The following sample policy demonstrates the least privilege
permissions required to create and manage integrations. You might not need
these exact permissions if your user or role has broader permissions, such as an
AdministratorAccess
managed policy.
Note
Redshift Amazon Resource Names (ARNs) have the following format. Note the use of a
forward slash (/
) rather than a colon (:
) before the
serverless namespace UUID.
-
Provisioned cluster –
arn:aws:redshift:{region}:{account-id}:namespace:
namespace-uuid
-
Serverless –
arn:aws:redshift-serverless:{region}:{account-id}:namespace/
namespace-uuid
Important
For the Aurora PostgreSQL preview, all ARNs and actions within the Amazon RDS Database Preview
Environment-preview
appended to the service
namespace. For example,
rds
and -preview
:CreateIntegrationarn:aws:rds
.-preview
:…
{ "Version": "2012-10-17", "Statement": [{ "Effect": "Allow", "Action": [ "rds:CreateIntegration" ], "Resource": [ "arn:aws:rds:
{region}
:{account-id}
:cluster:source-db
", "arn:aws:rds:{region}
:{account-id}
:integration:*" ] }, { "Effect": "Allow", "Action": [ "rds:DescribeIntegrations" ], "Resource": ["*"] }, { "Effect": "Allow", "Action": [ "rds:DeleteIntegration", "rds:ModifyIntegration" ], "Resource": [ "arn:aws:rds:{region}
::integration:*" ] }, { "Effect": "Allow", "Action": [ "redshift:CreateInboundIntegration" ], "Resource": [ "arn:aws:redshift:
{account-id}
{region}
::namespace:
{account-id}
namespace-uuid
" ] }] }
Choosing a target data warehouse in a different account
If you plan to specify a target Amazon Redshift data warehouse that's in another AWS account, you must create a role that allows users in the current account to access resources in the target account. For more information, see Providing access to an IAM user in another AWS account that you own.
The role must have the following permissions, which allow the user to view available Amazon Redshift provisioned clusters and Redshift Serverless namespaces in the target account.
{ "Version":"2012-10-17", "Statement":[ { "Effect":"Allow", "Action":[ "redshift:DescribeClusters", "redshift-serverless:ListNamespaces" ], "Resource":[ "*" ] } ] }
The role must have the following trust policy, which specifies the target account ID.
{ "Version":"2012-10-17", "Statement":[ { "Effect":"Allow", "Principal":{ "AWS": "arn:aws:iam::
:root" }, "Action":"sts:AssumeRole" } ] }
{external-account-id}
For instructions to create the role, see Creating a role using custom trust policies.
Creating zero-ETL integrations
You can create an Aurora MySQL zero-ETL integration using the AWS Management Console, the AWS CLI, or the RDS API. To create an Aurora PostgreSQL integration, you must use the AWS Management Console.
To create a zero-ETL integration
Sign in to the AWS Management Console and open the Amazon RDS console at https://console.aws.amazon.com/rds/
. If you're using an Aurora PostgreSQL DB cluster as the source of the integration, you must sign in to the Amazon RDS Database Preview Environment at https://us-east-2.console.aws.amazon.com/rds-preview/home?region=us-east-2#databases
. -
In the left navigation pane, choose Zero-ETL integrations.
-
Choose Create zero-ETL integration.
-
For Integration identifier, enter a name for the integration. The name can have up to 63 alphanumeric characters and can include hyphens.
-
Choose Next.
For Source, select the Aurora DB cluster where the data will originate from. The cluster must be running Aurora MySQL version 3.05 or higher, or Aurora PostgreSQL (compatible with PostgreSQL 15.4 and Zero-ETL Support).
Note
For MySQL sources, RDS notifies you if the DB cluster parameters aren't configured correctly. If you receive this message, you can either choose Fix it for me, or configure them manually. For instructions to fix them manually, see Step 1: Create a custom DB cluster parameter group.
Modifying DB cluster parameters requires a reboot. Before you can create the integration, the reboot must be complete and the new parameter values must be successfully applied to the cluster.
-
If you selected an Aurora PostgreSQL source cluster, under Named database, specify the named database to use as the source for your integration. The PostgreSQL resource model allows the creation of multiple databases within a single DB cluster, but only one can be used for each zero-ETL integration.
The named database must be created from
template1
. For more information, see Template Databasesin the PostgreSQL documentation. -
(Optional) If you selected an Aurora MySQL source DB cluster, select Customize data filtering options and add data filters to your integration. You can use data filters to define the scope of replication to the target data warehouse. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift.
-
Once your source DB cluster is successfully configured, choose Next.
For Target, do the following:
(Optional) To use a different AWS account for the Amazon Redshift target, choose Specify a different account. Then, enter the ARN of an IAM role with permissions to display your data warehouses. For instructions to create the IAM role, see Choosing a target data warehouse in a different account.
For Amazon Redshift data warehouse, select the target for replicated data from the source DB cluster. You can choose a provisioned Amazon Redshift cluster or a Redshift Serverless namespace as the target.
Note
RDS notifies you if the resource policy or case sensitivity settings for the specified data warehouse aren't configured correctly. If you receive this message, you can either choose Fix it for me, or configure them manually. For instructions to fix them manually, see Turn on case sensitivity for your data warehouse and Configure authorization for your data warehouse in the Amazon Redshift Management Guide.
Modifying case sensitivity for a provisioned Redshift cluster requires a reboot. Before you can create the integration, the reboot must be complete and the new parameter value must be successfully applied to the cluster.
If your selected source and target are in different AWS accounts, then Amazon RDS cannot fix these settings for you. You must navigate to the other account and fix them manually in Amazon Redshift.
-
Once your target data warehouse is configured correctly, choose Next.
-
(Optional) For Tags, add one or more tags to the integration. For more information, see Tagging Amazon RDS resources.
-
For Encryption, specify how you want your integration to be encrypted. By default, RDS encrypts all integrations with an AWS owned key. To choose a customer managed key instead, enable Customize encryption settings and choose a KMS key to use for encryption. For more information, see Encrypting Amazon Aurora resources.
Note
If you specify a custom KMS key, the key policy must allow the
kms:CreateGrant
action for the Amazon Redshift service principal (redshift.amazonaws.com
). For more information, see Creating a key policy in the AWS Key Management Service Developer Guide.Optionally, add an encryption context. For more information, see Encryption context in the AWS Key Management Service Developer Guide.
-
Choose Next.
Review your integration settings and choose Create zero-ETL integration.
If creation fails, see I can't create a zero-ETL integration for troubleshooting steps.
The integration has a status of Creating
while it's being created, and the
target Amazon Redshift data warehouse has a status of Modifying
. During this time, you
can't query the data warehouse or make any configuration changes on it.
When the integration is successfully created, the status of the integration and the target
Amazon Redshift data warehouse both change to Active
.
Note
During the preview of Aurora PostgreSQL zero-ETL integrations, you can only create integrations through the AWS Management Console. You can't use the AWS CLI, the Amazon RDS API, or any of the SDKs.
To create a zero-ETL integration using the AWS CLI, use the create-integration command with the following options:
-
--integration-name
– Specify a name for the integration. -
--source-arn
– Specify the ARN of the Aurora DB cluster that will be the source for the integration. -
--target-arn
– Specify the ARN of the Amazon Redshift data warehouse that will be the target for the integration.
For Linux, macOS, or Unix:
aws rds create-integration \ --integration-name
my-integration
\ --source-arn arn:aws:rds:{region}
:{account-id}
:my-db
\ --target-arn arn:aws:redshift:{region}
:{account-id}
:namespace:namespace-uuid
For Windows:
aws rds create-integration ^ --integration-name
my-integration
^ --source-arn arn:aws:rds:{region}
:{account-id}
:my-db
^ --target-arn arn:aws:redshift:{region}
:{account-id}
:namespace:namespace-uuid
Note
During the preview of Aurora PostgreSQL zero-ETL integrations, you can only create integrations through the AWS Management Console. You can't use the AWS CLI, the Amazon RDS API, or any of the SDKs.
To create a zero-ETL integration by using the Amazon RDS API, use the CreateIntegration
operation with the following
parameters:
-
IntegrationName
– Specify a name for the integration. -
SourceArn
– Specify the ARN of the Aurora DB cluster that will be the source for the integration. -
TargetArn
– Specify the ARN of the Amazon Redshift data warehouse that will be the target for the integration.
Next steps
After you successfully create a zero-ETL integration, you must create a destination database within your target Amazon Redshift cluster or workgroup. Then, you can start adding data to the source Aurora DB cluster and querying it in Amazon Redshift. For instructions, see Creating destination databases in Amazon Redshift.