Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. rds
  5. Integration
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.rds.Integration

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS RDS (Relational Database) zero-ETL integration. You can refer to the User Guide.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.redshiftserverless.Namespace("example", {namespaceName: "redshift-example"});
const exampleWorkgroup = new aws.redshiftserverless.Workgroup("example", {
    namespaceName: example.namespaceName,
    workgroupName: "example-workspace",
    baseCapacity: 8,
    publiclyAccessible: false,
    subnetIds: [
        example1.id,
        example2.id,
        example3.id,
    ],
    configParameters: [{
        parameterKey: "enable_case_sensitive_identifier",
        parameterValue: "true",
    }],
});
const exampleIntegration = new aws.rds.Integration("example", {
    integrationName: "example",
    sourceArn: exampleAwsRdsCluster.arn,
    targetArn: example.arn,
});

    import pulumi
import pulumi_aws as aws

example = aws.redshiftserverless.Namespace("example", namespace_name="redshift-example")
example_workgroup = aws.redshiftserverless.Workgroup("example",
    namespace_name=example.namespace_name,
    workgroup_name="example-workspace",
    base_capacity=8,
    publicly_accessible=False,
    subnet_ids=[
        example1["id"],
        example2["id"],
        example3["id"],
    ],
    config_parameters=[{
        "parameter_key": "enable_case_sensitive_identifier",
        "parameter_value": "true",
    }])
