ClusterPeering class
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)
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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: example1.MultiRegionProperties.WitnessRegion(),
})
if err != nil {
return err
}
_, err = dsql.NewClusterPeering(ctx, "example_2", &dsql.ClusterPeeringArgs{
Identifier: example2.Identifier,
Clusters: pulumi.StringArray{
example1.Arn,
},
WitnessRegion: example2.MultiRegionProperties.WitnessRegion(),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_dsql_cluster" "example_1" {
multi_region_properties = {
witness_region = "us-west-2"
}
}
resource "aws_dsql_cluster" "example_2" {
multi_region_properties = {
witness_region = "us-west-2"
}
}
resource "aws_dsql_clusterpeering" "example_1" {
identifier = aws_dsql_cluster.example_1.identifier
clusters = [aws_dsql_cluster.example_2.arn]
witness_region = aws_dsql_cluster.example_1.multi_region_properties.witness_region
}
resource "aws_dsql_clusterpeering" "example_2" {
identifier = aws_dsql_cluster.example_2.identifier
clusters = [aws_dsql_cluster.example_1.arn]
witness_region = aws_dsql_cluster.example_2.multi_region_properties.witness_region
}
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.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 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}
Import
Using pulumi import, import DSQL Cluster Peering using the identifier. For example:
$ pulumi import aws:dsql/clusterPeering:ClusterPeering example cluster-id-12345678
Constructors
- ClusterPeering(String name, {ClusterPeeringArgs? args, CustomResourceOptions? options})
-
Creates a new ClusterPeering.
nameThe Pulumi resource name.argsArguments used to configure this ClusterPeering. The set of arguments for ClusterPeering.optionsResource options controlling this resource's behavior. - ClusterPeering.reference(String urn)
- Creates a typed reference to an existing ClusterPeering resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
clusters
↔ Output<
List< String> > -
List of DSQL Cluster ARNs to be peered to this cluster.
latefinal
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
identifier
↔ Output<
String> -
DSQL Cluster Identifier.
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
-
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
-
timeouts
↔ Output<
ClusterPeeringTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
witnessRegion
↔ Output<
String> -
Witness region for a multi-region cluster.
latefinal
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, {ClusterPeeringState? state, CustomResourceOptions? options}) → ClusterPeering -
Gets an existing ClusterPeering resource's state with the given
nameandid.