Integration class

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", {
    configParameters: [{
        parameterKey: "enable_case_sensitive_identifier",
        parameterValue: "true",
    }],
    namespaceName: example.namespaceName,
    workgroupName: "example-workspace",
    baseCapacity: 8,
    publiclyAccessible: false,
    subnetIds: [
        example1.id,
        example2.id,
        example3.id,
    ],
});
const exampleIntegration = new aws.rds.Integration("example", {
    integrationName: "example",
    sourceArn: exampleAwsRdsCluster.arn,
    targetArn: example.arn,
}, {
    ignoreChanges: ["kmsKeyId"],
});
import pulumi
import pulumi_aws as aws

example = aws.redshiftserverless.Namespace("example", namespace_name="redshift-example")
example_workgroup = aws.redshiftserverless.Workgroup("example",
    config_parameters=[{
        "parameter_key": "enable_case_sensitive_identifier",
        "parameter_value": "true",
    }],
    namespace_name=example.namespace_name,
    workgroup_name="example-workspace",
    base_capacity=8,
    publicly_accessible=False,
    subnet_ids=[
        example1["id"],
        example2["id"],
        example3["id"],
    ])
example_integration = aws.rds.Integration("example",
    integration_name="example",
    source_arn=example_aws_rds_cluster["arn"],
    target_arn=example.arn,
    opts = pulumi.ResourceOptions(ignore_changes=["kmsKeyId"]))
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()
    {
        ConfigParameters = new[]
        {
            new Aws.RedshiftServerless.Inputs.WorkgroupConfigParameterArgs
            {
                ParameterKey = "enable_case_sensitive_identifier",
                ParameterValue = "true",
            },
        },
        NamespaceName = example.NamespaceName,
        WorkgroupName = "example-workspace",
        BaseCapacity = 8,
        PubliclyAccessible = false,
        SubnetIds = new[]
        {
            example1.Id,
            example2.Id,
            example3.Id,
        },
    });

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

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/rds"
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			ConfigParameters: redshiftserverless.WorkgroupConfigParameterArray{
				&redshiftserverless.WorkgroupConfigParameterArgs{
					ParameterKey:   pulumi.String("enable_case_sensitive_identifier"),
					ParameterValue: pulumi.String("true"),
				},
			},
			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,
			},
		})
		if err != nil {
			return err
		}
		_, err = rds.NewIntegration(ctx, "example", &rds.IntegrationArgs{
			IntegrationName: pulumi.String("example"),
			SourceArn:       pulumi.Any(exampleAwsRdsCluster.Arn),
			TargetArn:       example.Arn,
		}, pulumi.IgnoreChanges([]string{
			"kmsKeyId",
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_redshiftserverless_namespace" "example" {
  namespace_name = "redshift-example"
}
resource "aws_redshiftserverless_workgroup" "example" {
  config_parameters {
    parameter_key   = "enable_case_sensitive_identifier"
    parameter_value = "true"
  }
  namespace_name      = aws_redshiftserverless_namespace.example.namespace_name
  workgroup_name      = "example-workspace"
  base_capacity       = 8
  publicly_accessible = false
  subnet_ids          = [example1.id, example2.id, example3.id]
}
resource "aws_rds_integration" "example" {
  lifecycle {
    ignore_changes = [kmsKeyId]
  }
  integration_name = "example"
  source_arn       = exampleAwsRdsCluster.arn
  target_arn       = aws_redshiftserverless_namespace.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 com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
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()
            .configParameters(WorkgroupConfigParameterArgs.builder()
                .parameterKey("enable_case_sensitive_identifier")
                .parameterValue("true")
                .build())
            .namespaceName(example.namespaceName())
            .workgroupName("example-workspace")
            .baseCapacity(8)
            .publiclyAccessible(false)
            .subnetIds(
                example1.id(),
                example2.id(),
                example3.id())
            .build());

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

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

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: [
        {
            principals: [{
                type: "AWS",
                identifiers: [`arn:aws:iam::${current.accountId}:root`],
            }],
            actions: ["kms:*"],
            resources: ["*"],
        },
        {
            principals: [{
                type: "Service",
                identifiers: ["redshift.amazonaws.com"],
            }],
            actions: ["kms:CreateGrant"],
            resources: ["*"],
        },
    ],
}));
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=[
    {
        "principals": [{
            "type": "AWS",
            "identifiers": [f"arn:aws:iam::{current.account_id}:root"],
        }],
        "actions": ["kms:*"],
        "resources": ["*"],
    },
    {
        "principals": [{
            "type": "Service",
            "identifiers": ["redshift.amazonaws.com"],
        }],
        "actions": ["kms:CreateGrant"],
        "resources": ["*"],
    },
])
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",
    })
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
            {
                Principals = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                    {
                        Type = "AWS",
                        Identifiers = new[]
                        {
                            $"arn:aws:iam::{current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId)}:root",
                        },
                    },
                },
                Actions = new[]
                {
                    "kms:*",
                },
                Resources = new[]
                {
                    "*",
                },
            },
            new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
            {
                Principals = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                    {
                        Type = "Service",
                        Identifiers = new[]
                        {
                            "redshift.amazonaws.com",
                        },
                    },
                },
                Actions = new[]
                {
                    "kms:CreateGrant",
                },
                Resources = new[]
                {
                    "*",
                },
            },
        },
    });

    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 main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws"
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iam"
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/kms"
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
				{
					Principals: []iam.GetPolicyDocumentStatementPrincipal{
						{
							Type: "AWS",
							Identifiers: []string{
								fmt.Sprintf("arn:aws:iam::%v:root", current.AccountId),
							},
						},
					},
					Actions: []string{
						"kms:*",
					},
					Resources: []string{
						"*",
					},
				},
				{
					Principals: []iam.GetPolicyDocumentStatementPrincipal{
						{
							Type: "Service",
							Identifiers: []string{
								"redshift.amazonaws.com",
							},
						},
					},
					Actions: []string{
						"kms:CreateGrant",
					},
					Resources: []string{
						"*",
					},
				},
			},
		}, 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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_getcalleridentity" "current" {
}
data "aws_iam_getpolicydocument" "keyPolicy" {
  statements {
    principals {
      type        = "AWS"
      identifiers = ["arn:aws:iam::${data.aws_getcalleridentity.current.account_id}:root"]
    }
    actions   = ["kms:*"]
    resources = ["*"]
  }
  statements {
    principals {
      type        = "Service"
      identifiers = ["redshift.amazonaws.com"]
    }
    actions   = ["kms:CreateGrant"]
    resources = ["*"]
  }
}

resource "aws_kms_key" "example" {
  deletion_window_in_days = 10
  policy                  = data.aws_iam_getpolicydocument.keyPolicy.json
}
resource "aws_rds_integration" "example" {
  integration_name = "example"
  source_arn       = exampleAwsRdsCluster.arn
  target_arn       = exampleAwsRedshiftserverlessNamespace.arn
  kms_key_id       = aws_kms_key.example.arn
  additional_encryption_context = {
    "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.iam.inputs.GetPolicyDocumentStatementArgs;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementPrincipalArgs;
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.ArrayList;
import java.util.Arrays;
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(GetCallerIdentityArgs.builder()
            .build());

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

        var example = new Key("example", KeyArgs.builder()
            .deletionWindowInDays(10)
            .policy(keyPolicy.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:
          - principals:
              - type: AWS
                identifiers:
                  - arn:aws:iam::${current.accountId}:root
            actions:
              - kms:*
            resources:
              - '*'
          - principals:
              - type: Service
                identifiers:
                  - redshift.amazonaws.com
            actions:
              - kms:CreateGrant
            resources:
              - '*'

Import

Identity Schema

Required

  • arn (String) ARN of the RDS integration.

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

Constructors

Integration(String name, {IntegrationArgs? args, CustomResourceOptions? options})
Creates a new Integration. name The Pulumi resource name. args Arguments used to configure this Integration. The set of arguments for Integration. options Resource options controlling this resource's behavior.
Integration.reference(String urn)
Creates a typed reference to an existing Integration resource.

Properties

additionalEncryptionContext ↔ Output<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 kmsKeyId parameter.
latefinal
arn ↔ Output<String>
ARN of the Integration.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
dataFilter ↔ Output<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.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
integrationIdentifier ↔ Output<String>
Identifier of the Integration. This value can be used when creating the target database to receive results of zero-ETL integrations.
latefinal
integrationName ↔ Output<String>
Name of the integration.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
kmsKeyId ↔ Output<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 kmsKeyId parameter by using lifecycle parameter to avoid unintended change after the first creation.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sourceArn ↔ Output<String>
ARN of the database to use as the source for replication.
latefinal
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
targetArn ↔ Output<String>
ARN of the Redshift data warehouse to use as the target for replication.
latefinal
timeouts ↔ Output<IntegrationTimeouts?>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {IntegrationState? state, CustomResourceOptions? options}) → Integration
Gets an existing Integration resource's state with the given name and id.