Class RecoveryInstance

java.lang.Object
software.amazon.awssdk.services.drs.model.RecoveryInstance
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RecoveryInstance.Builder,RecoveryInstance>

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

A Recovery Instance is a replica of a Source Server running on EC2.

See Also:
  • Method Details

    • agentVersion

      public final String agentVersion()

      The version of the DRS agent installed on the recovery instance

      Returns:
      The version of the DRS agent installed on the recovery instance
    • arn

      public final String arn()

      The ARN of the Recovery Instance.

      Returns:
      The ARN of the Recovery Instance.
    • dataReplicationInfo

      public final RecoveryInstanceDataReplicationInfo dataReplicationInfo()

      The Data Replication Info of the Recovery Instance.

      Returns:
      The Data Replication Info of the Recovery Instance.
    • ec2InstanceID

      public final String ec2InstanceID()

      The EC2 instance ID of the Recovery Instance.

      Returns:
      The EC2 instance ID of the Recovery Instance.
    • ec2InstanceState

      public final EC2InstanceState 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 return EC2InstanceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ec2InstanceStateAsString().

      Returns:
      The state of the EC2 instance for this Recovery Instance.
      See Also:
    • ec2InstanceStateAsString

      public final String 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 return EC2InstanceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ec2InstanceStateAsString().

      Returns:
      The state of the EC2 instance for this Recovery Instance.
      See Also:
    • failback

      public final RecoveryInstanceFailback failback()

      An object representing failback related information of the Recovery Instance.

      Returns:
      An object representing failback related information of the Recovery Instance.
    • isDrill

      public final Boolean 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

      public final String jobID()

      The ID of the Job that created the Recovery Instance.

      Returns:
      The ID of the Job that created the Recovery Instance.
    • originAvailabilityZone

      public final String originAvailabilityZone()

      AWS availability zone associated with the recovery instance.

      Returns:
      AWS availability zone associated with the recovery instance.
    • originEnvironment

      public final OriginEnvironment 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 return OriginEnvironment.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from originEnvironmentAsString().

      Returns:
      Environment (On Premises / AWS) of the instance that the recovery instance originated from.
      See Also:
    • originEnvironmentAsString

      public final String 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 return OriginEnvironment.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from originEnvironmentAsString().

      Returns:
      Environment (On Premises / AWS) of the instance that the recovery instance originated from.
      See Also:
    • pointInTimeSnapshotDateTime

      public final String 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

      public final String recoveryInstanceID()

      The ID of the Recovery Instance.

      Returns:
      The ID of the Recovery Instance.
    • recoveryInstanceProperties

      public final RecoveryInstanceProperties recoveryInstanceProperties()

      Properties of the Recovery Instance machine.

      Returns:
      Properties of the Recovery Instance machine.
    • sourceOutpostArn

      public final String sourceOutpostArn()

      The ARN of the source Outpost

      Returns:
      The ARN of the source Outpost
    • sourceServerID

      public final String 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 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 Map<String,String> 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

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

      public static RecoveryInstance.Builder builder()
    • serializableBuilderClass

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