Class RecoveryInstance
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RecoveryInstance.Builder,
RecoveryInstance>
A Recovery Instance is a replica of a Source Server running on EC2.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The ARN of the Recovery Instance.static RecoveryInstance.Builder
builder()
The Data Replication Info of the Recovery Instance.final String
The EC2 instance ID of the Recovery Instance.final EC2InstanceState
The state of the EC2 instance for this Recovery Instance.final String
The state of the EC2 instance for this Recovery Instance.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final RecoveryInstanceFailback
failback()
An object representing failback related information of the Recovery Instance.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Boolean
isDrill()
Whether this Recovery Instance was created for a drill or for an actual Recovery event.final String
jobID()
The ID of the Job that created the Recovery Instance.final String
AWS availability zone associated with the recovery instance.final OriginEnvironment
Environment (On Premises / AWS) of the instance that the recovery instance originated from.final String
Environment (On Premises / AWS) of the instance that the recovery instance originated from.final String
The date and time of the Point in Time (PIT) snapshot that this Recovery Instance was launched from.final String
The ID of the Recovery Instance.Properties of the Recovery Instance machine.static Class
<? extends RecoveryInstance.Builder> final String
The Source Server ID that this Recovery Instance is associated with.tags()
An array of tags that are associated with the Recovery Instance.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The ARN of the Recovery Instance.
- Returns:
- The ARN of the Recovery Instance.
-
dataReplicationInfo
The Data Replication Info of the Recovery Instance.
- Returns:
- The Data Replication Info of the Recovery Instance.
-
ec2InstanceID
The EC2 instance ID of the Recovery Instance.
- Returns:
- The EC2 instance ID of the Recovery Instance.
-
ec2InstanceState
The state of the EC2 instance for this Recovery Instance.
If the service returns an enum value that is not available in the current SDK version,
ec2InstanceState
will returnEC2InstanceState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromec2InstanceStateAsString()
.- Returns:
- The state of the EC2 instance for this Recovery Instance.
- See Also:
-
ec2InstanceStateAsString
The state of the EC2 instance for this Recovery Instance.
If the service returns an enum value that is not available in the current SDK version,
ec2InstanceState
will returnEC2InstanceState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromec2InstanceStateAsString()
.- Returns:
- The state of the EC2 instance for this Recovery Instance.
- See Also:
-
failback
An object representing failback related information of the Recovery Instance.
- Returns:
- An object representing failback related information of the Recovery Instance.
-
isDrill
Whether this Recovery Instance was created for a drill or for an actual Recovery event.
- Returns:
- Whether this Recovery Instance was created for a drill or for an actual Recovery event.
-
jobID
The ID of the Job that created the Recovery Instance.
- Returns:
- The ID of the Job that created the Recovery Instance.
-
originAvailabilityZone
AWS availability zone associated with the recovery instance.
- Returns:
- AWS availability zone associated with the recovery instance.
-
originEnvironment
Environment (On Premises / AWS) of the instance that the recovery instance originated from.
If the service returns an enum value that is not available in the current SDK version,
originEnvironment
will returnOriginEnvironment.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoriginEnvironmentAsString()
.- Returns:
- Environment (On Premises / AWS) of the instance that the recovery instance originated from.
- See Also:
-
originEnvironmentAsString
Environment (On Premises / AWS) of the instance that the recovery instance originated from.
If the service returns an enum value that is not available in the current SDK version,
originEnvironment
will returnOriginEnvironment.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoriginEnvironmentAsString()
.- Returns:
- Environment (On Premises / AWS) of the instance that the recovery instance originated from.
- See Also:
-
pointInTimeSnapshotDateTime
The date and time of the Point in Time (PIT) snapshot that this Recovery Instance was launched from.
- Returns:
- The date and time of the Point in Time (PIT) snapshot that this Recovery Instance was launched from.
-
recoveryInstanceID
The ID of the Recovery Instance.
- Returns:
- The ID of the Recovery Instance.
-
recoveryInstanceProperties
Properties of the Recovery Instance machine.
- Returns:
- Properties of the Recovery Instance machine.
-
sourceServerID
The Source Server ID that this Recovery Instance is associated with.
- Returns:
- The Source Server ID that this Recovery Instance is associated with.
-
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 theisEmpty()
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
An array of tags that are associated with the Recovery 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
hasTags()
method.- Returns:
- An array of tags that are associated with the Recovery Instance.
-
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 interfaceToCopyableBuilder<RecoveryInstance.Builder,
RecoveryInstance> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-