Package software.amazon.awssdk.services.databasemigration.model

Class OrderableReplicationInstance

java.lang.Object

software.amazon.awssdk.services.databasemigration.model.OrderableReplicationInstance

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OrderableReplicationInstance.Builder,OrderableReplicationInstance>

@Generated("software.amazon.awssdk:codegen")
public final class OrderableReplicationInstance
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OrderableReplicationInstance.Builder,OrderableReplicationInstance>

In response to the DescribeOrderableReplicationInstances operation, this object describes an available replication instance. This description includes the replication instance's type, engine version, and allocated storage.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OrderableReplicationInstance.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	availabilityZones()	List of Availability Zones for this replication instance.
static OrderableReplicationInstance.Builder	builder()
Integer	defaultAllocatedStorage()	The default amount of storage (in gigabytes) that is allocated for the replication instance.
String	engineVersion()	The version of the replication engine.
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.
int	hashCode()
Integer	includedAllocatedStorage()	The amount of storage (in gigabytes) that is allocated for the replication instance.
Integer	maxAllocatedStorage()	The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
Integer	minAllocatedStorage()	The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
ReleaseStatusValues	releaseStatus()	The value returned when the specified EngineVersion of the replication instance is in Beta or test mode.
String	releaseStatusAsString()	The value returned when the specified EngineVersion of the replication instance is in Beta or test mode.
String	replicationInstanceClass()	The compute and memory capacity of the replication instance as defined for the specified replication instance class.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends OrderableReplicationInstance.Builder>	serializableBuilderClass()
String	storageType()	The type of storage used by the replication instance.
OrderableReplicationInstance.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

engineVersion

public final String engineVersion()

The version of the replication engine.

Returns:

The version of the replication engine.

replicationInstanceClass

public final String replicationInstanceClass()

The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large".

For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.

Returns:

The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large".

For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.

storageType

public final String storageType()

The type of storage used by the replication instance.

Returns:

The type of storage used by the replication instance.

minAllocatedStorage

public final Integer minAllocatedStorage()

The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

Returns:

The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

maxAllocatedStorage

public final Integer maxAllocatedStorage()

The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

Returns:

The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

defaultAllocatedStorage

public final Integer defaultAllocatedStorage()

The default amount of storage (in gigabytes) that is allocated for the replication instance.

Returns:

The default amount of storage (in gigabytes) that is allocated for the replication instance.

includedAllocatedStorage

public final Integer includedAllocatedStorage()

The amount of storage (in gigabytes) that is allocated for the replication instance.

Returns:

The amount of storage (in gigabytes) that is allocated for the replication 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<String> availabilityZones()

List of Availability Zones for this replication 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:

List of Availability Zones for this replication instance.

releaseStatus

public final ReleaseStatusValues releaseStatus()

The value returned when the specified EngineVersion of the replication instance is in Beta or test mode. This indicates some features might not work as expected.

DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.

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

Returns:

The value returned when the specified EngineVersion of the replication instance is in Beta or test mode. This indicates some features might not work as expected.

DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.

See Also:

ReleaseStatusValues

releaseStatusAsString

public final String releaseStatusAsString()

The value returned when the specified EngineVersion of the replication instance is in Beta or test mode. This indicates some features might not work as expected.

DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.

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

Returns:

The value returned when the specified EngineVersion of the replication instance is in Beta or test mode. This indicates some features might not work as expected.

DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.

See Also:

ReleaseStatusValues

toBuilder

public OrderableReplicationInstance.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OrderableReplicationInstance.Builder,OrderableReplicationInstance>

builder

public static OrderableReplicationInstance.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo