Package com.pulumi.aws.docdb

Class ElasticCluster

  • public class ElasticCluster
extends com.pulumi.resources.CustomResource
    Manages an AWS DocDB (DocumentDB) Elastic Cluster. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.docdb.ElasticCluster;
 import com.pulumi.aws.docdb.ElasticClusterArgs;
 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 ElasticCluster("example", ElasticClusterArgs.builder()
             .name("my-docdb-cluster")
             .adminUserName("foo")
             .adminUserPassword("mustbeeightchars")
             .authType("PLAIN_TEXT")
             .shardCapacity(2)
             .shardCount(1)
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required - `arn` (String) ARN of the DocDB Elastic cluster. Using `pulumi import`, import DocDB (DocumentDB) Elastic Cluster using the `arn` argument. For example, ```sh $ pulumi import aws:docdb/elasticCluster:ElasticCluster example arn:aws:docdb-elastic:us-east-1:000011112222:cluster/12345678-7abc-def0-1234-56789abcdef ```

    • 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> adminUserName()  
      com.pulumi.core.Output<java.lang.String> adminUserPassword()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> authType()  
      com.pulumi.core.Output<java.lang.Integer> backupRetentionPeriod()  
      com.pulumi.core.Output<java.lang.String> endpoint()  
      static ElasticCluster get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ElasticClusterState 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> kmsKeyId()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> preferredBackupWindow()  
      com.pulumi.core.Output<java.lang.String> preferredMaintenanceWindow()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.Integer> shardCapacity()  
      com.pulumi.core.Output<java.lang.Integer> shardCount()  
      com.pulumi.core.Output<java.lang.Integer> shardInstanceCount()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> subnetIds()  
      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.util.Optional<ElasticClusterTimeouts>> timeouts()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> vpcSecurityGroupIds()  

      • 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

      • ElasticCluster

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

      • ElasticCluster

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

      • ElasticCluster

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

      • adminUserName

        public com.pulumi.core.Output<java.lang.String> adminUserName()
        Returns:
        Name of the Elastic DocumentDB cluster administrator

      • adminUserPassword

        public com.pulumi.core.Output<java.lang.String> adminUserPassword()
        Returns:
        Password for the Elastic DocumentDB cluster administrator. Can contain any printable ASCII characters. Must be at least 8 characters

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the DocumentDB Elastic Cluster

      • authType

        public com.pulumi.core.Output<java.lang.String> authType()
        Returns:
        Authentication type for the Elastic DocumentDB cluster. Valid values are `PLAIN_TEXT` and `SECRET_ARN`

      • backupRetentionPeriod

        public com.pulumi.core.Output<java.lang.Integer> backupRetentionPeriod()
        Returns:
        The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set.

      • endpoint

        public com.pulumi.core.Output<java.lang.String> endpoint()
        Returns:
        The DNS address of the DocDB instance

      • kmsKeyId

        public com.pulumi.core.Output<java.lang.String> kmsKeyId()
        Returns:
        ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the Elastic DocumentDB cluster

      • preferredBackupWindow

        public com.pulumi.core.Output<java.lang.String> preferredBackupWindow()
        Returns:
        The daily time range during which automated backups are created if automated backups are enabled, as determined by the `backupRetentionPeriod`.

      • preferredMaintenanceWindow

        public com.pulumi.core.Output<java.lang.String> preferredMaintenanceWindow()
        Returns:
        Weekly time range during which system maintenance can occur in UTC. Format: `ddd:hh24:mi-ddd:hh24:mi`. If not specified, AWS will choose a random 30-minute window on a random day of the week.

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

      • shardCapacity

        public com.pulumi.core.Output<java.lang.Integer> shardCapacity()
        Returns:
        Number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64

      • shardCount

        public com.pulumi.core.Output<java.lang.Integer> shardCount()
        Returns:
        Number of shards assigned to the elastic cluster. Maximum is 32 The following arguments are optional:

      • shardInstanceCount

        public com.pulumi.core.Output<java.lang.Integer> shardInstanceCount()
        Returns:
        Number of replica instances applying to all shards in the elastic cluster. If not specified, the default value of 2 is set.

      • subnetIds

        public com.pulumi.core.Output<java.util.List<java.lang.String>> subnetIds()
        Returns:
        IDs of subnets in which the Elastic DocumentDB Cluster operates.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the collection. 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()

      • vpcSecurityGroupIds

        public com.pulumi.core.Output<java.util.List<java.lang.String>> vpcSecurityGroupIds()
        Returns:
        List of VPC security groups to associate with the Elastic DocumentDB Cluster For more detailed documentation about each argument, refer to the [AWS official documentation](https://docs.aws.amazon.com/cli/latest/reference/docdb-elastic/create-cluster.html).

      • get

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