Package software.amazon.awssdk.services.rds.model

Class OrderableDBInstanceOption

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

Contains a list of available options for a DB instance.

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

See Also:

  • Method Details

    • engine

      public final String engine()

      The engine type of a DB instance.

      Returns:
      The engine type of a DB instance.

    • engineVersion

      public final String engineVersion()

      The engine version of a DB instance.

      Returns:
      The engine version of a DB instance.

    • dbInstanceClass

      public final String dbInstanceClass()

      The DB instance class for a DB instance.

      Returns:
      The DB instance class for a DB instance.

    • licenseModel

      public final String licenseModel()

      The license model for a DB instance.

      Returns:
      The license model for a DB instance.

    • availabilityZoneGroup

      public final String availabilityZoneGroup()

      The Availability Zone group for a DB instance.

      Returns:
      The Availability Zone group for a DB instance.

    • hasAvailabilityZones

      public final boolean hasAvailabilityZones()
      For responses, this returns true if the service returned a value for the AvailabilityZones 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.

    • availabilityZones

      public final List<AvailabilityZone> availabilityZones()

      A list of Availability Zones for 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 hasAvailabilityZones() method.

      Returns:
      A list of Availability Zones for a DB instance.

    • multiAZCapable

      public final Boolean multiAZCapable()

      Indicates whether a DB instance is Multi-AZ capable.

      Returns:
      Indicates whether a DB instance is Multi-AZ capable.

    • readReplicaCapable

      public final Boolean readReplicaCapable()

      Indicates whether a DB instance can have a read replica.

      Returns:
      Indicates whether a DB instance can have a read replica.

    • vpc

      public final Boolean vpc()

      Indicates whether a DB instance is in a VPC.

      Returns:
      Indicates whether a DB instance is in a VPC.

    • supportsStorageEncryption

      public final Boolean supportsStorageEncryption()

      Indicates whether a DB instance supports encrypted storage.

      Returns:
      Indicates whether a DB instance supports encrypted storage.

    • storageType

      public final String storageType()

      The storage type for a DB instance.

      Returns:
      The storage type for a DB instance.

    • supportsIops

      public final Boolean supportsIops()

      Indicates whether a DB instance supports provisioned IOPS.

      Returns:
      Indicates whether a DB instance supports provisioned IOPS.

    • supportsEnhancedMonitoring

      public final Boolean supportsEnhancedMonitoring()

      Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

      Returns:
      Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

    • supportsIAMDatabaseAuthentication

      public final Boolean supportsIAMDatabaseAuthentication()

      Indicates whether a DB instance supports IAM database authentication.

      Returns:
      Indicates whether a DB instance supports IAM database authentication.

    • supportsPerformanceInsights

      public final Boolean supportsPerformanceInsights()

      Indicates whether a DB instance supports Performance Insights.

      Returns:
      Indicates whether a DB instance supports Performance Insights.

    • minStorageSize

      public final Integer minStorageSize()

      Minimum storage size for a DB instance.

      Returns:
      Minimum storage size for a DB instance.

    • maxStorageSize

      public final Integer maxStorageSize()

      Maximum storage size for a DB instance.

      Returns:
      Maximum storage size for a DB instance.

    • minIopsPerDbInstance

      public final Integer minIopsPerDbInstance()

      Minimum total provisioned IOPS for a DB instance.

      Returns:
      Minimum total provisioned IOPS for a DB instance.

    • maxIopsPerDbInstance

      public final Integer maxIopsPerDbInstance()

      Maximum total provisioned IOPS for a DB instance.

      Returns:
      Maximum total provisioned IOPS for a DB instance.

    • minIopsPerGib

      public final Double minIopsPerGib()

      Minimum provisioned IOPS per GiB for a DB instance.

      Returns:
      Minimum provisioned IOPS per GiB for a DB instance.

    • maxIopsPerGib

      public final Double maxIopsPerGib()

      Maximum provisioned IOPS per GiB for a DB instance.

      Returns:
      Maximum provisioned IOPS per GiB for a DB instance.

    • hasAvailableProcessorFeatures

      public final boolean hasAvailableProcessorFeatures()
      For responses, this returns true if the service returned a value for the AvailableProcessorFeatures 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.

    • availableProcessorFeatures

      public final List<AvailableProcessorFeature> availableProcessorFeatures()

      A list of the available processor features for the DB instance class 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 hasAvailableProcessorFeatures() method.

      Returns:
      A list of the available processor features for the DB instance class of a DB instance.

    • hasSupportedEngineModes

      public final boolean hasSupportedEngineModes()
      For responses, this returns true if the service returned a value for the SupportedEngineModes 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.

    • supportedEngineModes

      public final List<String> supportedEngineModes()

      A list of the supported DB engine modes.

      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 hasSupportedEngineModes() method.

      Returns:
      A list of the supported DB engine modes.

    • supportsStorageAutoscaling

      public final Boolean supportsStorageAutoscaling()

      Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

      Returns:
      Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

    • supportsKerberosAuthentication

      public final Boolean supportsKerberosAuthentication()

      Indicates whether a DB instance supports Kerberos Authentication.

      Returns:
      Indicates whether a DB instance supports Kerberos Authentication.

    • outpostCapable

      public final Boolean outpostCapable()

      Indicates whether a DB instance supports RDS on Outposts.

      For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

      Returns:
      Indicates whether a DB instance supports RDS on Outposts.

      For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

    • hasSupportedActivityStreamModes

      public final boolean hasSupportedActivityStreamModes()
      For responses, this returns true if the service returned a value for the SupportedActivityStreamModes 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.

    • supportedActivityStreamModes

      public final List<String> supportedActivityStreamModes()

      The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync, async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn't supported, the return value is an empty list.

      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 hasSupportedActivityStreamModes() method.

      Returns:
      The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync, async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn't supported, the return value is an empty list.

    • supportsGlobalDatabases

      public final Boolean supportsGlobalDatabases()

      Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

      Returns:
      Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

    • supportsClusters

      public final Boolean supportsClusters()

      Indicates whether DB instances can be configured as a Multi-AZ DB cluster.

      For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

      Returns:
      Indicates whether DB instances can be configured as a Multi-AZ DB cluster.

      For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

    • hasSupportedNetworkTypes

      public final boolean hasSupportedNetworkTypes()
      For responses, this returns true if the service returned a value for the SupportedNetworkTypes 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.

    • supportedNetworkTypes

      public final List<String> supportedNetworkTypes()

      The network types supported by the DB instance (IPV4 or DUAL).

      A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

      For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

      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 hasSupportedNetworkTypes() method.

      Returns:
      The network types supported by the DB instance (IPV4 or DUAL).

      A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

      For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

    • supportsStorageThroughput

      public final Boolean supportsStorageThroughput()

      Indicates whether a DB instance supports storage throughput.

      Returns:
      Indicates whether a DB instance supports storage throughput.

    • minStorageThroughputPerDbInstance

      public final Integer minStorageThroughputPerDbInstance()

      Minimum storage throughput for a DB instance.

      Returns:
      Minimum storage throughput for a DB instance.

    • maxStorageThroughputPerDbInstance

      public final Integer maxStorageThroughputPerDbInstance()

      Maximum storage throughput for a DB instance.

      Returns:
      Maximum storage throughput for a DB instance.

    • minStorageThroughputPerIops

      public final Double minStorageThroughputPerIops()

      Minimum storage throughput to provisioned IOPS ratio for a DB instance.

      Returns:
      Minimum storage throughput to provisioned IOPS ratio for a DB instance.

    • maxStorageThroughputPerIops

      public final Double maxStorageThroughputPerIops()

      Maximum storage throughput to provisioned IOPS ratio for a DB instance.

      Returns:
      Maximum storage throughput to provisioned IOPS ratio for a DB instance.

    • supportsDedicatedLogVolume

      public final Boolean supportsDedicatedLogVolume()

      Indicates whether a DB instance supports using a dedicated log volume (DLV).

      Returns:
      Indicates whether a DB instance supports using a dedicated log volume (DLV).

    • toBuilder

      public OrderableDBInstanceOption.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<OrderableDBInstanceOption.Builder,OrderableDBInstanceOption>
      Returns:
      a builder for type T

    • builder

      public static OrderableDBInstanceOption.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OrderableDBInstanceOption.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.