GlobalCluster class

Manages a Neptune Global Cluster. A global cluster consists of one primary region and up to five read-only secondary regions. You issue write operations directly to the primary cluster in the primary region and Amazon Neptune automatically replicates the data to the secondary regions using dedicated infrastructure.

More information about Neptune Global Clusters can be found in the Neptune User Guide.

Example Usage

New Neptune Global Cluster

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

const example = new aws.neptune.GlobalCluster("example", {
    globalClusterIdentifier: "global-test",
    engine: "neptune",
    engineVersion: "1.2.0.0",
});
const primary = new aws.neptune.Cluster("primary", {
    engine: example.engine,
    engineVersion: example.engineVersion,
    clusterIdentifier: "test-primary-cluster",
    globalClusterIdentifier: example.id,
    neptuneSubnetGroupName: "default",
});
const primaryClusterInstance = new aws.neptune.ClusterInstance("primary", {
    engine: example.engine,
    engineVersion: example.engineVersion,
    identifier: "test-primary-cluster-instance",
    clusterIdentifier: primary.id,
    instanceClass: "db.r5.large",
    neptuneSubnetGroupName: "default",
});
const secondary = new aws.neptune.Cluster("secondary", {
    engine: example.engine,
    engineVersion: example.engineVersion,
    clusterIdentifier: "test-secondary-cluster",
    globalClusterIdentifier: example.id,
    neptuneSubnetGroupName: "default",
});
const secondaryClusterInstance = new aws.neptune.ClusterInstance("secondary", {
    engine: example.engine,
    engineVersion: example.engineVersion,
    identifier: "test-secondary-cluster-instance",
    clusterIdentifier: secondary.id,
    instanceClass: "db.r5.large",
    neptuneSubnetGroupName: "default",
}, {
    dependsOn: [primaryClusterInstance],
});
import pulumi
import pulumi_aws as aws

example = aws.neptune.GlobalCluster("example",
    global_cluster_identifier="global-test",
    engine="neptune",
    engine_version="1.2.0.0")
primary = aws.neptune.Cluster("primary",
    engine=example.engine,
    engine_version=example.engine_version,
    cluster_identifier="test-primary-cluster",
    global_cluster_identifier=example.id,
    neptune_subnet_group_name="default")
primary_cluster_instance = aws.neptune.ClusterInstance("primary",
    engine=example.engine,
    engine_version=example.engine_version,
    identifier="test-primary-cluster-instance",
    cluster_identifier=primary.id,
    instance_class="db.r5.large",
    neptune_subnet_group_name="default")
secondary = aws.neptune.Cluster("secondary",
    engine=example.engine,
    engine_version=example.engine_version,
    cluster_identifier="test-secondary-cluster",
    global_cluster_identifier=example.id,
    neptune_subnet_group_name="default")
