Package com.pulumi.aws.rds.inputs

Class ClusterState

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

    • Method Detail

      • allocatedStorage

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> allocatedStorage()
        Returns:
        The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

      • allowMajorVersionUpgrade

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> allowMajorVersionUpgrade()
        Returns:
        Enable to allow major engine version upgrades when changing engine versions. Defaults to `false`.

      • applyImmediately

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

      • arn

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

      • availabilityZones

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> availabilityZones()
        Returns:
        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.

      • backtrackWindow

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

      • backupRetentionPeriod

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> backupRetentionPeriod()
        Returns:
        Days to retain backups for. Default `1`

      • clusterIdentifier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterIdentifier()
        Returns:
        The cluster identifier. If omitted, this provider will assign a random, unique identifier.

      • clusterIdentifierPrefix

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterIdentifierPrefix()
        Returns:
        Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `cluster_identifier`.

      • clusterMembers

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> clusterMembers()
        Returns:
        List of RDS Instances that are a part of this cluster

      • clusterResourceId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterResourceId()
        Returns:
        RDS Cluster Resource ID

      • copyTagsToSnapshot

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

      • databaseName

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

      • dbClusterInstanceClass

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

      • dbClusterParameterGroupName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbClusterParameterGroupName()
        Returns:
        A cluster parameter group to associate with the cluster.

      • dbInstanceParameterGroupName

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

      • dbSubnetGroupName

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

      • dbSystemId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbSystemId()
        Returns:
        For use with RDS Custom.

      • deleteAutomatedBackups

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> deleteAutomatedBackups()
        Returns:
        Specifies whether to remove automated backups immediately after the DB cluster is deleted. Default is `true`.

      • deletionProtection

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

      • enableGlobalWriteForwarding

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableGlobalWriteForwarding()
        Returns:
        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 [Aurora Userguide documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-write-forwarding.html) for more information.

      • enableHttpEndpoint

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableHttpEndpoint()
        Returns:
        Enable HTTP endpoint (data API). Only valid when `engine_mode` is set to `serverless`.

      • enabledCloudwatchLogsExports

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> enabledCloudwatchLogsExports()
        Returns:
        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).

      • endpoint

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

      • engine

        public java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,​EngineType>>> engine()
        Returns:
        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).

      • engineMode

        public java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,​EngineMode>>> engineMode()
        Returns:
        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`.

      • engineVersion

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

      • engineVersionActual

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersionActual()
        Returns:
        Running version of the database.

      • finalSnapshotIdentifier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> finalSnapshotIdentifier()
        Returns:
        Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

      • globalClusterIdentifier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> globalClusterIdentifier()
        Returns:
        Global cluster identifier specified on `aws.rds.GlobalCluster`.

      • hostedZoneId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> hostedZoneId()
        Returns:
        Route53 Hosted Zone ID of the endpoint

      • iamDatabaseAuthenticationEnabled

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

      • iamRoles

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> iamRoles()
        Returns:
        List of ARNs for the IAM roles to associate to the RDS Cluster.

      • iops

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

      • kmsKeyId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()
        Returns:
        ARN for the KMS encryption key. When specifying `kms_key_id`, `storage_encrypted` needs to be set to true.

      • manageMasterUserPassword

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> manageMasterUserPassword()
        Returns:
        Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if `master_password` is provided.

      • masterPassword

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterPassword()
        Returns:
        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`.

      • masterUserSecretKmsKeyId

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

      • masterUserSecrets

        public java.util.Optional<com.pulumi.core.Output<java.util.List<ClusterMasterUserSecretArgs>>> masterUserSecrets()
        Returns:
        Block that specifies the master user secret. Only available when `manage_master_user_password` is set to true. Documented below.

      • masterUsername

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

      • networkType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> networkType()
        Returns:
        Network type of the cluster. Valid values: `IPV4`, `DUAL`.

      • port

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()
        Returns:
        Port on which the DB accepts connections

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

      • 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) e.g., wed:04:00-wed:04:30

      • readerEndpoint

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> readerEndpoint()
        Returns:
        Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

      • replicationSourceIdentifier

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

      • restoreToPointInTime

        public java.util.Optional<com.pulumi.core.Output<ClusterRestoreToPointInTimeArgs>> restoreToPointInTime()
        Returns:
        Nested attribute for [point in time restore](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PIT.html). More details below.

      • scalingConfiguration

        public java.util.Optional<com.pulumi.core.Output<ClusterScalingConfigurationArgs>> scalingConfiguration()
        Returns:
        Nested attribute with scaling properties. Only valid when `engine_mode` is set to `serverless`. More details below.

      • serverlessv2ScalingConfiguration

        public java.util.Optional<com.pulumi.core.Output<ClusterServerlessv2ScalingConfigurationArgs>> serverlessv2ScalingConfiguration()
        Returns:
        Nested attribute with scaling properties for ServerlessV2. Only valid when `engine_mode` is set to `provisioned`. More details below.

      • skipFinalSnapshot

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

      • snapshotIdentifier

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

      • sourceRegion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> sourceRegion()
        Returns:
        The source region for an encrypted replica DB cluster.

      • storageEncrypted

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

      • storageType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> storageType()
        Returns:
        (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` (Multi-AZ DB Clusters). Default: `""` (Aurora DB Clusters); `io1` (Multi-AZ DB Clusters).

      • 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 DB cluster. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Deprecated.
        Please use `tags` instead.
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.

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