Package com.pulumi.aws.docdb.inputs

Class ElasticClusterState

  • public final class ElasticClusterState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ElasticClusterState.Builder  

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

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> adminUserName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> adminUserPassword()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> authType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> backupRetentionPeriod()  
      static ElasticClusterState.Builder builder()  
      static ElasticClusterState.Builder builder​(ElasticClusterState defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpoint()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> preferredBackupWindow()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> preferredMaintenanceWindow()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> shardCapacity()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> shardCount()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> shardInstanceCount()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> subnetIds()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()  
      java.util.Optional<com.pulumi.core.Output<ElasticClusterTimeoutsArgs>> timeouts()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> vpcSecurityGroupIds()  

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

        validateMember

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • adminUserName

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

      • adminUserPassword

        public java.util.Optional<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 java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of the DocumentDB Elastic Cluster

      • authType

        public java.util.Optional<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 java.util.Optional<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 java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpoint()
        Returns:
        The DNS address of the DocDB instance

      • kmsKeyId

        public java.util.Optional<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 java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Name of the Elastic DocumentDB cluster

      • preferredBackupWindow

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

      • tags

        public java.util.Optional<com.pulumi.core.Output<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 java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()

      • vpcSecurityGroupIds

        public java.util.Optional<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).