example_integration = aws.rds.Integration("example",
    integration_name="example",
    source_arn=example_aws_rds_cluster["arn"],
    target_arn=example.arn)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/redshiftserverless"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := redshiftserverless.NewNamespace(ctx, "example", &redshiftserverless.NamespaceArgs{
			NamespaceName: pulumi.String("redshift-example"),
		})
		if err != nil {
			return err
		}
		_, err = redshiftserverless.NewWorkgroup(ctx, "example", &redshiftserverless.WorkgroupArgs{
			NamespaceName:      example.NamespaceName,
			WorkgroupName:      pulumi.String("example-workspace"),
			BaseCapacity:       pulumi.Int(8),
			PubliclyAccessible: pulumi.Bool(false),
			SubnetIds: pulumi.StringArray{
				example1.Id,
				example2.Id,
				example3.Id,
			},
			ConfigParameters: redshiftserverless.WorkgroupConfigParameterArray{
				&redshiftserverless.WorkgroupConfigParameterArgs{
					ParameterKey:   pulumi.String("enable_case_sensitive_identifier"),
					ParameterValue: pulumi.String("true"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = rds.NewIntegration(ctx, "example", &rds.IntegrationArgs{
			IntegrationName: pulumi.String("example"),
			SourceArn:       pulumi.Any(exampleAwsRdsCluster.Arn),
			TargetArn:       example.Arn,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.RedshiftServerless.Namespace("example", new()
    {
        NamespaceName = "redshift-example",
    });

    var exampleWorkgroup = new Aws.RedshiftServerless.Workgroup("example", new()
    {
        NamespaceName = example.NamespaceName,
        WorkgroupName = "example-workspace",
        BaseCapacity = 8,
        PubliclyAccessible = false,
        SubnetIds = new[]
        {
            example1.Id,
            example2.Id,
            example3.Id,
        },
        ConfigParameters = new[]
        {
            new Aws.RedshiftServerless.Inputs.WorkgroupConfigParameterArgs
            {
                ParameterKey = "enable_case_sensitive_identifier",
                ParameterValue = "true",
            },
        },
    });

    var exampleIntegration = new Aws.Rds.Integration("example", new()
    {
        IntegrationName = "example",
        SourceArn = exampleAwsRdsCluster.Arn,
        TargetArn = example.Arn,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshiftserverless.Namespace;
import com.pulumi.aws.redshiftserverless.NamespaceArgs;
import com.pulumi.aws.redshiftserverless.Workgroup;
import com.pulumi.aws.redshiftserverless.WorkgroupArgs;
import com.pulumi.aws.redshiftserverless.inputs.WorkgroupConfigParameterArgs;
import com.pulumi.aws.rds.Integration;
import com.pulumi.aws.rds.IntegrationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Namespace("example", NamespaceArgs.builder()
            .namespaceName("redshift-example")
            .build());

        var exampleWorkgroup = new Workgroup("exampleWorkgroup", WorkgroupArgs.builder()
            .namespaceName(example.namespaceName())
            .workgroupName("example-workspace")
            .baseCapacity(8)
            .publiclyAccessible(false)
            .subnetIds(            
                example1.id(),
                example2.id(),
                example3.id())
            .configParameters(WorkgroupConfigParameterArgs.builder()
                .parameterKey("enable_case_sensitive_identifier")
                .parameterValue("true")
                .build())
            .build());

        var exampleIntegration = new Integration("exampleIntegration", IntegrationArgs.builder()
            .integrationName("example")
            .sourceArn(exampleAwsRdsCluster.arn())
            .targetArn(example.arn())
            .build());

    }
}

    resources:
  example:
    type: aws:redshiftserverless:Namespace
    properties:
      namespaceName: redshift-example
  exampleWorkgroup:
    type: aws:redshiftserverless:Workgroup
    name: example
    properties:
      namespaceName: ${example.namespaceName}
      workgroupName: example-workspace
      baseCapacity: 8
      publiclyAccessible: false
      subnetIds:
        - ${example1.id}
        - ${example2.id}
        - ${example3.id}
      configParameters:
        - parameterKey: enable_case_sensitive_identifier
          parameterValue: 'true'
  exampleIntegration:
    type: aws:rds:Integration
    name: example
    properties:
      integrationName: example
      sourceArn: ${exampleAwsRdsCluster.arn}
      targetArn: ${example.arn}

    Use own KMS key

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const current = aws.getCallerIdentity({});
const keyPolicy = current.then(current => aws.iam.getPolicyDocument({
    statements: [
        {
            actions: ["kms:*"],
            resources: ["*"],
            principals: [{
                type: "AWS",
                identifiers: [`arn:aws:iam::${current.accountId}:root`],
            }],
        },
        {
            actions: ["kms:CreateGrant"],
            resources: ["*"],
            principals: [{
                type: "Service",
                identifiers: ["redshift.amazonaws.com"],
            }],
        },
    ],
}));
const example = new aws.kms.Key("example", {
    deletionWindowInDays: 10,
    policy: keyPolicy.then(keyPolicy => keyPolicy.json),
});
const exampleIntegration = new aws.rds.Integration("example", {
    integrationName: "example",
    sourceArn: exampleAwsRdsCluster.arn,
    targetArn: exampleAwsRedshiftserverlessNamespace.arn,
    kmsKeyId: example.arn,
    additionalEncryptionContext: {
        example: "test",
    },
});

    import pulumi
import pulumi_aws as aws

current = aws.get_caller_identity()
key_policy = aws.iam.get_policy_document(statements=[
    {
        "actions": ["kms:*"],
        "resources": ["*"],
        "principals": [{
            "type": "AWS",
            "identifiers": [f"arn:aws:iam::{current.account_id}:root"],
        }],
    },
    {
        "actions": ["kms:CreateGrant"],
        "resources": ["*"],
        "principals": [{
            "type": "Service",
            "identifiers": ["redshift.amazonaws.com"],
        }],
    },
])
example = aws.kms.Key("example",
    deletion_window_in_days=10,
    policy=key_policy.json)
example_integration = aws.rds.Integration("example",
    integration_name="example",
    source_arn=example_aws_rds_cluster["arn"],
    target_arn=example_aws_redshiftserverless_namespace["arn"],
    kms_key_id=example.arn,
    additional_encryption_context={
        "example": "test",
    })

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kms"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := aws.GetCallerIdentity(ctx, &aws.GetCallerIdentityArgs{}, nil)
		if err != nil {
			return err
		}
		keyPolicy, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
			Statements: []iam.GetPolicyDocumentStatement{
				{
					Actions: []string{
						"kms:*",
					},
					Resources: []string{
						"*",
					},
					Principals: []iam.GetPolicyDocumentStatementPrincipal{
						{
							Type: "AWS",
							Identifiers: []string{
								fmt.Sprintf("arn:aws:iam::%v:root", current.AccountId),
							},
						},
					},
				},
				{
					Actions: []string{
						"kms:CreateGrant",
					},
					Resources: []string{
						"*",
					},
					Principals: []iam.GetPolicyDocumentStatementPrincipal{
						{
							Type: "Service",
							Identifiers: []string{
								"redshift.amazonaws.com",
							},
						},
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		example, err := kms.NewKey(ctx, "example", &kms.KeyArgs{
			DeletionWindowInDays: pulumi.Int(10),
			Policy:               pulumi.String(keyPolicy.Json),
		})
		if err != nil {
			return err
		}
		_, err = rds.NewIntegration(ctx, "example", &rds.IntegrationArgs{
			IntegrationName: pulumi.String("example"),
			SourceArn:       pulumi.Any(exampleAwsRdsCluster.Arn),
			TargetArn:       pulumi.Any(exampleAwsRedshiftserverlessNamespace.Arn),
			KmsKeyId:        example.Arn,
			AdditionalEncryptionContext: pulumi.StringMap{
				"example": pulumi.String("test"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var current = Aws.GetCallerIdentity.Invoke();

    var keyPolicy = Aws.Iam.GetPolicyDocument.Invoke(new()
    {
        Statements = new[]
        {
            new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
            {
                Actions = new[]
                {
                    "kms:*",
                },
                Resources = new[]
                {
                    "*",
                },
                Principals = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                    {
                        Type = "AWS",
                        Identifiers = new[]
                        {
                            $"arn:aws:iam::{current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId)}:root",
                        },
                    },
                },
            },
            new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
            {
                Actions = new[]
                {
                    "kms:CreateGrant",
                },
                Resources = new[]
                {
                    "*",
                },
                Principals = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                    {
                        Type = "Service",
                        Identifiers = new[]
                        {
                            "redshift.amazonaws.com",
                        },
                    },
                },
            },
        },
    });

    var example = new Aws.Kms.Key("example", new()
    {
        DeletionWindowInDays = 10,
        Policy = keyPolicy.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
    });

    var exampleIntegration = new Aws.Rds.Integration("example", new()
    {
        IntegrationName = "example",
        SourceArn = exampleAwsRdsCluster.Arn,
        TargetArn = exampleAwsRedshiftserverlessNamespace.Arn,
        KmsKeyId = example.Arn,
        AdditionalEncryptionContext = 
        {
            { "example", "test" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.inputs.GetCallerIdentityArgs;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
import com.pulumi.aws.kms.Key;
import com.pulumi.aws.kms.KeyArgs;
import com.pulumi.aws.rds.Integration;
import com.pulumi.aws.rds.IntegrationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var current = AwsFunctions.getCallerIdentity();

        final var keyPolicy = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
            .statements(            
                GetPolicyDocumentStatementArgs.builder()
                    .actions("kms:*")
                    .resources("*")
                    .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                        .type("AWS")
                        .identifiers(String.format("arn:aws:iam::%s:root", current.applyValue(getCallerIdentityResult -> getCallerIdentityResult.accountId())))
                        .build())
                    .build(),
                GetPolicyDocumentStatementArgs.builder()
                    .actions("kms:CreateGrant")
                    .resources("*")
                    .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                        .type("Service")
                        .identifiers("redshift.amazonaws.com")
                        .build())
                    .build())
            .build());

        var example = new Key("example", KeyArgs.builder()
            .deletionWindowInDays(10)
            .policy(keyPolicy.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult.json()))
            .build());

        var exampleIntegration = new Integration("exampleIntegration", IntegrationArgs.builder()
            .integrationName("example")
            .sourceArn(exampleAwsRdsCluster.arn())
            .targetArn(exampleAwsRedshiftserverlessNamespace.arn())
            .kmsKeyId(example.arn())
            .additionalEncryptionContext(Map.of("example", "test"))
            .build());

    }
}

    resources:
  example:
    type: aws:kms:Key
    properties:
      deletionWindowInDays: 10
      policy: ${keyPolicy.json}
  exampleIntegration:
    type: aws:rds:Integration
    name: example
    properties:
      integrationName: example
      sourceArn: ${exampleAwsRdsCluster.arn}
      targetArn: ${exampleAwsRedshiftserverlessNamespace.arn}
      kmsKeyId: ${example.arn}
      additionalEncryptionContext:
        example: test
variables:
  current:
    fn::invoke:
      function: aws:getCallerIdentity
      arguments: {}
  keyPolicy:
    fn::invoke:
      function: aws:iam:getPolicyDocument
      arguments:
        statements:
          - actions:
              - kms:*
            resources:
              - '*'
            principals:
              - type: AWS
                identifiers:
                  - arn:aws:iam::${current.accountId}:root
          - actions:
              - kms:CreateGrant
            resources:
              - '*'
            principals:
              - type: Service
                identifiers:
                  - redshift.amazonaws.com

    Create Integration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Integration(name: string, args: IntegrationArgs, opts?: CustomResourceOptions);
    @overload
def Integration(resource_name: str,
                args: IntegrationArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def Integration(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                integration_name: Optional[str] = None,
                source_arn: Optional[str] = None,
                target_arn: Optional[str] = None,
                additional_encryption_context: Optional[Mapping[str, str]] = None,
                data_filter: Optional[str] = None,
                kms_key_id: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                timeouts: Optional[IntegrationTimeoutsArgs] = None)
    func NewIntegration(ctx *Context, name string, args IntegrationArgs, opts ...ResourceOption) (*Integration, error)
    public Integration(string name, IntegrationArgs args, CustomResourceOptions? opts = null)
    public Integration(String name, IntegrationArgs args)
public Integration(String name, IntegrationArgs args, CustomResourceOptions options)

    type: aws:rds:Integration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleintegrationResourceResourceFromRdsintegration = new Aws.Rds.Integration("exampleintegrationResourceResourceFromRdsintegration", new()
{
    IntegrationName = "string",
    SourceArn = "string",
    TargetArn = "string",
    AdditionalEncryptionContext = 
    {
        { "string", "string" },
    },
    DataFilter = "string",
    KmsKeyId = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.Rds.Inputs.IntegrationTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});

    example, err := rds.NewIntegration(ctx, "exampleintegrationResourceResourceFromRdsintegration", &rds.IntegrationArgs{
	IntegrationName: pulumi.String("string"),
	SourceArn:       pulumi.String("string"),
	TargetArn:       pulumi.String("string"),
	AdditionalEncryptionContext: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DataFilter: pulumi.String("string"),
	KmsKeyId:   pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &rds.IntegrationTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
})

    var exampleintegrationResourceResourceFromRdsintegration = new Integration("exampleintegrationResourceResourceFromRdsintegration", IntegrationArgs.builder()
    .integrationName("string")
    .sourceArn("string")
    .targetArn("string")
    .additionalEncryptionContext(Map.of("string", "string"))
    .dataFilter("string")
    .kmsKeyId("string")
    .tags(Map.of("string", "string"))
    .timeouts(IntegrationTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());

    exampleintegration_resource_resource_from_rdsintegration = aws.rds.Integration("exampleintegrationResourceResourceFromRdsintegration",
    integration_name="string",
    source_arn="string",
    target_arn="string",
    additional_encryption_context={
        "string": "string",
    },
    data_filter="string",
    kms_key_id="string",
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
    })

    const exampleintegrationResourceResourceFromRdsintegration = new aws.rds.Integration("exampleintegrationResourceResourceFromRdsintegration", {
    integrationName: "string",
    sourceArn: "string",
    targetArn: "string",
    additionalEncryptionContext: {
        string: "string",
    },
    dataFilter: "string",
    kmsKeyId: "string",
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
    },
});

    type: aws:rds:Integration
properties:
    additionalEncryptionContext:
        string: string
    dataFilter: string
    integrationName: string
    kmsKeyId: string
    sourceArn: string
    tags:
        string: string
    targetArn: string
    timeouts:
        create: string
        delete: string

    Integration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Integration resource accepts the following input properties:

    IntegrationName string
    Name of the integration.
    SourceArn string
    ARN of the database to use as the source for replication.
    TargetArn string

    ARN of the Redshift data warehouse to use as the target for replication.

    The following arguments are optional:

    AdditionalEncryptionContext Dictionary<string, string>
    Set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see the User Guide. You can only include this parameter if you specify the kms_key_id parameter.
    DataFilter string
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. The value should match the syntax from the AWS CLI which includes an include: or exclude: prefix before a filter expression. Multiple expressions are separated by a comma. See the Amazon RDS data filtering guide for additional details.
    KmsKeyId string
    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. If you use the default AWS owned key, you should ignore kms_key_id parameter by using lifecycle parameter to avoid unintended change after the first creation.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts IntegrationTimeouts
    IntegrationName string
    Name of the integration.
    SourceArn string
    ARN of the database to use as the source for replication.
    TargetArn string

    ARN of the Redshift data warehouse to use as the target for replication.

    The following arguments are optional:

    AdditionalEncryptionContext map[string]string
    Set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see the User Guide. You can only include this parameter if you specify the kms_key_id parameter.
    DataFilter string
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. The value should match the syntax from the AWS CLI which includes an include: or exclude: prefix before a filter expression. Multiple expressions are separated by a comma. See the Amazon RDS data filtering guide for additional details.
    KmsKeyId string
    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. If you use the default AWS owned key, you should ignore kms_key_id parameter by using lifecycle parameter to avoid unintended change after the first creation.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts IntegrationTimeoutsArgs
    integrationName String
    Name of the integration.
    sourceArn String
    ARN of the database to use as the source for replication.
    targetArn String

    ARN of the Redshift data warehouse to use as the target for replication.

    The following arguments are optional:

    additionalEncryptionContext Map<String,String>
    Set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see the User Guide. You can only include this parameter if you specify the kms_key_id parameter.
    dataFilter String
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. The value should match the syntax from the AWS CLI which includes an include: or exclude: prefix before a filter expression. Multiple expressions are separated by a comma. See the Amazon RDS data filtering guide for additional details.
    kmsKeyId String
    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. If you use the default AWS owned key, you should ignore kms_key_id parameter by using lifecycle parameter to avoid unintended change after the first creation.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts IntegrationTimeouts
    integrationName string
    Name of the integration.
    sourceArn string
    ARN of the database to use as the source for replication.
    targetArn string

    ARN of the Redshift data warehouse to use as the target for replication.

    The following arguments are optional:

    additionalEncryptionContext {[key: string]: string}
    Set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see the User Guide. You can only include this parameter if you specify the kms_key_id parameter.
    dataFilter string
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. The value should match the syntax from the AWS CLI which includes an include: or exclude: prefix before a filter expression. Multiple expressions are separated by a comma. See the Amazon RDS data filtering guide for additional details.
    kmsKeyId string
    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. If you use the default AWS owned key, you should ignore kms_key_id parameter by using lifecycle parameter to avoid unintended change after the first creation.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts IntegrationTimeouts
    integration_name str
    Name of the integration.
    source_arn str
    ARN of the database to use as the source for replication.
    target_arn str

    ARN of the Redshift data warehouse to use as the target for replication.

    The following arguments are optional:

    additional_encryption_context Mapping[str, str]
    Set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see the User Guide. You can only include this parameter if you specify the kms_key_id parameter.
    data_filter str
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. The value should match the syntax from the AWS CLI which includes an include: or exclude: prefix before a filter expression. Multiple expressions are separated by a comma. See the Amazon RDS data filtering guide for additional details.
    kms_key_id str
    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. If you use the default AWS owned key, you should ignore kms_key_id parameter by using lifecycle parameter to avoid unintended change after the first creation.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts IntegrationTimeoutsArgs
    integrationName String
    Name of the integration.
    sourceArn String
    ARN of the database to use as the source for replication.
    targetArn String

    ARN of the Redshift data warehouse to use as the target for replication.

    The following arguments are optional:

    additionalEncryptionContext Map<String>
    Set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see the User Guide. You can only include this parameter if you specify the kms_key_id parameter.
    dataFilter String
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. The value should match the syntax from the AWS CLI which includes an include: or exclude: prefix before a filter expression. Multiple expressions are separated by a comma. See the Amazon RDS data filtering guide for additional details.
    kmsKeyId String
    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. If you use the default AWS owned key, you should ignore kms_key_id parameter by using lifecycle parameter to avoid unintended change after the first creation.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Integration resource produces the following output properties:

    Arn string
    ARN of the Integration.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Integration.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Integration.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the Integration.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the Integration.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Integration.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Integration Resource

    Get an existing Integration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: IntegrationState, opts?: CustomResourceOptions): Integration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_encryption_context: Optional[Mapping[str, str]] = None,
        arn: Optional[str] = None,
        data_filter: Optional[str] = None,
        integration_name: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        source_arn: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        target_arn: Optional[str] = None,
        timeouts: Optional[IntegrationTimeoutsArgs] = None) -> Integration
    func GetIntegration(ctx *Context, name string, id IDInput, state *IntegrationState, opts ...ResourceOption) (*Integration, error)
    public static Integration Get(string name, Input<string> id, IntegrationState? state, CustomResourceOptions? opts = null)
    public static Integration get(String name, Output<String> id, IntegrationState state, CustomResourceOptions options)
    resources:  _:    type: aws:rds:Integration    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdditionalEncryptionContext Dictionary<string, string>
    Set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see the User Guide. You can only include this parameter if you specify the kms_key_id parameter.
    Arn string
    ARN of the Integration.
    DataFilter string
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. The value should match the syntax from the AWS CLI which includes an include: or exclude: prefix before a filter expression. Multiple expressions are separated by a comma. See the Amazon RDS data filtering guide for additional details.
    IntegrationName string
    Name of the integration.
    KmsKeyId string
    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. If you use the default AWS owned key, you should ignore kms_key_id parameter by using lifecycle parameter to avoid unintended change after the first creation.
    SourceArn string
    ARN of the database to use as the source for replication.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TargetArn string

    ARN of the Redshift data warehouse to use as the target for replication.

    The following arguments are optional:

    Timeouts IntegrationTimeouts
    AdditionalEncryptionContext map[string]string
    Set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see the User Guide. You can only include this parameter if you specify the kms_key_id parameter.
    Arn string
    ARN of the Integration.
    DataFilter string
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. The value should match the syntax from the AWS CLI which includes an include: or exclude: prefix before a filter expression. Multiple expressions are separated by a comma. See the Amazon RDS data filtering guide for additional details.
    IntegrationName string
    Name of the integration.
    KmsKeyId string
    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. If you use the default AWS owned key, you should ignore kms_key_id parameter by using lifecycle parameter to avoid unintended change after the first creation.
    SourceArn string
    ARN of the database to use as the source for replication.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TargetArn string

    ARN of the Redshift data warehouse to use as the target for replication.

    The following arguments are optional:

    Timeouts IntegrationTimeoutsArgs
    additionalEncryptionContext Map<String,String>
    Set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see the User Guide. You can only include this parameter if you specify the kms_key_id parameter.
    arn String
    ARN of the Integration.
    dataFilter String
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. The value should match the syntax from the AWS CLI which includes an include: or exclude: prefix before a filter expression. Multiple expressions are separated by a comma. See the Amazon RDS data filtering guide for additional details.
    integrationName String
    Name of the integration.
    kmsKeyId String
    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. If you use the default AWS owned key, you should ignore kms_key_id parameter by using lifecycle parameter to avoid unintended change after the first creation.
    sourceArn String
    ARN of the database to use as the source for replication.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetArn String

    ARN of the Redshift data warehouse to use as the target for replication.

    The following arguments are optional:

    timeouts IntegrationTimeouts
    additionalEncryptionContext {[key: string]: string}
    Set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see the User Guide. You can only include this parameter if you specify the kms_key_id parameter.
    arn string
    ARN of the Integration.
    dataFilter string
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. The value should match the syntax from the AWS CLI which includes an include: or exclude: prefix before a filter expression. Multiple expressions are separated by a comma. See the Amazon RDS data filtering guide for additional details.
    integrationName string
    Name of the integration.
    kmsKeyId string
    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. If you use the default AWS owned key, you should ignore kms_key_id parameter by using lifecycle parameter to avoid unintended change after the first creation.
    sourceArn string
    ARN of the database to use as the source for replication.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetArn string

    ARN of the Redshift data warehouse to use as the target for replication.

    The following arguments are optional:

    timeouts IntegrationTimeouts
    additional_encryption_context Mapping[str, str]
    Set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see the User Guide. You can only include this parameter if you specify the kms_key_id parameter.
    arn str
    ARN of the Integration.
    data_filter str
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. The value should match the syntax from the AWS CLI which includes an include: or exclude: prefix before a filter expression. Multiple expressions are separated by a comma. See the Amazon RDS data filtering guide for additional details.
    integration_name str
    Name of the integration.
    kms_key_id str
    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. If you use the default AWS owned key, you should ignore kms_key_id parameter by using lifecycle parameter to avoid unintended change after the first creation.
    source_arn str
    ARN of the database to use as the source for replication.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    target_arn str

    ARN of the Redshift data warehouse to use as the target for replication.

    The following arguments are optional:

    timeouts IntegrationTimeoutsArgs
    additionalEncryptionContext Map<String>
    Set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see the User Guide. You can only include this parameter if you specify the kms_key_id parameter.
    arn String
    ARN of the Integration.
    dataFilter String
    Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. The value should match the syntax from the AWS CLI which includes an include: or exclude: prefix before a filter expression. Multiple expressions are separated by a comma. See the Amazon RDS data filtering guide for additional details.
    integrationName String
    Name of the integration.
    kmsKeyId String
    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. If you use the default AWS owned key, you should ignore kms_key_id parameter by using lifecycle parameter to avoid unintended change after the first creation.
    sourceArn String
    ARN of the database to use as the source for replication.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetArn String

    ARN of the Redshift data warehouse to use as the target for replication.

    The following arguments are optional:

    timeouts Property Map

    Supporting Types

    IntegrationTimeouts, IntegrationTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

    Import

    Using pulumi import, import RDS (Relational Database) Integration using the arn. For example:

    $ pulumi import aws:rds/integration:Integration example arn:aws:rds:us-west-2:123456789012:integration:abcdefgh-0000-1111-2222-123456789012

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws