Package com.pulumi.aws.docdb.inputs

Class ClusterInstanceState.Builder

  • Enclosing class:
    ClusterInstanceState
    public static final class ClusterInstanceState.Builder
extends java.lang.Object

    • Method Detail

      • applyImmediately

        public ClusterInstanceState.Builder applyImmediately​(@Nullable
                                                     com.pulumi.core.Output<java.lang.Boolean> applyImmediately)
        Parameters:
        applyImmediately - Whether any database modifications are applied immediately, or during the next maintenance window. Default is`false`.
        Returns:
        builder

      • applyImmediately

        public ClusterInstanceState.Builder applyImmediately​(java.lang.Boolean applyImmediately)
        Parameters:
        applyImmediately - Whether any database modifications are applied immediately, or during the next maintenance window. Default is`false`.
        Returns:
        builder

      • arn

        public ClusterInstanceState.Builder arn​(@Nullable
                                        com.pulumi.core.Output<java.lang.String> arn)
        Parameters:
        arn - ARN of cluster instance
        Returns:
        builder

      • autoMinorVersionUpgrade

        public ClusterInstanceState.Builder autoMinorVersionUpgrade​(@Nullable
                                                            com.pulumi.core.Output<java.lang.Boolean> autoMinorVersionUpgrade)
        Parameters:
        autoMinorVersionUpgrade - 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`.
        Returns:
        builder

      • autoMinorVersionUpgrade

        public ClusterInstanceState.Builder autoMinorVersionUpgrade​(java.lang.Boolean autoMinorVersionUpgrade)
        Parameters:
        autoMinorVersionUpgrade - 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`.
        Returns:
        builder

      • availabilityZone

        public ClusterInstanceState.Builder availabilityZone​(@Nullable
                                                     com.pulumi.core.Output<java.lang.String> availabilityZone)
        Parameters:
        availabilityZone - 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.
        Returns:
        builder

      • availabilityZone

        public ClusterInstanceState.Builder availabilityZone​(java.lang.String availabilityZone)
        Parameters:
        availabilityZone - 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.
        Returns:
        builder

      • caCertIdentifier

        public ClusterInstanceState.Builder caCertIdentifier​(@Nullable
                                                     com.pulumi.core.Output<java.lang.String> caCertIdentifier)
        Parameters:
        caCertIdentifier - Identifier of the certificate authority (CA) certificate for the DB instance.
        Returns:
        builder

      • caCertIdentifier

        public ClusterInstanceState.Builder caCertIdentifier​(java.lang.String caCertIdentifier)
        Parameters:
        caCertIdentifier - Identifier of the certificate authority (CA) certificate for the DB instance.
        Returns:
        builder

      • certificateRotationRestart

        public ClusterInstanceState.Builder certificateRotationRestart​(@Nullable
                                                               com.pulumi.core.Output<java.lang.String> certificateRotationRestart)
        Parameters:
        certificateRotationRestart - 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.
        Returns:
        builder

      • certificateRotationRestart

        public ClusterInstanceState.Builder certificateRotationRestart​(java.lang.String certificateRotationRestart)
        Parameters:
        certificateRotationRestart - 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.
        Returns:
        builder

      • clusterIdentifier

        public ClusterInstanceState.Builder clusterIdentifier​(@Nullable
                                                      com.pulumi.core.Output<java.lang.String> clusterIdentifier)
        Parameters:
        clusterIdentifier - Identifier of the `aws.docdb.Cluster` in which to launch this instance.
        Returns:
        builder

      • clusterIdentifier

        public ClusterInstanceState.Builder clusterIdentifier​(java.lang.String clusterIdentifier)
        Parameters:
        clusterIdentifier - Identifier of the `aws.docdb.Cluster` in which to launch this instance.
        Returns:
        builder

      • copyTagsToSnapshot

        public ClusterInstanceState.Builder copyTagsToSnapshot​(@Nullable
                                                       com.pulumi.core.Output<java.lang.Boolean> copyTagsToSnapshot)
        Parameters:
        copyTagsToSnapshot - Copy all DB instance `tags` to snapshots. Default is `false`.
        Returns:
        builder

      • copyTagsToSnapshot

        public ClusterInstanceState.Builder copyTagsToSnapshot​(java.lang.Boolean copyTagsToSnapshot)
        Parameters:
        copyTagsToSnapshot - Copy all DB instance `tags` to snapshots. Default is `false`.
        Returns:
        builder

      • dbSubnetGroupName

        public ClusterInstanceState.Builder dbSubnetGroupName​(@Nullable
                                                      com.pulumi.core.Output<java.lang.String> dbSubnetGroupName)
        Parameters:
        dbSubnetGroupName - DB subnet group to associate with this DB instance.
        Returns:
        builder

      • dbSubnetGroupName

        public ClusterInstanceState.Builder dbSubnetGroupName​(java.lang.String dbSubnetGroupName)
        Parameters:
        dbSubnetGroupName - DB subnet group to associate with this DB instance.
        Returns:
        builder

      • dbiResourceId

        public ClusterInstanceState.Builder dbiResourceId​(@Nullable
                                                  com.pulumi.core.Output<java.lang.String> dbiResourceId)
        Parameters:
        dbiResourceId - Region-unique, immutable identifier for the DB instance.
        Returns:
        builder

      • dbiResourceId

        public ClusterInstanceState.Builder dbiResourceId​(java.lang.String dbiResourceId)
        Parameters:
        dbiResourceId - Region-unique, immutable identifier for the DB instance.
        Returns:
        builder

      • enablePerformanceInsights

        public ClusterInstanceState.Builder enablePerformanceInsights​(@Nullable
                                                              com.pulumi.core.Output<java.lang.Boolean> enablePerformanceInsights)
        Parameters:
        enablePerformanceInsights - 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.
        Returns:
        builder

      • enablePerformanceInsights

        public ClusterInstanceState.Builder enablePerformanceInsights​(java.lang.Boolean enablePerformanceInsights)
        Parameters:
        enablePerformanceInsights - 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.
        Returns:
        builder

      • endpoint

        public ClusterInstanceState.Builder endpoint​(@Nullable
                                             com.pulumi.core.Output<java.lang.String> endpoint)
        Parameters:
        endpoint - DNS address for this instance. May not be writable
        Returns:
        builder

      • endpoint

        public ClusterInstanceState.Builder endpoint​(java.lang.String endpoint)
        Parameters:
        endpoint - DNS address for this instance. May not be writable
        Returns:
        builder

      • engine

        public ClusterInstanceState.Builder engine​(@Nullable
                                           com.pulumi.core.Output<java.lang.String> engine)
        Parameters:
        engine - Name of the database engine to be used for the DocumentDB instance. Defaults to `docdb`. Valid Values: `docdb`.
        Returns:
        builder

      • engine

        public ClusterInstanceState.Builder engine​(java.lang.String engine)
        Parameters:
        engine - Name of the database engine to be used for the DocumentDB instance. Defaults to `docdb`. Valid Values: `docdb`.
        Returns:
        builder

      • engineVersion

        public ClusterInstanceState.Builder engineVersion​(@Nullable
                                                  com.pulumi.core.Output<java.lang.String> engineVersion)
        Parameters:
        engineVersion - Database engine version
        Returns:
        builder

      • engineVersion

        public ClusterInstanceState.Builder engineVersion​(java.lang.String engineVersion)
        Parameters:
        engineVersion - Database engine version
        Returns:
        builder

      • identifier

        public ClusterInstanceState.Builder identifier​(@Nullable
                                               com.pulumi.core.Output<java.lang.String> identifier)
        Parameters:
        identifier - The identifier for the DocumentDB instance, if omitted, the provider will assign a random, unique identifier.
        Returns:
        builder

      • identifier

        public ClusterInstanceState.Builder identifier​(java.lang.String identifier)
        Parameters:
        identifier - The identifier for the DocumentDB instance, if omitted, the provider will assign a random, unique identifier.
        Returns:
        builder

      • identifierPrefix

        public ClusterInstanceState.Builder identifierPrefix​(@Nullable
                                                     com.pulumi.core.Output<java.lang.String> identifierPrefix)
        Parameters:
        identifierPrefix - Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`.
        Returns:
        builder

      • identifierPrefix

        public ClusterInstanceState.Builder identifierPrefix​(java.lang.String identifierPrefix)
        Parameters:
        identifierPrefix - Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`.
        Returns:
        builder

      • instanceClass

        public ClusterInstanceState.Builder instanceClass​(@Nullable
                                                  com.pulumi.core.Output<java.lang.String> instanceClass)
        Parameters:
        instanceClass - 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.
        Returns:
        builder

      • instanceClass

        public ClusterInstanceState.Builder instanceClass​(java.lang.String instanceClass)
        Parameters:
        instanceClass - 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.
        Returns:
        builder

      • kmsKeyId

        public ClusterInstanceState.Builder kmsKeyId​(@Nullable
                                             com.pulumi.core.Output<java.lang.String> kmsKeyId)
        Parameters:
        kmsKeyId - ARN for the KMS encryption key if one is set to the cluster.
        Returns:
        builder

      • kmsKeyId

        public ClusterInstanceState.Builder kmsKeyId​(java.lang.String kmsKeyId)
        Parameters:
        kmsKeyId - ARN for the KMS encryption key if one is set to the cluster.
        Returns:
        builder

      • performanceInsightsKmsKeyId

        public ClusterInstanceState.Builder performanceInsightsKmsKeyId​(@Nullable
                                                                com.pulumi.core.Output<java.lang.String> performanceInsightsKmsKeyId)
        Parameters:
        performanceInsightsKmsKeyId - 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.
        Returns:
        builder

      • performanceInsightsKmsKeyId

        public ClusterInstanceState.Builder performanceInsightsKmsKeyId​(java.lang.String performanceInsightsKmsKeyId)
        Parameters:
        performanceInsightsKmsKeyId - 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.
        Returns:
        builder

      • port

        public ClusterInstanceState.Builder port​(@Nullable
                                         com.pulumi.core.Output<java.lang.Integer> port)
        Parameters:
        port - Database port
        Returns:
        builder

      • preferredBackupWindow

        public ClusterInstanceState.Builder preferredBackupWindow​(@Nullable
                                                          com.pulumi.core.Output<java.lang.String> preferredBackupWindow)
        Parameters:
        preferredBackupWindow - Daily time range during which automated backups are created if automated backups are enabled.
        Returns:
        builder

      • preferredBackupWindow

        public ClusterInstanceState.Builder preferredBackupWindow​(java.lang.String preferredBackupWindow)
        Parameters:
        preferredBackupWindow - Daily time range during which automated backups are created if automated backups are enabled.
        Returns:
        builder

      • preferredMaintenanceWindow

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

      • preferredMaintenanceWindow

        public ClusterInstanceState.Builder preferredMaintenanceWindow​(java.lang.String preferredMaintenanceWindow)
        Parameters:
        preferredMaintenanceWindow - Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
        Returns:
        builder

      • promotionTier

        public ClusterInstanceState.Builder promotionTier​(@Nullable
                                                  com.pulumi.core.Output<java.lang.Integer> promotionTier)
        Parameters:
        promotionTier - Failover Priority setting on instance level. Default `0`. The reader who has lower tier has higher priority to get promoter to writer.
        Returns:
        builder

      • promotionTier

        public ClusterInstanceState.Builder promotionTier​(java.lang.Integer promotionTier)
        Parameters:
        promotionTier - Failover Priority setting on instance level. Default `0`. The reader who has lower tier has higher priority to get promoter to writer.
        Returns:
        builder

      • publiclyAccessible

        public ClusterInstanceState.Builder publiclyAccessible​(@Nullable
                                                       com.pulumi.core.Output<java.lang.Boolean> publiclyAccessible)

      • region

        public ClusterInstanceState.Builder region​(@Nullable
                                           com.pulumi.core.Output<java.lang.String> region)
        Parameters:
        region - 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.
        Returns:
        builder

      • region

        public ClusterInstanceState.Builder region​(java.lang.String region)
        Parameters:
        region - 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.
        Returns:
        builder

      • storageEncrypted

        public ClusterInstanceState.Builder storageEncrypted​(@Nullable
                                                     com.pulumi.core.Output<java.lang.Boolean> storageEncrypted)
        Parameters:
        storageEncrypted - Whether the DB cluster is encrypted.
        Returns:
        builder

      • storageEncrypted

        public ClusterInstanceState.Builder storageEncrypted​(java.lang.Boolean storageEncrypted)
        Parameters:
        storageEncrypted - Whether the DB cluster is encrypted.
        Returns:
        builder

      • tags

        public ClusterInstanceState.Builder tags​(@Nullable
                                         com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • tags

        public ClusterInstanceState.Builder tags​(java.util.Map<java.lang.String,​java.lang.String> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • tagsAll

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

      • tagsAll

        public ClusterInstanceState.Builder tagsAll​(java.util.Map<java.lang.String,​java.lang.String> tagsAll)
        Parameters:
        tagsAll - Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
        Returns:
        builder

      • writer

        public ClusterInstanceState.Builder writer​(@Nullable
                                           com.pulumi.core.Output<java.lang.Boolean> writer)
        Parameters:
        writer - Whether this instance is writable. `False` indicates this instance is a read replica.
        Returns:
        builder

      • writer

        public ClusterInstanceState.Builder writer​(java.lang.Boolean writer)
        Parameters:
        writer - Whether this instance is writable. `False` indicates this instance is a read replica.
        Returns:
        builder