OrderableDBInstanceOption (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.rds.model.OrderableDBInstanceOption

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OrderableDBInstanceOption.Builder,OrderableDBInstanceOption>
```
@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface OrderableDBInstanceOption.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`OrderableDBInstanceOption.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`availabilityZoneGroup()` The Availability Zone group for a DB instance.
`List<AvailabilityZone>`	`availabilityZones()` A list of Availability Zones for a DB instance.
`List<AvailableProcessorFeature>`	`availableProcessorFeatures()` A list of the available processor features for the DB instance class of a DB instance.
`static OrderableDBInstanceOption.Builder`	`builder()`
`String`	`dbInstanceClass()` The DB instance class for a DB instance.
`String`	`engine()` The engine type of a DB instance.
`String`	`engineVersion()` The engine version of a DB instance.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAvailabilityZones()` For responses, this returns true if the service returned a value for the AvailabilityZones property.
`boolean`	`hasAvailableProcessorFeatures()` For responses, this returns true if the service returned a value for the AvailableProcessorFeatures property.
`int`	`hashCode()`
`boolean`	`hasSupportedActivityStreamModes()` For responses, this returns true if the service returned a value for the SupportedActivityStreamModes property.
`boolean`	`hasSupportedEngineModes()` For responses, this returns true if the service returned a value for the SupportedEngineModes property.
`boolean`	`hasSupportedNetworkTypes()` For responses, this returns true if the service returned a value for the SupportedNetworkTypes property.
`String`	`licenseModel()` The license model for a DB instance.
`Integer`	`maxIopsPerDbInstance()` Maximum total provisioned IOPS for a DB instance.
`Double`	`maxIopsPerGib()` Maximum provisioned IOPS per GiB for a DB instance.
`Integer`	`maxStorageSize()` Maximum storage size for a DB instance.
`Integer`	`maxStorageThroughputPerDbInstance()` Maximum storage throughput for a DB instance.
`Double`	`maxStorageThroughputPerIops()` Maximum storage throughput to provisioned IOPS ratio for a DB instance.
`Integer`	`minIopsPerDbInstance()` Minimum total provisioned IOPS for a DB instance.
`Double`	`minIopsPerGib()` Minimum provisioned IOPS per GiB for a DB instance.
`Integer`	`minStorageSize()` Minimum storage size for a DB instance.
`Integer`	`minStorageThroughputPerDbInstance()` Minimum storage throughput for a DB instance.
`Double`	`minStorageThroughputPerIops()` Minimum storage throughput to provisioned IOPS ratio for a DB instance.
`Boolean`	`multiAZCapable()` Indicates whether a DB instance is Multi-AZ capable.
`Boolean`	`outpostCapable()` Whether a DB instance supports RDS on Outposts.
`Boolean`	`readReplicaCapable()` Indicates whether a DB instance can have a read replica.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends OrderableDBInstanceOption.Builder>`	`serializableBuilderClass()`
`String`	`storageType()` Indicates the storage type for a DB instance.
`List<String>`	`supportedActivityStreamModes()` The list of supported modes for Database Activity Streams.
`List<String>`	`supportedEngineModes()` A list of the supported DB engine modes.
`List<String>`	`supportedNetworkTypes()` The network types supported by the DB instance (`IPV4` or `DUAL`).
`Boolean`	`supportsClusters()` Whether DB instances can be configured as a Multi-AZ DB cluster.
`Boolean`	`supportsEnhancedMonitoring()` Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
`Boolean`	`supportsGlobalDatabases()` A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
`Boolean`	`supportsIAMDatabaseAuthentication()` Indicates whether a DB instance supports IAM database authentication.
`Boolean`	`supportsIops()` Indicates whether a DB instance supports provisioned IOPS.
`Boolean`	`supportsKerberosAuthentication()` Whether a DB instance supports Kerberos Authentication.
`Boolean`	`supportsPerformanceInsights()` True if a DB instance supports Performance Insights, otherwise false.
`Boolean`	`supportsStorageAutoscaling()` Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
`Boolean`	`supportsStorageEncryption()` Indicates whether a DB instance supports encrypted storage.
`Boolean`	`supportsStorageThroughput()` Indicates whether a DB instance supports storage throughput.
`OrderableDBInstanceOption.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Boolean`	`vpc()` Indicates whether a DB instance is in a VPC.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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()
```
    Indicates the storage type for a DB instance.
    
    Returns:
    
    Indicates 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()
```
    True if a DB instance supports Performance Insights, otherwise false.
    
    Returns:
    
    True if a DB instance supports Performance Insights, otherwise false.
  - 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()
```
    Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
    
    Returns:
    
    Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
  - supportsKerberosAuthentication
```
public final Boolean supportsKerberosAuthentication()
```
    Whether a DB instance supports Kerberos Authentication.
    
    Returns:
    
    Whether a DB instance supports Kerberos Authentication.
  - outpostCapable
```
public final Boolean outpostCapable()
```
    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:
    
    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()
```
    A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
    
    Returns:
    
    A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
  - supportsClusters
```
public final Boolean supportsClusters()
```
    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:
    
    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.
  - toBuilder
```
public OrderableDBInstanceOption.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<OrderableDBInstanceOption.Builder,OrderableDBInstanceOption>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class OrderableDBInstanceOption

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

engine

engineVersion

dbInstanceClass

licenseModel

availabilityZoneGroup

hasAvailabilityZones

availabilityZones

multiAZCapable

readReplicaCapable

vpc

supportsStorageEncryption

storageType

supportsIops

supportsEnhancedMonitoring

supportsIAMDatabaseAuthentication

supportsPerformanceInsights

minStorageSize

maxStorageSize

minIopsPerDbInstance

maxIopsPerDbInstance

minIopsPerGib

maxIopsPerGib

hasAvailableProcessorFeatures

availableProcessorFeatures

hasSupportedEngineModes

supportedEngineModes

supportsStorageAutoscaling

supportsKerberosAuthentication

outpostCapable

hasSupportedActivityStreamModes

supportedActivityStreamModes

supportsGlobalDatabases

supportsClusters

hasSupportedNetworkTypes

supportedNetworkTypes

supportsStorageThroughput

minStorageThroughputPerDbInstance

maxStorageThroughputPerDbInstance

minStorageThroughputPerIops

maxStorageThroughputPerIops

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields