Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. dsql
  5. ClusterPeering
AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws

aws.dsql.ClusterPeering

Explore with Pulumi AI

aws logo
AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws

    Resource for managing an Amazon Aurora DSQL Cluster Peering.

    Example Usage

    Basic Usage

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

const example1 = new aws.dsql.Cluster("example_1", {multiRegionProperties: {
    witnessRegion: "us-west-2",
}});
const example2 = new aws.dsql.Cluster("example_2", {multiRegionProperties: {
    witnessRegion: "us-west-2",
}});
const example1ClusterPeering = new aws.dsql.ClusterPeering("example_1", {
    identifier: example1.identifier,
    clusters: [example2.arn],
    witnessRegion: example1.multiRegionProperties.apply(multiRegionProperties => multiRegionProperties?.witnessRegion),
});
const example2ClusterPeering = new aws.dsql.ClusterPeering("example_2", {
    identifier: example2.identifier,
    clusters: [example1.arn],
    witnessRegion: example2.multiRegionProperties.apply(multiRegionProperties => multiRegionProperties?.witnessRegion),
});

    import pulumi
import pulumi_aws as aws

example1 = aws.dsql.Cluster("example_1", multi_region_properties={
    "witness_region": "us-west-2",
})
example2 = aws.dsql.Cluster("example_2", multi_region_properties={
    "witness_region": "us-west-2",
})
example1_cluster_peering = aws.dsql.ClusterPeering("example_1",
    identifier=example1.identifier,
    clusters=[example2.arn],
    witness_region=example1.multi_region_properties.witness_region)
example2_cluster_peering = aws.dsql.ClusterPeering("example_2",
    identifier=example2.identifier,
    clusters=[example1.arn],
    witness_region=example2.multi_region_properties.witness_region)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example1, err := dsql.NewCluster(ctx, "example_1", &dsql.ClusterArgs{
			MultiRegionProperties: &dsql.ClusterMultiRegionPropertiesArgs{
				WitnessRegion: pulumi.String("us-west-2"),
			},
		})
		if err != nil {
			return err
		}
		example2, err := dsql.NewCluster(ctx, "example_2", &dsql.ClusterArgs{
			MultiRegionProperties: &dsql.ClusterMultiRegionPropertiesArgs{
				WitnessRegion: pulumi.String("us-west-2"),
			},
		})
		if err != nil {
			return err
		}
		_, err = dsql.NewClusterPeering(ctx, "example_1", &dsql.ClusterPeeringArgs{
			Identifier: example1.Identifier,
			Clusters: pulumi.StringArray{
				example2.Arn,
			},
			WitnessRegion: pulumi.String(example1.MultiRegionProperties.ApplyT(func(multiRegionProperties dsql.ClusterMultiRegionProperties) (*string, error) {
				return &multiRegionProperties.WitnessRegion, nil
			}).(pulumi.StringPtrOutput)),
		})
		if err != nil {
			return err
		}
		_, err = dsql.NewClusterPeering(ctx, "example_2", &dsql.ClusterPeeringArgs{
			Identifier: example2.Identifier,
			Clusters: pulumi.StringArray{
				example1.Arn,
			},
			WitnessRegion: pulumi.String(example2.MultiRegionProperties.ApplyT(func(multiRegionProperties dsql.ClusterMultiRegionProperties) (*string, error) {
				return &multiRegionProperties.WitnessRegion, nil
			}).(pulumi.StringPtrOutput)),
		})
		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 example1 = new Aws.Dsql.Cluster("example_1", new()
    {
        MultiRegionProperties = new Aws.Dsql.Inputs.ClusterMultiRegionPropertiesArgs
        {
            WitnessRegion = "us-west-2",
        },
    });

    var example2 = new Aws.Dsql.Cluster("example_2", new()
    {
        MultiRegionProperties = new Aws.Dsql.Inputs.ClusterMultiRegionPropertiesArgs
        {
            WitnessRegion = "us-west-2",
        },
    });

    var example1ClusterPeering = new Aws.Dsql.ClusterPeering("example_1", new()
    {
        Identifier = example1.Identifier,
        Clusters = new[]
        {
            example2.Arn,
        },
        WitnessRegion = example1.MultiRegionProperties.Apply(multiRegionProperties => multiRegionProperties?.WitnessRegion),
    });

    var example2ClusterPeering = new Aws.Dsql.ClusterPeering("example_2", new()
    {
        Identifier = example2.Identifier,
        Clusters = new[]
        {
            example1.Arn,
        },
        WitnessRegion = example2.MultiRegionProperties.Apply(multiRegionProperties => multiRegionProperties?.WitnessRegion),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dsql.Cluster;
import com.pulumi.aws.dsql.ClusterArgs;
import com.pulumi.aws.dsql.inputs.ClusterMultiRegionPropertiesArgs;
import com.pulumi.aws.dsql.ClusterPeering;
import com.pulumi.aws.dsql.ClusterPeeringArgs;
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 example1 = new Cluster("example1", ClusterArgs.builder()
            .multiRegionProperties(ClusterMultiRegionPropertiesArgs.builder()
                .witnessRegion("us-west-2")
                .build())
            .build());

        var example2 = new Cluster("example2", ClusterArgs.builder()
            .multiRegionProperties(ClusterMultiRegionPropertiesArgs.builder()
                .witnessRegion("us-west-2")
                .build())
            .build());

        var example1ClusterPeering = new ClusterPeering("example1ClusterPeering", ClusterPeeringArgs.builder()
            .identifier(example1.identifier())
            .clusters(example2.arn())
            .witnessRegion(example1.multiRegionProperties().applyValue(_multiRegionProperties -> _multiRegionProperties.witnessRegion()))
            .build());

        var example2ClusterPeering = new ClusterPeering("example2ClusterPeering", ClusterPeeringArgs.builder()
            .identifier(example2.identifier())
            .clusters(example1.arn())
            .witnessRegion(example2.multiRegionProperties().applyValue(_multiRegionProperties -> _multiRegionProperties.witnessRegion()))
            .build());

    }
}

    resources:
  example1:
    type: aws:dsql:Cluster
    name: example_1
    properties:
      multiRegionProperties:
        witnessRegion: us-west-2
  example2:
    type: aws:dsql:Cluster
    name: example_2
    properties:
      multiRegionProperties:
        witnessRegion: us-west-2
  example1ClusterPeering:
    type: aws:dsql:ClusterPeering
    name: example_1
    properties:
      identifier: ${example1.identifier}
      clusters:
        - ${example2.arn}
      witnessRegion: ${example1.multiRegionProperties.witnessRegion}
  example2ClusterPeering:
    type: aws:dsql:ClusterPeering
    name: example_2
    properties:
      identifier: ${example2.identifier}
      clusters:
        - ${example1.arn}
      witnessRegion: ${example2.multiRegionProperties.witnessRegion}

    Create ClusterPeering Resource

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

    Constructor syntax

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

@overload
def ClusterPeering(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   clusters: Optional[Sequence[str]] = None,
                   identifier: Optional[str] = None,
                   witness_region: Optional[str] = None,
                   timeouts: Optional[ClusterPeeringTimeoutsArgs] = None)
    func NewClusterPeering(ctx *Context, name string, args ClusterPeeringArgs, opts ...ResourceOption) (*ClusterPeering, error)
    public ClusterPeering(string name, ClusterPeeringArgs args, CustomResourceOptions? opts = null)
    public ClusterPeering(String name, ClusterPeeringArgs args)
public ClusterPeering(String name, ClusterPeeringArgs args, CustomResourceOptions options)

    type: aws:dsql:ClusterPeering
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 ClusterPeeringArgs
    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 ClusterPeeringArgs
    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 ClusterPeeringArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterPeeringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterPeeringArgs
    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 clusterPeeringResource = new Aws.Dsql.ClusterPeering("clusterPeeringResource", new()
{
    Clusters = new[]
    {
        "string",
    },
    Identifier = "string",
    WitnessRegion = "string",
    Timeouts = new Aws.Dsql.Inputs.ClusterPeeringTimeoutsArgs
    {
        Create = "string",
    },
});

    example, err := dsql.NewClusterPeering(ctx, "clusterPeeringResource", &dsql.ClusterPeeringArgs{
	Clusters: pulumi.StringArray{
		pulumi.String("string"),
	},
	Identifier:    pulumi.String("string"),
	WitnessRegion: pulumi.String("string"),
	Timeouts: &dsql.ClusterPeeringTimeoutsArgs{
		Create: pulumi.String("string"),
	},
})

    var clusterPeeringResource = new ClusterPeering("clusterPeeringResource", ClusterPeeringArgs.builder()
    .clusters("string")
    .identifier("string")
    .witnessRegion("string")
    .timeouts(ClusterPeeringTimeoutsArgs.builder()
        .create("string")
        .build())
    .build());

    cluster_peering_resource = aws.dsql.ClusterPeering("clusterPeeringResource",
    clusters=["string"],
    identifier="string",
    witness_region="string",
    timeouts={
        "create": "string",
    })

    const clusterPeeringResource = new aws.dsql.ClusterPeering("clusterPeeringResource", {
    clusters: ["string"],
    identifier: "string",
    witnessRegion: "string",
    timeouts: {
        create: "string",
    },
});

    type: aws:dsql:ClusterPeering