secondary_cluster_instance = aws.neptune.ClusterInstance("secondary",
    engine=example.engine,
    engine_version=example.engine_version,
    identifier="test-secondary-cluster-instance",
    cluster_identifier=secondary.id,
    instance_class="db.r5.large",
    neptune_subnet_group_name="default",
    opts = pulumi.ResourceOptions(depends_on=[primary_cluster_instance]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Neptune.GlobalCluster("example", new()
    {
        GlobalClusterIdentifier = "global-test",
        Engine = "neptune",
        EngineVersion = "1.2.0.0",
    });

    var primary = new Aws.Neptune.Cluster("primary", new()
    {
        Engine = example.Engine,
        EngineVersion = example.EngineVersion,
        ClusterIdentifier = "test-primary-cluster",
        GlobalClusterIdentifier = example.Id,
        NeptuneSubnetGroupName = "default",
    });

    var primaryClusterInstance = new Aws.Neptune.ClusterInstance("primary", new()
    {
        Engine = example.Engine,
        EngineVersion = example.EngineVersion,
        Identifier = "test-primary-cluster-instance",
        ClusterIdentifier = primary.Id,
        InstanceClass = "db.r5.large",
        NeptuneSubnetGroupName = "default",
    });

    var secondary = new Aws.Neptune.Cluster("secondary", new()
    {
        Engine = example.Engine,
        EngineVersion = example.EngineVersion,
        ClusterIdentifier = "test-secondary-cluster",
        GlobalClusterIdentifier = example.Id,
        NeptuneSubnetGroupName = "default",
    });

    var secondaryClusterInstance = new Aws.Neptune.ClusterInstance("secondary", new()
    {
        Engine = example.Engine,
        EngineVersion = example.EngineVersion,
        Identifier = "test-secondary-cluster-instance",
        ClusterIdentifier = secondary.Id,
        InstanceClass = "db.r5.large",
        NeptuneSubnetGroupName = "default",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            primaryClusterInstance,
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/neptune"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := neptune.NewGlobalCluster(ctx, "example", &neptune.GlobalClusterArgs{
			GlobalClusterIdentifier: pulumi.String("global-test"),
			Engine:                  pulumi.String("neptune"),
			EngineVersion:           pulumi.String("1.2.0.0"),
		})
		if err != nil {
			return err
		}
		primary, err := neptune.NewCluster(ctx, "primary", &neptune.ClusterArgs{
			Engine:                  example.Engine,
			EngineVersion:           example.EngineVersion,
			ClusterIdentifier:       pulumi.String("test-primary-cluster"),
			GlobalClusterIdentifier: example.ID().ToIDOutput().ToStringOutput(),
			NeptuneSubnetGroupName:  pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		primaryClusterInstance, err := neptune.NewClusterInstance(ctx, "primary", &neptune.ClusterInstanceArgs{
			Engine:                 example.Engine,
			EngineVersion:          example.EngineVersion,
			Identifier:             pulumi.String("test-primary-cluster-instance"),
			ClusterIdentifier:      primary.ID().ToIDOutput().ToStringOutput(),
			InstanceClass:          pulumi.String("db.r5.large"),
			NeptuneSubnetGroupName: pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		secondary, err := neptune.NewCluster(ctx, "secondary", &neptune.ClusterArgs{
			Engine:                  example.Engine,
			EngineVersion:           example.EngineVersion,
			ClusterIdentifier:       pulumi.String("test-secondary-cluster"),
			GlobalClusterIdentifier: example.ID().ToIDOutput().ToStringOutput(),
			NeptuneSubnetGroupName:  pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		_, err = neptune.NewClusterInstance(ctx, "secondary", &neptune.ClusterInstanceArgs{
			Engine:                 example.Engine,
			EngineVersion:          example.EngineVersion,
			Identifier:             pulumi.String("test-secondary-cluster-instance"),
			ClusterIdentifier:      secondary.ID().ToIDOutput().ToStringOutput(),
			InstanceClass:          pulumi.String("db.r5.large"),
			NeptuneSubnetGroupName: pulumi.String("default"),
		}, pulumi.DependsOn([]pulumi.Resource{
			primaryClusterInstance,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_neptune_globalcluster" "example" {
  global_cluster_identifier = "global-test"
  engine                    = "neptune"
  engine_version            = "1.2.0.0"
}
resource "aws_neptune_cluster" "primary" {
  engine                    = aws_neptune_globalcluster.example.engine
  engine_version            = aws_neptune_globalcluster.example.engine_version
  cluster_identifier        = "test-primary-cluster"
  global_cluster_identifier = aws_neptune_globalcluster.example.id
  neptune_subnet_group_name = "default"
}
resource "aws_neptune_clusterinstance" "primary" {
  engine                    = aws_neptune_globalcluster.example.engine
  engine_version            = aws_neptune_globalcluster.example.engine_version
  identifier                = "test-primary-cluster-instance"
  cluster_identifier        = aws_neptune_cluster.primary.id
  instance_class            = "db.r5.large"
  neptune_subnet_group_name = "default"
}
resource "aws_neptune_cluster" "secondary" {
  engine                    = aws_neptune_globalcluster.example.engine
  engine_version            = aws_neptune_globalcluster.example.engine_version
  cluster_identifier        = "test-secondary-cluster"
  global_cluster_identifier = aws_neptune_globalcluster.example.id
  neptune_subnet_group_name = "default"
}
resource "aws_neptune_clusterinstance" "secondary" {
  depends_on                = [aws_neptune_clusterinstance.primary]
  engine                    = aws_neptune_globalcluster.example.engine
  engine_version            = aws_neptune_globalcluster.example.engine_version
  identifier                = "test-secondary-cluster-instance"
  cluster_identifier        = aws_neptune_cluster.secondary.id
  instance_class            = "db.r5.large"
  neptune_subnet_group_name = "default"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.neptune.GlobalCluster;
import com.pulumi.aws.neptune.GlobalClusterArgs;
import com.pulumi.aws.neptune.Cluster;
import com.pulumi.aws.neptune.ClusterArgs;
import com.pulumi.aws.neptune.ClusterInstance;
import com.pulumi.aws.neptune.ClusterInstanceArgs;
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 GlobalCluster("example", GlobalClusterArgs.builder()
            .globalClusterIdentifier("global-test")
            .engine("neptune")
            .engineVersion("1.2.0.0")
            .build());

        var primary = new Cluster("primary", ClusterArgs.builder()
            .engine(example.engine())
            .engineVersion(example.engineVersion())
            .clusterIdentifier("test-primary-cluster")
            .globalClusterIdentifier(example.id())
            .neptuneSubnetGroupName("default")
            .build());

        var primaryClusterInstance = new ClusterInstance("primaryClusterInstance", ClusterInstanceArgs.builder()
            .engine(example.engine())
            .engineVersion(example.engineVersion())
            .identifier("test-primary-cluster-instance")
            .clusterIdentifier(primary.id())
            .instanceClass("db.r5.large")
            .neptuneSubnetGroupName("default")
            .build());

        var secondary = new Cluster("secondary", ClusterArgs.builder()
            .engine(example.engine())
            .engineVersion(example.engineVersion())
            .clusterIdentifier("test-secondary-cluster")
            .globalClusterIdentifier(example.id())
            .neptuneSubnetGroupName("default")
            .build());

        var secondaryClusterInstance = new ClusterInstance("secondaryClusterInstance", ClusterInstanceArgs.builder()
            .engine(example.engine())
            .engineVersion(example.engineVersion())
            .identifier("test-secondary-cluster-instance")
            .clusterIdentifier(secondary.id())
            .instanceClass("db.r5.large")
            .neptuneSubnetGroupName("default")
            .build(), CustomResourceOptions.builder()
                .dependsOn(primaryClusterInstance)
                .build());

    }
}
resources:
  example:
    type: aws:neptune:GlobalCluster
    properties:
      globalClusterIdentifier: global-test
      engine: neptune
      engineVersion: 1.2.0.0
  primary:
    type: aws:neptune:Cluster
    properties:
      engine: ${example.engine}
      engineVersion: ${example.engineVersion}
      clusterIdentifier: test-primary-cluster
      globalClusterIdentifier: ${example.id}
      neptuneSubnetGroupName: default
  primaryClusterInstance:
    type: aws:neptune:ClusterInstance
    name: primary
    properties:
      engine: ${example.engine}
      engineVersion: ${example.engineVersion}
      identifier: test-primary-cluster-instance
      clusterIdentifier: ${primary.id}
      instanceClass: db.r5.large
      neptuneSubnetGroupName: default
  secondary:
    type: aws:neptune:Cluster
    properties:
      engine: ${example.engine}
      engineVersion: ${example.engineVersion}
      clusterIdentifier: test-secondary-cluster
      globalClusterIdentifier: ${example.id}
      neptuneSubnetGroupName: default
  secondaryClusterInstance:
    type: aws:neptune:ClusterInstance
    name: secondary
    properties:
      engine: ${example.engine}
      engineVersion: ${example.engineVersion}
      identifier: test-secondary-cluster-instance
      clusterIdentifier: ${secondary.id}
      instanceClass: db.r5.large
      neptuneSubnetGroupName: default
    options:
      dependsOn:
        - ${primaryClusterInstance}

New Global Cluster From Existing DB Cluster

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

const example = new aws.neptune.Cluster("example", {}, {
    ignoreChanges: ["globalClusterIdentifier"],
});
const exampleGlobalCluster = new aws.neptune.GlobalCluster("example", {
    globalClusterIdentifier: "example",
    sourceDbClusterIdentifier: example.arn,
});
import pulumi
import pulumi_aws as aws

example = aws.neptune.Cluster("example", opts = pulumi.ResourceOptions(ignore_changes=["globalClusterIdentifier"]))
example_global_cluster = aws.neptune.GlobalCluster("example",
    global_cluster_identifier="example",
    source_db_cluster_identifier=example.arn)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Neptune.Cluster("example", new()
    {
    }, new CustomResourceOptions
    {
        IgnoreChanges =
        {
            "globalClusterIdentifier",
        },
    });

    var exampleGlobalCluster = new Aws.Neptune.GlobalCluster("example", new()
    {
        GlobalClusterIdentifier = "example",
        SourceDbClusterIdentifier = example.Arn,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/neptune"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := neptune.NewCluster(ctx, "example", nil, pulumi.IgnoreChanges([]string{
			"globalClusterIdentifier",
		}))
		if err != nil {
			return err
		}
		_, err = neptune.NewGlobalCluster(ctx, "example", &neptune.GlobalClusterArgs{
			GlobalClusterIdentifier:   pulumi.String("example"),
			SourceDbClusterIdentifier: example.Arn,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_neptune_cluster" "example" {
  lifecycle {
    ignore_changes = [globalClusterIdentifier]
  }
}
resource "aws_neptune_globalcluster" "example" {
  global_cluster_identifier    = "example"
  source_db_cluster_identifier = aws_neptune_cluster.example.arn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.neptune.Cluster;
import com.pulumi.aws.neptune.ClusterArgs;
import com.pulumi.aws.neptune.GlobalCluster;
import com.pulumi.aws.neptune.GlobalClusterArgs;
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 Cluster("example", ClusterArgs.Empty, CustomResourceOptions.builder()
            .ignoreChanges("globalClusterIdentifier")
            .build());

        var exampleGlobalCluster = new GlobalCluster("exampleGlobalCluster", GlobalClusterArgs.builder()
            .globalClusterIdentifier("example")
            .sourceDbClusterIdentifier(example.arn())
            .build());

    }
}
resources:
  example:
    type: aws:neptune:Cluster
    options:
      ignoreChanges:
        - globalClusterIdentifier
  exampleGlobalCluster:
    type: aws:neptune:GlobalCluster
    name: example
    properties:
      globalClusterIdentifier: example
      sourceDbClusterIdentifier: ${example.arn}

Import

Using pulumi import, import aws.neptune.GlobalCluster using the Global Cluster identifier. For example:

$ pulumi import aws:neptune/globalCluster:GlobalCluster example example

Certain resource arguments, like sourceDbClusterIdentifier, do not have an API method for reading the information after creation. If the argument is set in the Pulumi program on an imported resource, Pulumi will always show a difference. To workaround this behavior, either omit the argument from the Pulumi program or use ignoreChanges to hide the difference. For example:

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

const example = new aws.neptune.GlobalCluster("example", {}, {
    ignoreChanges: ["sourceDbClusterIdentifier"],
});
import pulumi
import pulumi_aws as aws

example = aws.neptune.GlobalCluster("example", opts = pulumi.ResourceOptions(ignore_changes=["sourceDbClusterIdentifier"]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Neptune.GlobalCluster("example", new()
    {
    }, new CustomResourceOptions
    {
        IgnoreChanges =
        {
            "sourceDbClusterIdentifier",
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/neptune"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := neptune.NewGlobalCluster(ctx, "example", nil, pulumi.IgnoreChanges([]string{
			"sourceDbClusterIdentifier",
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_neptune_globalcluster" "example" {
  lifecycle {
    ignore_changes = [sourceDbClusterIdentifier]
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.neptune.GlobalCluster;
import com.pulumi.aws.neptune.GlobalClusterArgs;
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 GlobalCluster("example", GlobalClusterArgs.Empty, CustomResourceOptions.builder()
            .ignoreChanges("sourceDbClusterIdentifier")
            .build());

    }
}
resources:
  example:
    type: aws:neptune:GlobalCluster
    options:
      ignoreChanges:
        - sourceDbClusterIdentifier

Constructors

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

Properties

arn ↔ Output<String>
Global Cluster ARN
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
deletionProtection ↔ Output<bool?>
If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
latefinal
engine ↔ Output<String>
Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Current Valid values: neptune. Conflicts with sourceDbClusterIdentifier.
latefinal
engineVersion ↔ Output<String>
Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will.
latefinal
globalClusterIdentifier ↔ Output<String>
Global cluster identifier.
latefinal
globalClusterMembers ↔ Output<List<GlobalClusterGlobalClusterMember>>
Set of objects containing Global Cluster members.
latefinal
globalClusterResourceId ↔ Output<String>
AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
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
sourceDbClusterIdentifier ↔ Output<String>
ARN to use as the primary DB Cluster of the Global Cluster on creation. Pulumi cannot perform drift detection of this value.
latefinal
status ↔ Output<String>
latefinal
storageEncrypted ↔ Output<bool>
Whether the DB cluster is encrypted. The default is false unless sourceDbClusterIdentifier is specified and encrypted. Pulumi will only perform drift detection if a configuration value is provided.
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, {GlobalClusterState? state, CustomResourceOptions? options}) → GlobalCluster
Gets an existing GlobalCluster resource's state with the given name and id.