Package com.pulumi.aws.docdb

Class ClusterInstance

  • public class ClusterInstance
extends com.pulumi.resources.CustomResource
    Provides an DocumentDB Cluster Resource Instance. A Cluster Instance Resource defines attributes that are specific to a single instance in a DocumentDB Cluster. You do not designate a primary and subsequent replicas. Instead, you simply add DocumentDB Instances and DocumentDB manages the replication. You can use the count meta-parameter to make multiple instances and join them all to the same DocumentDB Cluster, or you may specify different Cluster Instance resources with various `instanceClass` sizes. ## Example Usage 
     
 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.ClusterInstance;
 import com.pulumi.aws.docdb.ClusterInstanceArgs;
 import com.pulumi.codegen.internal.KeyedValue;
 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 default_ = new Cluster("default", ClusterArgs.builder()
             .clusterIdentifier("docdb-cluster-demo")
             .availabilityZones(            
                 "us-west-2a",
                 "us-west-2b",
                 "us-west-2c")
             .masterUsername("foo")
             .masterPassword("barbut8chars")
             .build());
 
         for (var i = 0; i < 2; i++) {
             new ClusterInstance("clusterInstances-" + i, ClusterInstanceArgs.builder()
                 .identifier(String.format("docdb-cluster-demo-%s", range.value()))
                 .clusterIdentifier(default_.id())
                 .instanceClass("db.r5.large")
                 .build());
 
         
 }
     }
 }
    ## Import Using `pulumi import`, import DocumentDB Cluster Instances using the `identifier`. For example: ```sh $ pulumi import aws:docdb/clusterInstance:ClusterInstance prod_instance_1 aurora-cluster-instance-1 ```

    • 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.util.Optional<java.lang.Boolean>> applyImmediately()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> autoMinorVersionUpgrade()  
      com.pulumi.core.Output<java.lang.String> availabilityZone()  
      com.pulumi.core.Output<java.lang.String> caCertIdentifier()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> certificateRotationRestart()  
      com.pulumi.core.Output<java.lang.String> clusterIdentifier()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> copyTagsToSnapshot()  
      com.pulumi.core.Output<java.lang.String> dbiResourceId()  
      com.pulumi.core.Output<java.lang.String> dbSubnetGroupName()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enablePerformanceInsights()  
      com.pulumi.core.Output<java.lang.String> endpoint()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> engine()  
      com.pulumi.core.Output<java.lang.String> engineVersion()  
      static ClusterInstance get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ClusterInstanceState 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> identifier()  
      com.pulumi.core.Output<java.lang.String> identifierPrefix()  
      com.pulumi.core.Output<java.lang.String> instanceClass()  
      com.pulumi.core.Output<java.lang.String> kmsKeyId()  
      com.pulumi.core.Output<java.lang.String> performanceInsightsKmsKeyId()  
      com.pulumi.core.Output<java.lang.Integer> port()  
      com.pulumi.core.Output<java.lang.String> preferredBackupWindow()  
      com.pulumi.core.Output<java.lang.String> preferredMaintenanceWindow()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> promotionTier()  
      com.pulumi.core.Output<java.lang.Boolean> publiclyAccessible()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.Boolean> storageEncrypted()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.Boolean> writer()  

      • 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

      • ClusterInstance

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

      • ClusterInstance

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

      • ClusterInstance

        public ClusterInstance​(java.lang.String name,
                       ClusterInstanceArgs 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

      • applyImmediately

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> applyImmediately()
        Returns:
        Whether any database modifications are applied immediately, or during the next maintenance window. Default is`false`.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of cluster instance

      • autoMinorVersionUpgrade

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> autoMinorVersionUpgrade()
        Returns:
        Parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see [docs](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBInstance.html)). Default `true`.

      • availabilityZone

        public com.pulumi.core.Output<java.lang.String> availabilityZone()
        Returns:
        EC2 Availability Zone that the DB instance is created in. See [docs](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_CreateDBInstance.html) about the details.

      • caCertIdentifier

        public com.pulumi.core.Output<java.lang.String> caCertIdentifier()
        Returns:
        Identifier of the certificate authority (CA) certificate for the DB instance.

      • certificateRotationRestart

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> certificateRotationRestart()
        Returns:
        Whether to restart the DB instance when rotating its SSL/TLS certificate. By default, AWS restarts the DB instance when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set to `false` only if you are not using SSL/TLS to connect to the DB instance.

      • clusterIdentifier

        public com.pulumi.core.Output<java.lang.String> clusterIdentifier()
        Returns:
        Identifier of the `aws.docdb.Cluster` in which to launch this instance.

      • copyTagsToSnapshot

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> copyTagsToSnapshot()
        Returns:
        Copy all DB instance `tags` to snapshots. Default is `false`.

      • dbSubnetGroupName

        public com.pulumi.core.Output<java.lang.String> dbSubnetGroupName()
        Returns:
        DB subnet group to associate with this DB instance.

      • dbiResourceId

        public com.pulumi.core.Output<java.lang.String> dbiResourceId()
        Returns:
        Region-unique, immutable identifier for the DB instance.

      • enablePerformanceInsights

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enablePerformanceInsights()
        Returns:
        Value that indicates whether to enable Performance Insights for the DB Instance. Default `false`. See [docs] (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details.

      • endpoint

        public com.pulumi.core.Output<java.lang.String> endpoint()
        Returns:
        DNS address for this instance. May not be writable

      • engine

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> engine()
        Returns:
        Name of the database engine to be used for the DocumentDB instance. Defaults to `docdb`. Valid Values: `docdb`.

      • engineVersion

        public com.pulumi.core.Output<java.lang.String> engineVersion()
        Returns:
        Database engine version

      • identifier

        public com.pulumi.core.Output<java.lang.String> identifier()
        Returns:
        The identifier for the DocumentDB instance, if omitted, the provider will assign a random, unique identifier.

      • identifierPrefix

        public com.pulumi.core.Output<java.lang.String> identifierPrefix()
        Returns:
        Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`.

      • instanceClass

        public com.pulumi.core.Output<java.lang.String> instanceClass()
        Returns:
        Instance class to use. For details on CPU and memory, see [Scaling for DocumentDB Instances](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-manage-performance.html#db-cluster-manage-scaling-instance). See the `aws.docdb.getOrderableDbInstance` data source. See [AWS Documentation](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-classes.html#db-instance-class-specs) for complete details.

      • kmsKeyId

        public com.pulumi.core.Output<java.lang.String> kmsKeyId()
        Returns:
        ARN for the KMS encryption key if one is set to the cluster.

      • performanceInsightsKmsKeyId

        public com.pulumi.core.Output<java.lang.String> performanceInsightsKmsKeyId()
        Returns:
        KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key.

      • port

        public com.pulumi.core.Output<java.lang.Integer> port()
        Returns:
        Database port

      • preferredBackupWindow

        public com.pulumi.core.Output<java.lang.String> preferredBackupWindow()
        Returns:
        Daily time range during which automated backups are created if automated backups are enabled.

      • preferredMaintenanceWindow

        public com.pulumi.core.Output<java.lang.String> preferredMaintenanceWindow()
        Returns:
        Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".

      • promotionTier

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> promotionTier()
        Returns:
        Failover Priority setting on instance level. Default `0`. The reader who has lower tier has higher priority to get promoter to writer.

      • publiclyAccessible

        public com.pulumi.core.Output<java.lang.Boolean> publiclyAccessible()

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

      • storageEncrypted

        public com.pulumi.core.Output<java.lang.Boolean> storageEncrypted()
        Returns:
        Whether the DB cluster is encrypted.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the instance. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • writer

        public com.pulumi.core.Output<java.lang.Boolean> writer()
        Returns:
        Whether this instance is writable. `False` indicates this instance is a read replica.

      • get

        public static ClusterInstance get​(java.lang.String name,
                                  com.pulumi.core.Output<java.lang.String> id,
                                  @Nullable
                                  ClusterInstanceState 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.