Package com.pulumi.aws.rds

Class ClusterArgs.Builder

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

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • allocatedStorage

        public ClusterArgs.Builder allocatedStorage​(@Nullable
                                            com.pulumi.core.Output<java.lang.Integer> allocatedStorage)
        Parameters:
        allocatedStorage - The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
        Returns:
        builder

      • allocatedStorage

        public ClusterArgs.Builder allocatedStorage​(java.lang.Integer allocatedStorage)
        Parameters:
        allocatedStorage - The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
        Returns:
        builder

      • allowMajorVersionUpgrade

        public ClusterArgs.Builder allowMajorVersionUpgrade​(@Nullable
                                                    com.pulumi.core.Output<java.lang.Boolean> allowMajorVersionUpgrade)
        Parameters:
        allowMajorVersionUpgrade - Enable to allow major engine version upgrades when changing engine versions. Defaults to `false`.
        Returns:
        builder

      • allowMajorVersionUpgrade

        public ClusterArgs.Builder allowMajorVersionUpgrade​(java.lang.Boolean allowMajorVersionUpgrade)
        Parameters:
        allowMajorVersionUpgrade - Enable to allow major engine version upgrades when changing engine versions. Defaults to `false`.
        Returns:
        builder

      • applyImmediately

        public ClusterArgs.Builder applyImmediately​(@Nullable
                                            com.pulumi.core.Output<java.lang.Boolean> applyImmediately)
        Parameters:
        applyImmediately - Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`. See [Amazon RDS Documentation for more information.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html)
        Returns:
        builder

      • applyImmediately

        public ClusterArgs.Builder applyImmediately​(java.lang.Boolean applyImmediately)
        Parameters:
        applyImmediately - Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`. See [Amazon RDS Documentation for more information.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html)
        Returns:
        builder

      • availabilityZones

        public ClusterArgs.Builder availabilityZones​(@Nullable
                                             com.pulumi.core.Output<java.util.List<java.lang.String>> availabilityZones)
        Parameters:
        availabilityZones - List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the `lifecycle` configuration block `ignore_changes` argument if necessary. A maximum of 3 AZs can be configured.
        Returns:
        builder

      • availabilityZones

        public ClusterArgs.Builder availabilityZones​(java.util.List<java.lang.String> availabilityZones)
        Parameters:
        availabilityZones - List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the `lifecycle` configuration block `ignore_changes` argument if necessary. A maximum of 3 AZs can be configured.
        Returns:
        builder

      • availabilityZones

        public ClusterArgs.Builder availabilityZones​(java.lang.String... availabilityZones)
        Parameters:
        availabilityZones - List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the `lifecycle` configuration block `ignore_changes` argument if necessary. A maximum of 3 AZs can be configured.
        Returns:
        builder

      • backtrackWindow

        public ClusterArgs.Builder backtrackWindow​(@Nullable
                                           com.pulumi.core.Output<java.lang.Integer> backtrackWindow)
        Parameters:
        backtrackWindow - Target backtrack window, in seconds. Only available for `aurora` and `aurora-mysql` engines currently. To disable backtracking, set this value to `0`. Defaults to `0`. Must be between `0` and `259200` (72 hours)
        Returns:
        builder

      • backtrackWindow

        public ClusterArgs.Builder backtrackWindow​(java.lang.Integer backtrackWindow)
        Parameters:
        backtrackWindow - Target backtrack window, in seconds. Only available for `aurora` and `aurora-mysql` engines currently. To disable backtracking, set this value to `0`. Defaults to `0`. Must be between `0` and `259200` (72 hours)
        Returns:
        builder

      • backupRetentionPeriod

        public ClusterArgs.Builder backupRetentionPeriod​(@Nullable
                                                 com.pulumi.core.Output<java.lang.Integer> backupRetentionPeriod)
        Parameters:
        backupRetentionPeriod - Days to retain backups for. Default `1`
        Returns:
        builder

      • backupRetentionPeriod

        public ClusterArgs.Builder backupRetentionPeriod​(java.lang.Integer backupRetentionPeriod)
        Parameters:
        backupRetentionPeriod - Days to retain backups for. Default `1`
        Returns:
        builder

      • clusterIdentifier

        public ClusterArgs.Builder clusterIdentifier​(@Nullable
                                             com.pulumi.core.Output<java.lang.String> clusterIdentifier)
        Parameters:
        clusterIdentifier - The cluster identifier. If omitted, this provider will assign a random, unique identifier.
        Returns:
        builder

      • clusterIdentifier

        public ClusterArgs.Builder clusterIdentifier​(java.lang.String clusterIdentifier)
        Parameters:
        clusterIdentifier - The cluster identifier. If omitted, this provider will assign a random, unique identifier.
        Returns:
        builder

      • clusterIdentifierPrefix

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

      • clusterIdentifierPrefix

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

      • clusterMembers

        public ClusterArgs.Builder clusterMembers​(@Nullable
                                          com.pulumi.core.Output<java.util.List<java.lang.String>> clusterMembers)
        Parameters:
        clusterMembers - List of RDS Instances that are a part of this cluster
        Returns:
        builder

      • clusterMembers

        public ClusterArgs.Builder clusterMembers​(java.util.List<java.lang.String> clusterMembers)
        Parameters:
        clusterMembers - List of RDS Instances that are a part of this cluster
        Returns:
        builder

      • clusterMembers

        public ClusterArgs.Builder clusterMembers​(java.lang.String... clusterMembers)
        Parameters:
        clusterMembers - List of RDS Instances that are a part of this cluster
        Returns:
        builder

      • copyTagsToSnapshot

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

      • copyTagsToSnapshot

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

      • databaseName

        public ClusterArgs.Builder databaseName​(@Nullable
                                        com.pulumi.core.Output<java.lang.String> databaseName)
        Parameters:
        databaseName - Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: [RDS Naming Constraints](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints)
        Returns:
        builder

      • databaseName

        public ClusterArgs.Builder databaseName​(java.lang.String databaseName)
        Parameters:
        databaseName - Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: [RDS Naming Constraints](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints)
        Returns:
        builder

      • dbClusterInstanceClass

        public ClusterArgs.Builder dbClusterInstanceClass​(@Nullable
                                                  com.pulumi.core.Output<java.lang.String> dbClusterInstanceClass)
        Parameters:
        dbClusterInstanceClass - The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example `db.m6g.xlarge`. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the Amazon RDS User Guide.
        Returns:
        builder

      • dbClusterInstanceClass

        public ClusterArgs.Builder dbClusterInstanceClass​(java.lang.String dbClusterInstanceClass)
        Parameters:
        dbClusterInstanceClass - The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example `db.m6g.xlarge`. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the Amazon RDS User Guide.
        Returns:
        builder

      • dbClusterParameterGroupName

        public ClusterArgs.Builder dbClusterParameterGroupName​(@Nullable
                                                       com.pulumi.core.Output<java.lang.String> dbClusterParameterGroupName)
        Parameters:
        dbClusterParameterGroupName - A cluster parameter group to associate with the cluster.
        Returns:
        builder

      • dbClusterParameterGroupName

        public ClusterArgs.Builder dbClusterParameterGroupName​(java.lang.String dbClusterParameterGroupName)
        Parameters:
        dbClusterParameterGroupName - A cluster parameter group to associate with the cluster.
        Returns:
        builder

      • dbInstanceParameterGroupName

        public ClusterArgs.Builder dbInstanceParameterGroupName​(@Nullable
                                                        com.pulumi.core.Output<java.lang.String> dbInstanceParameterGroupName)
        Parameters:
        dbInstanceParameterGroupName - Instance parameter group to associate with all instances of the DB cluster. The `db_instance_parameter_group_name` parameter is only valid in combination with the `allow_major_version_upgrade` parameter.
        Returns:
        builder

      • dbInstanceParameterGroupName

        public ClusterArgs.Builder dbInstanceParameterGroupName​(java.lang.String dbInstanceParameterGroupName)
        Parameters:
        dbInstanceParameterGroupName - Instance parameter group to associate with all instances of the DB cluster. The `db_instance_parameter_group_name` parameter is only valid in combination with the `allow_major_version_upgrade` parameter.
        Returns:
        builder

      • dbSubnetGroupName

        public ClusterArgs.Builder dbSubnetGroupName​(@Nullable
                                             com.pulumi.core.Output<java.lang.String> dbSubnetGroupName)
        Parameters:
        dbSubnetGroupName - DB subnet group to associate with this DB cluster. **NOTE:** This must match the `db_subnet_group_name` specified on every `aws.rds.ClusterInstance` in the cluster.
        Returns:
        builder

      • dbSubnetGroupName

        public ClusterArgs.Builder dbSubnetGroupName​(java.lang.String dbSubnetGroupName)
        Parameters:
        dbSubnetGroupName - DB subnet group to associate with this DB cluster. **NOTE:** This must match the `db_subnet_group_name` specified on every `aws.rds.ClusterInstance` in the cluster.
        Returns:
        builder

      • dbSystemId

        public ClusterArgs.Builder dbSystemId​(@Nullable
                                      com.pulumi.core.Output<java.lang.String> dbSystemId)
        Parameters:
        dbSystemId - For use with RDS Custom.
        Returns:
        builder

      • dbSystemId

        public ClusterArgs.Builder dbSystemId​(java.lang.String dbSystemId)
        Parameters:
        dbSystemId - For use with RDS Custom.
        Returns:
        builder

      • deleteAutomatedBackups

        public ClusterArgs.Builder deleteAutomatedBackups​(@Nullable
                                                  com.pulumi.core.Output<java.lang.Boolean> deleteAutomatedBackups)
        Parameters:
        deleteAutomatedBackups - Specifies whether to remove automated backups immediately after the DB cluster is deleted. Default is `true`.
        Returns:
        builder

      • deleteAutomatedBackups

        public ClusterArgs.Builder deleteAutomatedBackups​(java.lang.Boolean deleteAutomatedBackups)
        Parameters:
        deleteAutomatedBackups - Specifies whether to remove automated backups immediately after the DB cluster is deleted. Default is `true`.
        Returns:
        builder

      • deletionProtection

        public ClusterArgs.Builder deletionProtection​(@Nullable
                                              com.pulumi.core.Output<java.lang.Boolean> deletionProtection)
        Parameters:
        deletionProtection - If the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`.
        Returns:
        builder

      • deletionProtection

        public ClusterArgs.Builder deletionProtection​(java.lang.Boolean deletionProtection)
        Parameters:
        deletionProtection - If the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`.
        Returns:
        builder

      • domain

        public ClusterArgs.Builder domain​(@Nullable
                                  com.pulumi.core.Output<java.lang.String> domain)
        Parameters:
        domain - The ID of the Directory Service Active Directory domain to create the cluster in.
        Returns:
        builder

      • domain

        public ClusterArgs.Builder domain​(java.lang.String domain)
        Parameters:
        domain - The ID of the Directory Service Active Directory domain to create the cluster in.
        Returns:
        builder

      • domainIamRoleName

        public ClusterArgs.Builder domainIamRoleName​(@Nullable
                                             com.pulumi.core.Output<java.lang.String> domainIamRoleName)
        Parameters:
        domainIamRoleName - The name of the IAM role to be used when making API calls to the Directory Service.
        Returns:
        builder

      • domainIamRoleName

        public ClusterArgs.Builder domainIamRoleName​(java.lang.String domainIamRoleName)
        Parameters:
        domainIamRoleName - The name of the IAM role to be used when making API calls to the Directory Service.
        Returns:
        builder

      • enableGlobalWriteForwarding

        public ClusterArgs.Builder enableGlobalWriteForwarding​(@Nullable
                                                       com.pulumi.core.Output<java.lang.Boolean> enableGlobalWriteForwarding)
        Parameters:
        enableGlobalWriteForwarding - Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an `aws.rds.GlobalCluster`'s primary cluster. See the [User Guide for Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-write-forwarding.html) for more information.
        Returns:
        builder

      • enableGlobalWriteForwarding

        public ClusterArgs.Builder enableGlobalWriteForwarding​(java.lang.Boolean enableGlobalWriteForwarding)
        Parameters:
        enableGlobalWriteForwarding - Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an `aws.rds.GlobalCluster`'s primary cluster. See the [User Guide for Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-write-forwarding.html) for more information.
        Returns:
        builder

      • enableHttpEndpoint

        public ClusterArgs.Builder enableHttpEndpoint​(@Nullable
                                              com.pulumi.core.Output<java.lang.Boolean> enableHttpEndpoint)
        Parameters:
        enableHttpEndpoint - Enable HTTP endpoint (data API). Only valid when `engine_mode` is set to `serverless`.
        Returns:
        builder

      • enableHttpEndpoint

        public ClusterArgs.Builder enableHttpEndpoint​(java.lang.Boolean enableHttpEndpoint)
        Parameters:
        enableHttpEndpoint - Enable HTTP endpoint (data API). Only valid when `engine_mode` is set to `serverless`.
        Returns:
        builder

      • enableLocalWriteForwarding

        public ClusterArgs.Builder enableLocalWriteForwarding​(@Nullable
                                                      com.pulumi.core.Output<java.lang.Boolean> enableLocalWriteForwarding)
        Parameters:
        enableLocalWriteForwarding - Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.. See the [User Guide for Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-write-forwarding.html) for more information. **NOTE:** Local write forwarding requires Aurora MySQL version 3.04 or higher.
        Returns:
        builder

      • enableLocalWriteForwarding

        public ClusterArgs.Builder enableLocalWriteForwarding​(java.lang.Boolean enableLocalWriteForwarding)
        Parameters:
        enableLocalWriteForwarding - Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.. See the [User Guide for Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-write-forwarding.html) for more information. **NOTE:** Local write forwarding requires Aurora MySQL version 3.04 or higher.
        Returns:
        builder

      • enabledCloudwatchLogsExports

        public ClusterArgs.Builder enabledCloudwatchLogsExports​(@Nullable
                                                        com.pulumi.core.Output<java.util.List<java.lang.String>> enabledCloudwatchLogsExports)
        Parameters:
        enabledCloudwatchLogsExports - Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: `audit`, `error`, `general`, `slowquery`, `postgresql` (PostgreSQL).
        Returns:
        builder

      • enabledCloudwatchLogsExports

        public ClusterArgs.Builder enabledCloudwatchLogsExports​(java.util.List<java.lang.String> enabledCloudwatchLogsExports)
        Parameters:
        enabledCloudwatchLogsExports - Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: `audit`, `error`, `general`, `slowquery`, `postgresql` (PostgreSQL).
        Returns:
        builder

      • enabledCloudwatchLogsExports

        public ClusterArgs.Builder enabledCloudwatchLogsExports​(java.lang.String... enabledCloudwatchLogsExports)
        Parameters:
        enabledCloudwatchLogsExports - Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: `audit`, `error`, `general`, `slowquery`, `postgresql` (PostgreSQL).
        Returns:
        builder

      • engine

        public ClusterArgs.Builder engine​(com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,​EngineType>> engine)
        Parameters:
        engine - Name of the database engine to be used for this DB cluster. Valid Values: `aurora-mysql`, `aurora-postgresql`, `mysql`, `postgres`. (Note that `mysql` and `postgres` are Multi-AZ RDS clusters).
        Returns:
        builder

      • engine

        public ClusterArgs.Builder engine​(com.pulumi.core.Either<java.lang.String,​EngineType> engine)
        Parameters:
        engine - Name of the database engine to be used for this DB cluster. Valid Values: `aurora-mysql`, `aurora-postgresql`, `mysql`, `postgres`. (Note that `mysql` and `postgres` are Multi-AZ RDS clusters).
        Returns:
        builder

      • engine

        public ClusterArgs.Builder engine​(java.lang.String engine)
        Parameters:
        engine - Name of the database engine to be used for this DB cluster. Valid Values: `aurora-mysql`, `aurora-postgresql`, `mysql`, `postgres`. (Note that `mysql` and `postgres` are Multi-AZ RDS clusters).
        Returns:
        builder

      • engine

        public ClusterArgs.Builder engine​(EngineType engine)
        Parameters:
        engine - Name of the database engine to be used for this DB cluster. Valid Values: `aurora-mysql`, `aurora-postgresql`, `mysql`, `postgres`. (Note that `mysql` and `postgres` are Multi-AZ RDS clusters).
        Returns:
        builder

      • engineMode

        public ClusterArgs.Builder engineMode​(@Nullable
                                      com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,​EngineMode>> engineMode)
        Parameters:
        engineMode - Database engine mode. Valid values: `global` (only valid for Aurora MySQL 1.21 and earlier), `parallelquery`, `provisioned`, `serverless`. Defaults to: `provisioned`. See the [RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/aurora-serverless.html) for limitations when using `serverless`.
        Returns:
        builder

      • engineMode

        public ClusterArgs.Builder engineMode​(com.pulumi.core.Either<java.lang.String,​EngineMode> engineMode)
        Parameters:
        engineMode - Database engine mode. Valid values: `global` (only valid for Aurora MySQL 1.21 and earlier), `parallelquery`, `provisioned`, `serverless`. Defaults to: `provisioned`. See the [RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/aurora-serverless.html) for limitations when using `serverless`.
        Returns:
        builder

      • engineMode

        public ClusterArgs.Builder engineMode​(java.lang.String engineMode)
        Parameters:
        engineMode - Database engine mode. Valid values: `global` (only valid for Aurora MySQL 1.21 and earlier), `parallelquery`, `provisioned`, `serverless`. Defaults to: `provisioned`. See the [RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/aurora-serverless.html) for limitations when using `serverless`.
        Returns:
        builder

      • engineMode

        public ClusterArgs.Builder engineMode​(EngineMode engineMode)
        Parameters:
        engineMode - Database engine mode. Valid values: `global` (only valid for Aurora MySQL 1.21 and earlier), `parallelquery`, `provisioned`, `serverless`. Defaults to: `provisioned`. See the [RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/aurora-serverless.html) for limitations when using `serverless`.
        Returns:
        builder

      • engineVersion

        public ClusterArgs.Builder engineVersion​(@Nullable
                                         com.pulumi.core.Output<java.lang.String> engineVersion)
        Parameters:
        engineVersion - Database engine version. Updating this argument results in an outage. See the [Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) and [Aurora Postgres](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.html) documentation for your configured engine to determine this value, or by running `aws rds describe-db-engine-versions`. For example with Aurora MySQL 2, a potential value for this argument is `5.7.mysql_aurora.2.03.2`. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute `engine_version_actual`, , see Attribute Reference below.
        Returns:
        builder

      • engineVersion

        public ClusterArgs.Builder engineVersion​(java.lang.String engineVersion)
        Parameters:
        engineVersion - Database engine version. Updating this argument results in an outage. See the [Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) and [Aurora Postgres](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.html) documentation for your configured engine to determine this value, or by running `aws rds describe-db-engine-versions`. For example with Aurora MySQL 2, a potential value for this argument is `5.7.mysql_aurora.2.03.2`. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute `engine_version_actual`, , see Attribute Reference below.
        Returns:
        builder

      • finalSnapshotIdentifier

        public ClusterArgs.Builder finalSnapshotIdentifier​(@Nullable
                                                   com.pulumi.core.Output<java.lang.String> finalSnapshotIdentifier)
        Parameters:
        finalSnapshotIdentifier - Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
        Returns:
        builder

      • finalSnapshotIdentifier

        public ClusterArgs.Builder finalSnapshotIdentifier​(java.lang.String finalSnapshotIdentifier)
        Parameters:
        finalSnapshotIdentifier - Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
        Returns:
        builder

      • globalClusterIdentifier

        public ClusterArgs.Builder globalClusterIdentifier​(@Nullable
                                                   com.pulumi.core.Output<java.lang.String> globalClusterIdentifier)
        Parameters:
        globalClusterIdentifier - Global cluster identifier specified on `aws.rds.GlobalCluster`.
        Returns:
        builder

      • globalClusterIdentifier

        public ClusterArgs.Builder globalClusterIdentifier​(java.lang.String globalClusterIdentifier)
        Parameters:
        globalClusterIdentifier - Global cluster identifier specified on `aws.rds.GlobalCluster`.
        Returns:
        builder

      • iamDatabaseAuthenticationEnabled

        public ClusterArgs.Builder iamDatabaseAuthenticationEnabled​(@Nullable
                                                            com.pulumi.core.Output<java.lang.Boolean> iamDatabaseAuthenticationEnabled)
        Parameters:
        iamDatabaseAuthenticationEnabled - Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see [AWS Documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) for availability and limitations.
        Returns:
        builder

      • iamDatabaseAuthenticationEnabled

        public ClusterArgs.Builder iamDatabaseAuthenticationEnabled​(java.lang.Boolean iamDatabaseAuthenticationEnabled)
        Parameters:
        iamDatabaseAuthenticationEnabled - Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see [AWS Documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) for availability and limitations.
        Returns:
        builder

      • iamRoles

        public ClusterArgs.Builder iamRoles​(@Nullable
                                    com.pulumi.core.Output<java.util.List<java.lang.String>> iamRoles)
        Parameters:
        iamRoles - List of ARNs for the IAM roles to associate to the RDS Cluster.
        Returns:
        builder

      • iamRoles

        public ClusterArgs.Builder iamRoles​(java.util.List<java.lang.String> iamRoles)
        Parameters:
        iamRoles - List of ARNs for the IAM roles to associate to the RDS Cluster.
        Returns:
        builder

      • iamRoles

        public ClusterArgs.Builder iamRoles​(java.lang.String... iamRoles)
        Parameters:
        iamRoles - List of ARNs for the IAM roles to associate to the RDS Cluster.
        Returns:
        builder

      • iops

        public ClusterArgs.Builder iops​(@Nullable
                                com.pulumi.core.Output<java.lang.Integer> iops)
        Parameters:
        iops - Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see [Amazon RDS Provisioned IOPS storage to improve performance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
        Returns:
        builder

      • iops

        public ClusterArgs.Builder iops​(java.lang.Integer iops)
        Parameters:
        iops - Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see [Amazon RDS Provisioned IOPS storage to improve performance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
        Returns:
        builder

      • kmsKeyId

        public ClusterArgs.Builder kmsKeyId​(@Nullable
                                    com.pulumi.core.Output<java.lang.String> kmsKeyId)
        Parameters:
        kmsKeyId - ARN for the KMS encryption key. When specifying `kms_key_id`, `storage_encrypted` needs to be set to true.
        Returns:
        builder

      • kmsKeyId

        public ClusterArgs.Builder kmsKeyId​(java.lang.String kmsKeyId)
        Parameters:
        kmsKeyId - ARN for the KMS encryption key. When specifying `kms_key_id`, `storage_encrypted` needs to be set to true.
        Returns:
        builder

      • manageMasterUserPassword

        public ClusterArgs.Builder manageMasterUserPassword​(@Nullable
                                                    com.pulumi.core.Output<java.lang.Boolean> manageMasterUserPassword)
        Parameters:
        manageMasterUserPassword - Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if `master_password` is provided.
        Returns:
        builder

      • manageMasterUserPassword

        public ClusterArgs.Builder manageMasterUserPassword​(java.lang.Boolean manageMasterUserPassword)
        Parameters:
        manageMasterUserPassword - Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if `master_password` is provided.
        Returns:
        builder

      • masterPassword

        public ClusterArgs.Builder masterPassword​(@Nullable
                                          com.pulumi.core.Output<java.lang.String> masterPassword)
        Parameters:
        masterPassword - Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the [RDS Naming Constraints](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints). Cannot be set if `manage_master_user_password` is set to `true`.
        Returns:
        builder

      • masterPassword

        public ClusterArgs.Builder masterPassword​(java.lang.String masterPassword)
        Parameters:
        masterPassword - Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the [RDS Naming Constraints](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints). Cannot be set if `manage_master_user_password` is set to `true`.
        Returns:
        builder

      • masterUserSecretKmsKeyId

        public ClusterArgs.Builder masterUserSecretKmsKeyId​(@Nullable
                                                    com.pulumi.core.Output<java.lang.String> masterUserSecretKmsKeyId)
        Parameters:
        masterUserSecretKmsKeyId - Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.
        Returns:
        builder

      • masterUserSecretKmsKeyId

        public ClusterArgs.Builder masterUserSecretKmsKeyId​(java.lang.String masterUserSecretKmsKeyId)
        Parameters:
        masterUserSecretKmsKeyId - Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.
        Returns:
        builder

      • masterUsername

        public ClusterArgs.Builder masterUsername​(@Nullable
                                          com.pulumi.core.Output<java.lang.String> masterUsername)
        Parameters:
        masterUsername - Username for the master DB user. Please refer to the [RDS Naming Constraints](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints). This argument does not support in-place updates and cannot be changed during a restore from snapshot.
        Returns:
        builder

      • masterUsername

        public ClusterArgs.Builder masterUsername​(java.lang.String masterUsername)
        Parameters:
        masterUsername - Username for the master DB user. Please refer to the [RDS Naming Constraints](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints). This argument does not support in-place updates and cannot be changed during a restore from snapshot.
        Returns:
        builder

      • networkType

        public ClusterArgs.Builder networkType​(@Nullable
                                       com.pulumi.core.Output<java.lang.String> networkType)
        Parameters:
        networkType - Network type of the cluster. Valid values: `IPV4`, `DUAL`.
        Returns:
        builder

      • networkType

        public ClusterArgs.Builder networkType​(java.lang.String networkType)
        Parameters:
        networkType - Network type of the cluster. Valid values: `IPV4`, `DUAL`.
        Returns:
        builder

      • port

        public ClusterArgs.Builder port​(@Nullable
                                com.pulumi.core.Output<java.lang.Integer> port)
        Parameters:
        port - Port on which the DB accepts connections
        Returns:
        builder

      • port

        public ClusterArgs.Builder port​(java.lang.Integer port)
        Parameters:
        port - Port on which the DB accepts connections
        Returns:
        builder

      • preferredBackupWindow

        public ClusterArgs.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 using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
        Returns:
        builder

      • preferredBackupWindow

        public ClusterArgs.Builder preferredBackupWindow​(java.lang.String preferredBackupWindow)
        Parameters:
        preferredBackupWindow - Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
        Returns:
        builder

      • preferredMaintenanceWindow

        public ClusterArgs.Builder preferredMaintenanceWindow​(@Nullable
                                                      com.pulumi.core.Output<java.lang.String> preferredMaintenanceWindow)
        Parameters:
        preferredMaintenanceWindow - Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
        Returns:
        builder

      • preferredMaintenanceWindow

        public ClusterArgs.Builder preferredMaintenanceWindow​(java.lang.String preferredMaintenanceWindow)
        Parameters:
        preferredMaintenanceWindow - Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
        Returns:
        builder

      • replicationSourceIdentifier

        public ClusterArgs.Builder replicationSourceIdentifier​(@Nullable
                                                       com.pulumi.core.Output<java.lang.String> replicationSourceIdentifier)
        Parameters:
        replicationSourceIdentifier - ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. If DB Cluster is part of a Global Cluster, use the `lifecycle` configuration block `ignore_changes` argument to prevent this provider from showing differences for this argument instead of configuring this value.
        Returns:
        builder

      • replicationSourceIdentifier

        public ClusterArgs.Builder replicationSourceIdentifier​(java.lang.String replicationSourceIdentifier)
        Parameters:
        replicationSourceIdentifier - ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. If DB Cluster is part of a Global Cluster, use the `lifecycle` configuration block `ignore_changes` argument to prevent this provider from showing differences for this argument instead of configuring this value.
        Returns:
        builder

      • restoreToPointInTime

        public ClusterArgs.Builder restoreToPointInTime​(@Nullable
                                                com.pulumi.core.Output<ClusterRestoreToPointInTimeArgs> restoreToPointInTime)
        Parameters:
        restoreToPointInTime - Nested attribute for [point in time restore](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PIT.html). More details below.
        Returns:
        builder

      • restoreToPointInTime

        public ClusterArgs.Builder restoreToPointInTime​(ClusterRestoreToPointInTimeArgs restoreToPointInTime)
        Parameters:
        restoreToPointInTime - Nested attribute for [point in time restore](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PIT.html). More details below.
        Returns:
        builder

      • scalingConfiguration

        public ClusterArgs.Builder scalingConfiguration​(@Nullable
                                                com.pulumi.core.Output<ClusterScalingConfigurationArgs> scalingConfiguration)
        Parameters:
        scalingConfiguration - Nested attribute with scaling properties. Only valid when `engine_mode` is set to `serverless`. More details below.
        Returns:
        builder

      • scalingConfiguration

        public ClusterArgs.Builder scalingConfiguration​(ClusterScalingConfigurationArgs scalingConfiguration)
        Parameters:
        scalingConfiguration - Nested attribute with scaling properties. Only valid when `engine_mode` is set to `serverless`. More details below.
        Returns:
        builder

      • serverlessv2ScalingConfiguration

        public ClusterArgs.Builder serverlessv2ScalingConfiguration​(@Nullable
                                                            com.pulumi.core.Output<ClusterServerlessv2ScalingConfigurationArgs> serverlessv2ScalingConfiguration)
        Parameters:
        serverlessv2ScalingConfiguration - Nested attribute with scaling properties for ServerlessV2. Only valid when `engine_mode` is set to `provisioned`. More details below.
        Returns:
        builder

      • serverlessv2ScalingConfiguration

        public ClusterArgs.Builder serverlessv2ScalingConfiguration​(ClusterServerlessv2ScalingConfigurationArgs serverlessv2ScalingConfiguration)
        Parameters:
        serverlessv2ScalingConfiguration - Nested attribute with scaling properties for ServerlessV2. Only valid when `engine_mode` is set to `provisioned`. More details below.
        Returns:
        builder

      • skipFinalSnapshot

        public ClusterArgs.Builder skipFinalSnapshot​(@Nullable
                                             com.pulumi.core.Output<java.lang.Boolean> skipFinalSnapshot)
        Parameters:
        skipFinalSnapshot - Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from `final_snapshot_identifier`. Default is `false`.
        Returns:
        builder

      • skipFinalSnapshot

        public ClusterArgs.Builder skipFinalSnapshot​(java.lang.Boolean skipFinalSnapshot)
        Parameters:
        skipFinalSnapshot - Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from `final_snapshot_identifier`. Default is `false`.
        Returns:
        builder

      • snapshotIdentifier

        public ClusterArgs.Builder snapshotIdentifier​(@Nullable
                                              com.pulumi.core.Output<java.lang.String> snapshotIdentifier)
        Parameters:
        snapshotIdentifier - Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with `global_cluster_identifier`. Clusters cannot be restored from snapshot **and** joined to an existing global cluster in a single operation. See the [AWS documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-getting-started.html#aurora-global-database.use-snapshot) or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot.
        Returns:
        builder

      • snapshotIdentifier

        public ClusterArgs.Builder snapshotIdentifier​(java.lang.String snapshotIdentifier)
        Parameters:
        snapshotIdentifier - Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with `global_cluster_identifier`. Clusters cannot be restored from snapshot **and** joined to an existing global cluster in a single operation. See the [AWS documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-getting-started.html#aurora-global-database.use-snapshot) or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot.
        Returns:
        builder

      • sourceRegion

        public ClusterArgs.Builder sourceRegion​(@Nullable
                                        com.pulumi.core.Output<java.lang.String> sourceRegion)
        Parameters:
        sourceRegion - The source region for an encrypted replica DB cluster.
        Returns:
        builder

      • sourceRegion

        public ClusterArgs.Builder sourceRegion​(java.lang.String sourceRegion)
        Parameters:
        sourceRegion - The source region for an encrypted replica DB cluster.
        Returns:
        builder

      • storageEncrypted

        public ClusterArgs.Builder storageEncrypted​(@Nullable
                                            com.pulumi.core.Output<java.lang.Boolean> storageEncrypted)
        Parameters:
        storageEncrypted - Specifies whether the DB cluster is encrypted. The default is `false` for `provisioned` `engine_mode` and `true` for `serverless` `engine_mode`. When restoring an unencrypted `snapshot_identifier`, the `kms_key_id` argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided.
        Returns:
        builder

      • storageEncrypted

        public ClusterArgs.Builder storageEncrypted​(java.lang.Boolean storageEncrypted)
        Parameters:
        storageEncrypted - Specifies whether the DB cluster is encrypted. The default is `false` for `provisioned` `engine_mode` and `true` for `serverless` `engine_mode`. When restoring an unencrypted `snapshot_identifier`, the `kms_key_id` argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided.
        Returns:
        builder

      • storageType

        public ClusterArgs.Builder storageType​(@Nullable
                                       com.pulumi.core.Output<java.lang.String> storageType)
        Parameters:
        storageType - (Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, `storage_type` modifications can be done in-place. For Multi-AZ DB Clusters, the `iops` argument must also be set. Valid values are: `""`, `aurora-iopt1` (Aurora DB Clusters); `io1`, `io2` (Multi-AZ DB Clusters). Default: `""` (Aurora DB Clusters); `io1` (Multi-AZ DB Clusters).
        Returns:
        builder

      • storageType

        public ClusterArgs.Builder storageType​(java.lang.String storageType)
        Parameters:
        storageType - (Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, `storage_type` modifications can be done in-place. For Multi-AZ DB Clusters, the `iops` argument must also be set. Valid values are: `""`, `aurora-iopt1` (Aurora DB Clusters); `io1`, `io2` (Multi-AZ DB Clusters). Default: `""` (Aurora DB Clusters); `io1` (Multi-AZ DB Clusters).
        Returns:
        builder

      • tags

        public ClusterArgs.Builder tags​(@Nullable
                                com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tags)
        Parameters:
        tags - A map of tags to assign to the DB cluster. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
        Returns:
        builder

      • tags

        public ClusterArgs.Builder tags​(java.util.Map<java.lang.String,​java.lang.String> tags)
        Parameters:
        tags - A map of tags to assign to the DB cluster. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
        Returns:
        builder

      • vpcSecurityGroupIds

        public ClusterArgs.Builder vpcSecurityGroupIds​(@Nullable
                                               com.pulumi.core.Output<java.util.List<java.lang.String>> vpcSecurityGroupIds)
        Parameters:
        vpcSecurityGroupIds - List of VPC security groups to associate with the Cluster
        Returns:
        builder

      • vpcSecurityGroupIds

        public ClusterArgs.Builder vpcSecurityGroupIds​(java.util.List<java.lang.String> vpcSecurityGroupIds)
        Parameters:
        vpcSecurityGroupIds - List of VPC security groups to associate with the Cluster
        Returns:
        builder

      • vpcSecurityGroupIds

        public ClusterArgs.Builder vpcSecurityGroupIds​(java.lang.String... vpcSecurityGroupIds)
        Parameters:
        vpcSecurityGroupIds - List of VPC security groups to associate with the Cluster
        Returns:
        builder