Package com.pulumi.aws.docdb.inputs

Class ClusterInstanceState

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ClusterInstanceState.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.Boolean>> applyImmediately()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> autoMinorVersionUpgrade()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> availabilityZone()  
      static ClusterInstanceState.Builder builder()  
      static ClusterInstanceState.Builder builder​(ClusterInstanceState defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> caCertIdentifier()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> certificateRotationRestart()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterIdentifier()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> copyTagsToSnapshot()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbiResourceId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbSubnetGroupName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enablePerformanceInsights()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpoint()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> engine()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersion()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> identifier()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> identifierPrefix()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> instanceClass()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> performanceInsightsKmsKeyId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()  
      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.Integer>> promotionTier()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> publiclyAccessible()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> storageEncrypted()  
      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<java.lang.Boolean>> writer()  

      • 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

      • applyImmediately

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

      • arn

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

      • autoMinorVersionUpgrade

        public java.util.Optional<com.pulumi.core.Output<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 java.util.Optional<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 java.util.Optional<com.pulumi.core.Output<java.lang.String>> caCertIdentifier()
        Returns:
        Identifier of the certificate authority (CA) certificate for the DB instance.

      • certificateRotationRestart

        public java.util.Optional<com.pulumi.core.Output<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 java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterIdentifier()
        Returns:
        Identifier of the `aws.docdb.Cluster` in which to launch this instance.

      • copyTagsToSnapshot

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

      • dbSubnetGroupName

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

      • dbiResourceId

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

      • enablePerformanceInsights

        public java.util.Optional<com.pulumi.core.Output<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 java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpoint()
        Returns:
        DNS address for this instance. May not be writable

      • engine

        public java.util.Optional<com.pulumi.core.Output<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 java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersion()
        Returns:
        Database engine version

      • identifier

        public java.util.Optional<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 java.util.Optional<com.pulumi.core.Output<java.lang.String>> identifierPrefix()
        Returns:
        Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`.

      • instanceClass

        public java.util.Optional<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 java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()
        Returns:
        ARN for the KMS encryption key if one is set to the cluster.

      • performanceInsightsKmsKeyId

        public java.util.Optional<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 java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()
        Returns:
        Database port

      • preferredBackupWindow

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

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

      • storageEncrypted

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

      • tags

        public java.util.Optional<com.pulumi.core.Output<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 java.util.Optional<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 java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> writer()
        Returns:
        Whether this instance is writable. `False` indicates this instance is a read replica.