java.lang.Object
- com.pulumi.resources.Resource
- - com.pulumi.resources.CustomResource
  - - com.pulumi.aws.docdb.GlobalCluster

public class GlobalCluster
extends com.pulumi.resources.CustomResource

Manages an DocumentDB 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 DocumentDB automatically replicates the data to the secondary regions using dedicated infrastructure. More information about DocumentDB Global Clusters can be found in the [DocumentDB Developer Guide](https://docs.aws.amazon.com/documentdb/latest/developerguide/global-clusters.html). ## Example Usage ### New DocumentDB Global Cluster

 
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.docdb.GlobalCluster;
 import com.pulumi.aws.docdb.GlobalClusterArgs;
 import com.pulumi.aws.docdb.Cluster;
 import com.pulumi.aws.docdb.ClusterArgs;
 import com.pulumi.aws.docdb.ClusterInstance;
 import com.pulumi.aws.docdb.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("docdb")
             .engineVersion("4.0.0")
             .build());
 
         var primary = new Cluster("primary", ClusterArgs.builder()
             .engine(example.engine())
             .engineVersion(example.engineVersion())
             .clusterIdentifier("test-primary-cluster")
             .masterUsername("username")
             .masterPassword("somepass123")
             .globalClusterIdentifier(example.id())
             .dbSubnetGroupName("default")
             .build());
 
         var primaryClusterInstance = new ClusterInstance("primaryClusterInstance", ClusterInstanceArgs.builder()
             .engine(example.engine())
             .identifier("test-primary-cluster-instance")
             .clusterIdentifier(primary.id())
             .instanceClass("db.r5.large")
             .build());
 
         var secondary = new Cluster("secondary", ClusterArgs.builder()
             .engine(example.engine())
             .engineVersion(example.engineVersion())
             .clusterIdentifier("test-secondary-cluster")
             .globalClusterIdentifier(example.id())
             .dbSubnetGroupName("default")
             .build(), CustomResourceOptions.builder()
                 .dependsOn(primary)
                 .build());
 
         var secondaryClusterInstance = new ClusterInstance("secondaryClusterInstance", ClusterInstanceArgs.builder()
             .engine(example.engine())
             .identifier("test-secondary-cluster-instance")
             .clusterIdentifier(secondary.id())
             .instanceClass("db.r5.large")
             .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.docdb.Cluster;
 import com.pulumi.aws.docdb.ClusterArgs;
 import com.pulumi.aws.docdb.GlobalCluster;
 import com.pulumi.aws.docdb.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.docdb.GlobalCluster` using the Global Cluster identifier. For example: ```sh $ pulumi import aws:docdb/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.docdb.GlobalCluster;
 import com.pulumi.aws.docdb.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

Constructor Summary

Constructors
Constructor	Description
`GlobalCluster(java.lang.String name)`
`GlobalCluster(java.lang.String name, GlobalClusterArgs args)`
`GlobalCluster(java.lang.String name, GlobalClusterArgs args, com.pulumi.resources.CustomResourceOptions options)`

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.String>>`	`databaseName()`
`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
  - databaseName
```
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> databaseName()
```
    Returns:
    
    Name for an automatically created database on cluster creation.
  - 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: `docdb`. Defaults to `docdb`. 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. * **NOTE:** Upgrading major versions is not supported.
  - globalClusterIdentifier
```
public com.pulumi.core.Output<java.lang.String> globalClusterIdentifier()
```
    Returns:
    
    The 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:
    
    Specifies whether the DB cluster is encrypted. The default is `false` unless `sourceDbClusterIdentifier` is specified and encrypted. The provider 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.

Class GlobalCluster

Nested Class Summary

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

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

Field Summary

Fields inherited from class com.pulumi.resources.Resource

Constructor Summary

Method Summary

Methods inherited from class com.pulumi.resources.CustomResource

Methods inherited from class com.pulumi.resources.Resource

Methods inherited from class java.lang.Object

Constructor Detail

GlobalCluster

GlobalCluster

GlobalCluster

Method Detail

arn

databaseName

deletionProtection

engine

engineVersion

globalClusterIdentifier

globalClusterMembers

globalClusterResourceId

region

sourceDbClusterIdentifier

status

storageEncrypted

get