Class RDSDBRecommendation

java.lang.Object
software.amazon.awssdk.services.computeoptimizer.model.RDSDBRecommendation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RDSDBRecommendation.Builder,RDSDBRecommendation>
@Generated("software.amazon.awssdk:codegen") public final class RDSDBRecommendation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RDSDBRecommendation.Builder,RDSDBRecommendation>

Describes an Amazon Aurora and RDS database recommendation.

See Also:

  • Method Details

    • resourceArn

      public final String resourceArn()

      The ARN of the current Amazon Aurora or RDS database.

      The following is the format of the ARN:

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

      Returns:
      The ARN of the current Amazon Aurora or RDS database.

      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 Aurora or RDS database.

      Returns:
      The Amazon Web Services account ID of the Amazon Aurora or RDS database.

    • engine

      public final String engine()

      The engine of the DB instance.

      Returns:
      The engine of the DB 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 Aurora or RDS DB instance.

      Returns:
      The DB instance class of the current Aurora or RDS DB instance.

    • currentStorageConfiguration

      public final DBStorageConfiguration currentStorageConfiguration()

      The configuration of the current DB storage.

      Returns:
      The configuration of the current DB 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 DB 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 DB instance is idle or not.
      See Also:

    • idleAsString

      public final String idleAsString()

      This indicates if the DB 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 DB instance is idle or not.
      See Also:

    • instanceFinding

      public final RDSInstanceFinding instanceFinding()

      The finding classification of an Amazon Aurora and RDS DB instance.

      For more information about finding classifications, see Finding classifications for Aurora and RDS databases in the Compute Optimizer User Guide.

      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 Aurora and RDS DB instance.

      For more information about finding classifications, see Finding classifications for Aurora and RDS databases in the Compute Optimizer User Guide.

      See Also:

    • instanceFindingAsString

      public final String instanceFindingAsString()

      The finding classification of an Amazon Aurora and RDS DB instance.

      For more information about finding classifications, see Finding classifications for Aurora and RDS databases in the Compute Optimizer User Guide.

      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 Aurora and RDS DB instance.

      For more information about finding classifications, see Finding classifications for Aurora and RDS databases in the Compute Optimizer User Guide.

      See Also:

    • storageFinding

      public final RDSStorageFinding storageFinding()

      The finding classification of Amazon RDS DB instance storage.

      For more information about finding classifications, see Finding classifications for Aurora and RDS databases in the Compute Optimizer User Guide.

      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 DB instance storage.

      For more information about finding classifications, see Finding classifications for Aurora and RDS databases in the Compute Optimizer User Guide.

      See Also:

    • storageFindingAsString

      public final String storageFindingAsString()

      The finding classification of Amazon RDS DB instance storage.

      For more information about finding classifications, see Finding classifications for Aurora and RDS databases in the Compute Optimizer User Guide.

      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 DB instance storage.

      For more information about finding classifications, see Finding classifications for Aurora and RDS databases in the Compute Optimizer User Guide.

      See Also:

    • instanceFindingReasonCodes

      public final List<RDSInstanceFindingReasonCode> instanceFindingReasonCodes()

      The reason for the finding classification of a DB 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 a DB 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 a DB 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 a DB instance.

    • currentInstancePerformanceRisk

      public final RDSCurrentInstancePerformanceRisk currentInstancePerformanceRisk()

      The performance risk for the current DB instance.

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

      Returns:
      The performance risk for the current DB instance.
      See Also:

    • currentInstancePerformanceRiskAsString

      public final String currentInstancePerformanceRiskAsString()

      The performance risk for the current DB instance.

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

      Returns:
      The performance risk for the current DB instance.
      See Also:

    • currentStorageEstimatedMonthlyVolumeIOPsCostVariation

      public final RDSEstimatedMonthlyVolumeIOPsCostVariation currentStorageEstimatedMonthlyVolumeIOPsCostVariation()

      The level of variation in monthly I/O costs for the current DB storage configuration.

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

      Returns:
      The level of variation in monthly I/O costs for the current DB storage configuration.
      See Also:

    • currentStorageEstimatedMonthlyVolumeIOPsCostVariationAsString

      public final String currentStorageEstimatedMonthlyVolumeIOPsCostVariationAsString()

      The level of variation in monthly I/O costs for the current DB storage configuration.

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

      Returns:
      The level of variation in monthly I/O costs for the current DB storage configuration.
      See Also:

    • storageFindingReasonCodes

      public final List<RDSStorageFindingReasonCode> storageFindingReasonCodes()

      The reason for the finding classification of RDS DB instance 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 RDS DB instance 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 RDS DB instance 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 RDS DB instance 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 RDS DB 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 RDS DB 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 DB instance 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 DB instance 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 DB 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 hasUtilizationMetrics() method.

      Returns:
      An array of objects that describe the utilization metrics of the DB instance.

    • effectiveRecommendationPreferences

      public final RDSEffectiveRecommendationPreferences effectiveRecommendationPreferences()

      Describes the effective recommendation preferences for DB instances.

      Returns:
      Describes the effective recommendation preferences for DB instances.

    • lookbackPeriodInDays

      public final Double lookbackPeriodInDays()

      The number of days the DB instance utilization metrics were analyzed.

      Returns:
      The number of days the DB instance utilization metrics were analyzed.

    • lastRefreshTimestamp

      public final Instant lastRefreshTimestamp()

      The timestamp of when the DB instance recommendation was last generated.

      Returns:
      The timestamp of when the DB instance 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 DB instance 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 DB instance recommendations.

    • toBuilder

      public RDSDBRecommendation.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RDSDBRecommendation.Builder,RDSDBRecommendation>
      Returns:
      a builder for type T

    • builder

      public static RDSDBRecommendation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RDSDBRecommendation.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.