Package com.pulumi.aws.neptune

Class GlobalCluster

  • public class GlobalCluster
extends com.pulumi.resources.CustomResource
    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](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-global-database.html). ## Example Usage ### New Neptune Global Cluster 
     
 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());
 
     }
 }
    ### New Global Cluster From Existing DB Cluster 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.neptune.GlobalCluster` using the Global Cluster identifier. For example: ```sh $ 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: 
     
 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());
 
     }
 }

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> deletionProtection()  
      com.pulumi.core.Output<java.lang.String> engine()  
      com.pulumi.core.Output<java.lang.String> engineVersion()  
      static GlobalCluster get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, GlobalClusterState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> globalClusterIdentifier()  
      com.pulumi.core.Output<java.util.List<GlobalClusterGlobalClusterMember>> globalClusterMembers()  
      com.pulumi.core.Output<java.lang.String> globalClusterResourceId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> sourceDbClusterIdentifier()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.lang.Boolean> storageEncrypted()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • GlobalCluster

        public GlobalCluster​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • GlobalCluster

        public GlobalCluster​(java.lang.String name,
                     GlobalClusterArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • GlobalCluster

        public GlobalCluster​(java.lang.String name,
                     GlobalClusterArgs args,
                     @Nullable
                     com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        Global Cluster ARN

      • deletionProtection

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> deletionProtection()
        Returns:
        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`.

      • engine

        public com.pulumi.core.Output<java.lang.String> engine()
        Returns:
        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`.

      • engineVersion

        public com.pulumi.core.Output<java.lang.String> engineVersion()
        Returns:
        Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will.

      • globalClusterIdentifier

        public com.pulumi.core.Output<java.lang.String> globalClusterIdentifier()
        Returns:
        Global cluster identifier.

      • globalClusterMembers

        public com.pulumi.core.Output<java.util.List<GlobalClusterGlobalClusterMember>> globalClusterMembers()
        Returns:
        Set of objects containing Global Cluster members.

      • globalClusterResourceId

        public com.pulumi.core.Output<java.lang.String> globalClusterResourceId()
        Returns:
        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.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • sourceDbClusterIdentifier

        public com.pulumi.core.Output<java.lang.String> sourceDbClusterIdentifier()
        Returns:
        ARN to use as the primary DB Cluster of the Global Cluster on creation. Pulumi cannot perform drift detection of this value.

      • status

        public com.pulumi.core.Output<java.lang.String> status()

      • storageEncrypted

        public com.pulumi.core.Output<java.lang.Boolean> storageEncrypted()
        Returns:
        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.

      • get

        public static GlobalCluster get​(java.lang.String name,
                                com.pulumi.core.Output<java.lang.String> id,
                                @Nullable
                                GlobalClusterState state,
                                @Nullable
                                com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.