Class RDSDBRecommendation

    • Method Detail

      • resourceArn

        public final String resourceArn()

        The ARN of the current Amazon RDS.

        The following is the format of the ARN:

        arn:aws:rds:{region}:{accountId}:db:{resourceName}

        Returns:
        The ARN of the current Amazon RDS.

        The following is the format of the ARN:

        arn:aws:rds:{region}:{accountId}:db:{resourceName}

      • accountId

        public final String accountId()

        The Amazon Web Services account ID of the Amazon RDS.

        Returns:
        The Amazon Web Services account ID of the Amazon RDS.
      • engine

        public final String engine()

        The engine of the RDS instance.

        Returns:
        The engine of the RDS instance.
      • engineVersion

        public final String engineVersion()

        The database engine version.

        Returns:
        The database engine version.
      • promotionTier

        public final Integer promotionTier()

        The promotion tier for the Aurora instance.

        Returns:
        The promotion tier for the Aurora instance.
      • currentDBInstanceClass

        public final String currentDBInstanceClass()

        The DB instance class of the current RDS instance.

        Returns:
        The DB instance class of the current RDS instance.
      • currentStorageConfiguration

        public final DBStorageConfiguration currentStorageConfiguration()

        The configuration of the current RDS storage.

        Returns:
        The configuration of the current RDS storage.
      • dbClusterIdentifier

        public final String dbClusterIdentifier()

        The identifier for DB cluster.

        Returns:
        The identifier for DB cluster.
      • idle

        public final Idle idle()

        This indicates if the RDS instance is idle or not.

        If the service returns an enum value that is not available in the current SDK version, idle will return Idle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from idleAsString().

        Returns:
        This indicates if the RDS instance is idle or not.
        See Also:
        Idle
      • idleAsString

        public final String idleAsString()

        This indicates if the RDS instance is idle or not.

        If the service returns an enum value that is not available in the current SDK version, idle will return Idle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from idleAsString().

        Returns:
        This indicates if the RDS instance is idle or not.
        See Also:
        Idle
      • instanceFinding

        public final RDSInstanceFinding instanceFinding()

        The finding classification of an Amazon RDS instance.

        Findings for Amazon RDS instance include:

        • Underprovisioned — When Compute Optimizer detects that there’s not enough resource specifications, an Amazon RDS is considered under-provisioned.

        • Overprovisioned — When Compute Optimizer detects that there’s excessive resource specifications, an Amazon RDS is considered over-provisioned.

        • Optimized — When the specifications of your Amazon RDS instance meet the performance requirements of your workload, the service is considered optimized.

        If the service returns an enum value that is not available in the current SDK version, instanceFinding will return RDSInstanceFinding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceFindingAsString().

        Returns:
        The finding classification of an Amazon RDS instance.

        Findings for Amazon RDS instance include:

        • Underprovisioned — When Compute Optimizer detects that there’s not enough resource specifications, an Amazon RDS is considered under-provisioned.

        • Overprovisioned — When Compute Optimizer detects that there’s excessive resource specifications, an Amazon RDS is considered over-provisioned.

        • Optimized — When the specifications of your Amazon RDS instance meet the performance requirements of your workload, the service is considered optimized.

        See Also:
        RDSInstanceFinding
      • instanceFindingAsString

        public final String instanceFindingAsString()

        The finding classification of an Amazon RDS instance.

        Findings for Amazon RDS instance include:

        • Underprovisioned — When Compute Optimizer detects that there’s not enough resource specifications, an Amazon RDS is considered under-provisioned.

        • Overprovisioned — When Compute Optimizer detects that there’s excessive resource specifications, an Amazon RDS is considered over-provisioned.

        • Optimized — When the specifications of your Amazon RDS instance meet the performance requirements of your workload, the service is considered optimized.

        If the service returns an enum value that is not available in the current SDK version, instanceFinding will return RDSInstanceFinding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceFindingAsString().

        Returns:
        The finding classification of an Amazon RDS instance.

        Findings for Amazon RDS instance include:

        • Underprovisioned — When Compute Optimizer detects that there’s not enough resource specifications, an Amazon RDS is considered under-provisioned.

        • Overprovisioned — When Compute Optimizer detects that there’s excessive resource specifications, an Amazon RDS is considered over-provisioned.

        • Optimized — When the specifications of your Amazon RDS instance meet the performance requirements of your workload, the service is considered optimized.

        See Also:
        RDSInstanceFinding
      • storageFinding

        public final RDSStorageFinding storageFinding()

        The finding classification of Amazon RDS storage.

        Findings for Amazon RDS instance include:

        • Underprovisioned — When Compute Optimizer detects that there’s not enough storage, an Amazon RDS is considered under-provisioned.

        • Overprovisioned — When Compute Optimizer detects that there’s excessive storage, an Amazon RDS is considered over-provisioned.

        • Optimized — When the storage of your Amazon RDS meet the performance requirements of your workload, the service is considered optimized.

        If the service returns an enum value that is not available in the current SDK version, storageFinding will return RDSStorageFinding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageFindingAsString().

        Returns:
        The finding classification of Amazon RDS storage.

        Findings for Amazon RDS instance include:

        • Underprovisioned — When Compute Optimizer detects that there’s not enough storage, an Amazon RDS is considered under-provisioned.

        • Overprovisioned — When Compute Optimizer detects that there’s excessive storage, an Amazon RDS is considered over-provisioned.

        • Optimized — When the storage of your Amazon RDS meet the performance requirements of your workload, the service is considered optimized.

        See Also:
        RDSStorageFinding
      • storageFindingAsString

        public final String storageFindingAsString()

        The finding classification of Amazon RDS storage.

        Findings for Amazon RDS instance include:

        • Underprovisioned — When Compute Optimizer detects that there’s not enough storage, an Amazon RDS is considered under-provisioned.

        • Overprovisioned — When Compute Optimizer detects that there’s excessive storage, an Amazon RDS is considered over-provisioned.

        • Optimized — When the storage of your Amazon RDS meet the performance requirements of your workload, the service is considered optimized.

        If the service returns an enum value that is not available in the current SDK version, storageFinding will return RDSStorageFinding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageFindingAsString().

        Returns:
        The finding classification of Amazon RDS storage.

        Findings for Amazon RDS instance include:

        • Underprovisioned — When Compute Optimizer detects that there’s not enough storage, an Amazon RDS is considered under-provisioned.

        • Overprovisioned — When Compute Optimizer detects that there’s excessive storage, an Amazon RDS is considered over-provisioned.

        • Optimized — When the storage of your Amazon RDS meet the performance requirements of your workload, the service is considered optimized.

        See Also:
        RDSStorageFinding
      • instanceFindingReasonCodes

        public final List<RDSInstanceFindingReasonCode> instanceFindingReasonCodes()

        The reason for the finding classification of an Amazon RDS instance.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstanceFindingReasonCodes() method.

        Returns:
        The reason for the finding classification of an Amazon RDS instance.
      • hasInstanceFindingReasonCodes

        public final boolean hasInstanceFindingReasonCodes()
        For responses, this returns true if the service returned a value for the InstanceFindingReasonCodes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • instanceFindingReasonCodesAsStrings

        public final List<String> instanceFindingReasonCodesAsStrings()

        The reason for the finding classification of an Amazon RDS instance.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstanceFindingReasonCodes() method.

        Returns:
        The reason for the finding classification of an Amazon RDS instance.
      • storageFindingReasonCodes

        public final List<RDSStorageFindingReasonCode> storageFindingReasonCodes()

        The reason for the finding classification of Amazon RDS storage.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStorageFindingReasonCodes() method.

        Returns:
        The reason for the finding classification of Amazon RDS storage.
      • hasStorageFindingReasonCodes

        public final boolean hasStorageFindingReasonCodes()
        For responses, this returns true if the service returned a value for the StorageFindingReasonCodes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • storageFindingReasonCodesAsStrings

        public final List<String> storageFindingReasonCodesAsStrings()

        The reason for the finding classification of Amazon RDS storage.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStorageFindingReasonCodes() method.

        Returns:
        The reason for the finding classification of Amazon RDS storage.
      • hasInstanceRecommendationOptions

        public final boolean hasInstanceRecommendationOptions()
        For responses, this returns true if the service returned a value for the InstanceRecommendationOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • instanceRecommendationOptions

        public final List<RDSDBInstanceRecommendationOption> instanceRecommendationOptions()

        An array of objects that describe the recommendation options for the Amazon RDS instance.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstanceRecommendationOptions() method.

        Returns:
        An array of objects that describe the recommendation options for the Amazon RDS instance.
      • hasStorageRecommendationOptions

        public final boolean hasStorageRecommendationOptions()
        For responses, this returns true if the service returned a value for the StorageRecommendationOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • storageRecommendationOptions

        public final List<RDSDBStorageRecommendationOption> storageRecommendationOptions()

        An array of objects that describe the recommendation options for Amazon RDS storage.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStorageRecommendationOptions() method.

        Returns:
        An array of objects that describe the recommendation options for Amazon RDS storage.
      • hasUtilizationMetrics

        public final boolean hasUtilizationMetrics()
        For responses, this returns true if the service returned a value for the UtilizationMetrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • utilizationMetrics

        public final List<RDSDBUtilizationMetric> utilizationMetrics()

        An array of objects that describe the utilization metrics of the Amazon RDS.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUtilizationMetrics() method.

        Returns:
        An array of objects that describe the utilization metrics of the Amazon RDS.
      • effectiveRecommendationPreferences

        public final RDSEffectiveRecommendationPreferences effectiveRecommendationPreferences()

        Describes the effective recommendation preferences for Amazon RDS.

        Returns:
        Describes the effective recommendation preferences for Amazon RDS.
      • lookbackPeriodInDays

        public final Double lookbackPeriodInDays()

        The number of days the Amazon RDS utilization metrics were analyzed.

        Returns:
        The number of days the Amazon RDS utilization metrics were analyzed.
      • lastRefreshTimestamp

        public final Instant lastRefreshTimestamp()

        The timestamp of when the Amazon RDS recommendation was last generated.

        Returns:
        The timestamp of when the Amazon RDS recommendation was last generated.
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • tags

        public final List<Tag> tags()

        A list of tags assigned to your Amazon RDS recommendations.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        A list of tags assigned to your Amazon RDS recommendations.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)