Package com.pulumi.aws.rds.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>> clusterIdentifier()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> copyTagsToSnapshot()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> customIamInstanceProfile()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbiResourceId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbParameterGroupName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbSubnetGroupName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpoint()  
      java.util.Optional<com.pulumi.core.Output<EngineType>> engine()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersion()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersionActual()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> forceDestroy()  
      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<com.pulumi.core.Either<java.lang.String,​InstanceType>>> instanceClass()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> monitoringInterval()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> monitoringRoleArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> networkType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> performanceInsightsEnabled()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> performanceInsightsKmsKeyId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> performanceInsightsRetentionPeriod()  
      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.util.List<java.lang.String>>> warningEventCategories()  
      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:
        Whether minor engine upgrades will be applied automatically to the DB instance during the maintenance window. 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/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) about the details.

      • caCertIdentifier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> caCertIdentifier()
        Returns:
        Identifier of the CA certificate for the DB instance.

      • clusterIdentifier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterIdentifier()
        Returns:
        Identifier of the `aws.rds.Cluster` in which to launch this instance.

      • copyTagsToSnapshot

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> copyTagsToSnapshot()
        Returns:
        Whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default `false`.

      • customIamInstanceProfile

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> customIamInstanceProfile()
        Returns:
        Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

      • dbParameterGroupName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbParameterGroupName()
        Returns:
        Name of the DB parameter group to associate with this instance.

      • dbSubnetGroupName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbSubnetGroupName()
        Returns:
        DB subnet group to associate with this DB instance. The default behavior varies depending on whether `dbSubnetGroupName` is specified. Please refer to official [AWS documentation](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) to understand how `dbSubnetGroupName` and `publiclyAccessible` parameters affect DB instance behaviour. **NOTE:** This must match the `dbSubnetGroupName` of the attached `aws.rds.Cluster`.

      • dbiResourceId

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

      • 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<EngineType>> engine()
        Returns:
        Name of the database engine to be used for the RDS cluster instance. Valid Values: `aurora-mysql`, `aurora-postgresql`, `mysql`, `postgres`. (Note that `mysql` and `postgres` are Multi-AZ RDS clusters).

      • engineVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersion()
        Returns:
        Database engine version. Please note that to upgrade the `engineVersion` of the instance, it must be done on the `aws.rds.Cluster` `engineVersion`. Trying to upgrade in `aws.rds.ClusterInstance` will not update the `engineVersion`.

      • engineVersionActual

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersionActual()
        Returns:
        Database engine version

      • forceDestroy

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> forceDestroy()
        Returns:
        Forces an instance to be destroyed when a part of a read replica cluster. **Note:** will promote the read replica to a standalone cluster before instance deletion.

      • identifier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> identifier()
        Returns:
        Identifier for the RDS instance, if omitted, Pulumi 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<com.pulumi.core.Either<java.lang.String,​InstanceType>>> instanceClass()
        Returns:
        Instance class to use. For details on CPU and memory, see [Scaling Aurora DB Instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Managing.html). Aurora uses `db.*` instance classes/types. Please see [AWS Documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) for currently available instance classes and complete details. For Aurora Serverless v2 use `db.serverless`.

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

      • monitoringInterval

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> monitoringInterval()
        Returns:
        Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.

      • monitoringRoleArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> monitoringRoleArn()
        Returns:
        ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the [AWS Documentation](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html) what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.

      • networkType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> networkType()
        Returns:
        Network type of the DB instance.

      • performanceInsightsEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> performanceInsightsEnabled()
        Returns:
        Whether Performance Insights is enabled. **NOTE:** When Performance Insights is configured at the cluster level through `aws.rds.Cluster`, this argument cannot be set to a value that conflicts with the cluster's configuration.

      • performanceInsightsKmsKeyId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> performanceInsightsKmsKeyId()
        Returns:
        ARN for the KMS key to encrypt Performance Insights data. When specifying `performanceInsightsKmsKeyId`, `performanceInsightsEnabled` needs to be set to true.

      • performanceInsightsRetentionPeriod

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> performanceInsightsRetentionPeriod()
        Returns:
        Amount of time in days to retain Performance Insights data. Valid values are `7`, `731` (2 years) or a multiple of `31`. When specifying `performanceInsightsRetentionPeriod`, `performanceInsightsEnabled` needs to be set to true. Defaults to '7'.

      • 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. Eg: "04:00-09:00". **NOTE:** If `preferredBackupWindow` is set at the cluster level, this argument **must** be omitted.

      • 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:
        Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.

      • publiclyAccessible

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> publiclyAccessible()
        Returns:
        Bool to control if instance is publicly accessible. Default `false`. See the documentation on [Creating DB Instances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) for more details on controlling this property.

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

      • warningEventCategories

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> warningEventCategories()
        Returns:
        Set of RDS event categories (for example `failure`, `maintenance`) to check for after create and update operations. If set, the provider describes RDS events reported for this instance during the operation and surfaces a warning diagnostic, with the RDS event message, for each one found in these categories. Has no effect if unset; see [DescribeEvents](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEvents.html) and the `aws.rds.getEvents` data source for the source of these events. Requires the `rds:DescribeEvents` IAM permission when set.

      • writer

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> writer()
        Returns:
        Boolean indicating if this instance is writable. `False` indicates this instance is a read replica.