properties:
    clusters:
        - string
    identifier: string
    timeouts:
        create: string
    witnessRegion: string

    ClusterPeering 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 ClusterPeering resource accepts the following input properties:

    Clusters List<string>
    List of DSQL Cluster ARNs to be peered to this cluster.
    Identifier string
    DSQL Cluster Identifier.
    WitnessRegion string
    Witness region for a multi-region cluster.
    Timeouts ClusterPeeringTimeouts
    Clusters []string
    List of DSQL Cluster ARNs to be peered to this cluster.
    Identifier string
    DSQL Cluster Identifier.
    WitnessRegion string
    Witness region for a multi-region cluster.
    Timeouts ClusterPeeringTimeoutsArgs
    clusters List<String>
    List of DSQL Cluster ARNs to be peered to this cluster.
    identifier String
    DSQL Cluster Identifier.
    witnessRegion String
    Witness region for a multi-region cluster.
    timeouts ClusterPeeringTimeouts
    clusters string[]
    List of DSQL Cluster ARNs to be peered to this cluster.
    identifier string
    DSQL Cluster Identifier.
    witnessRegion string
    Witness region for a multi-region cluster.
    timeouts ClusterPeeringTimeouts
    clusters Sequence[str]
    List of DSQL Cluster ARNs to be peered to this cluster.
    identifier str
    DSQL Cluster Identifier.
    witness_region str
    Witness region for a multi-region cluster.
    timeouts ClusterPeeringTimeoutsArgs
    clusters List<String>
    List of DSQL Cluster ARNs to be peered to this cluster.
    identifier String
    DSQL Cluster Identifier.
    witnessRegion String
    Witness region for a multi-region cluster.
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ClusterPeering Resource

    Get an existing ClusterPeering 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?: ClusterPeeringState, opts?: CustomResourceOptions): ClusterPeering
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        clusters: Optional[Sequence[str]] = None,
        identifier: Optional[str] = None,
        timeouts: Optional[ClusterPeeringTimeoutsArgs] = None,
        witness_region: Optional[str] = None) -> ClusterPeering
    func GetClusterPeering(ctx *Context, name string, id IDInput, state *ClusterPeeringState, opts ...ResourceOption) (*ClusterPeering, error)
    public static ClusterPeering Get(string name, Input<string> id, ClusterPeeringState? state, CustomResourceOptions? opts = null)
    public static ClusterPeering get(String name, Output<String> id, ClusterPeeringState state, CustomResourceOptions options)
    resources:  _:    type: aws:dsql:ClusterPeering    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:
    Clusters List<string>
    List of DSQL Cluster ARNs to be peered to this cluster.
    Identifier string
    DSQL Cluster Identifier.
    Timeouts ClusterPeeringTimeouts
    WitnessRegion string
    Witness region for a multi-region cluster.
    Clusters []string
    List of DSQL Cluster ARNs to be peered to this cluster.
    Identifier string
    DSQL Cluster Identifier.
    Timeouts ClusterPeeringTimeoutsArgs
    WitnessRegion string
    Witness region for a multi-region cluster.
    clusters List<String>
    List of DSQL Cluster ARNs to be peered to this cluster.
    identifier String
    DSQL Cluster Identifier.
    timeouts ClusterPeeringTimeouts
    witnessRegion String
    Witness region for a multi-region cluster.
    clusters string[]
    List of DSQL Cluster ARNs to be peered to this cluster.
    identifier string
    DSQL Cluster Identifier.
    timeouts ClusterPeeringTimeouts
    witnessRegion string
    Witness region for a multi-region cluster.
    clusters Sequence[str]
    List of DSQL Cluster ARNs to be peered to this cluster.
    identifier str
    DSQL Cluster Identifier.
    timeouts ClusterPeeringTimeoutsArgs
    witness_region str
    Witness region for a multi-region cluster.
    clusters List<String>
    List of DSQL Cluster ARNs to be peered to this cluster.
    identifier String
    DSQL Cluster Identifier.
    timeouts Property Map
    witnessRegion String
    Witness region for a multi-region cluster.

    Supporting Types

    ClusterPeeringTimeouts, ClusterPeeringTimeoutsArgs

    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).
    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).
    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).
    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).
    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).
    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).

    Import

    Using pulumi import, import DSQL Cluster Peering using the identifier. For example:

    $ pulumi import aws:dsql/clusterPeering:ClusterPeering example cluster-id-12345678

    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.83.0 published on Monday, Jun 16, 2025 by Pulumi
    pulumi/pulumi-aws