RecoveryInstance - AWS Elastic Disaster Recovery
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

RecoveryInstance

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

Contents

agentVersion

The version of the DRS agent installed on the recovery instance

Type: String

Pattern: [0-9]{1,5}.[0-9]{1,5}.[0-9]{1,5}(.[0-9]{4}.[0-9]{3}.[0-9]{4})?

Required: No

arn

The ARN of the Recovery Instance.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:.{16,2044}

Required: No

dataReplicationInfo

The Data Replication Info of the Recovery Instance.

Type: RecoveryInstanceDataReplicationInfo object

Required: No

ec2InstanceID

The EC2 instance ID of the Recovery Instance.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: i-[0-9a-fA-F]{8,}

Required: No

ec2InstanceState

The state of the EC2 instance for this Recovery Instance.

Type: String

Valid Values: PENDING | RUNNING | STOPPING | STOPPED | SHUTTING-DOWN | TERMINATED | NOT_FOUND

Required: No

failback

An object representing failback related information of the Recovery Instance.

Type: RecoveryInstanceFailback object

Required: No

isDrill

Whether this Recovery Instance was created for a drill or for an actual Recovery event.

Type: Boolean

Required: No

jobID

The ID of the Job that created the Recovery Instance.

Type: String

Length Constraints: Fixed length of 24.

Pattern: drsjob-[0-9a-zA-Z]{17}

Required: No

originAvailabilityZone

AWS availability zone associated with the recovery instance.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: (us(-gov)?|ap|ca|cn|eu|sa|af|me|il)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9][a-z]

Required: No

originEnvironment

Environment (On Premises / AWS) of the instance that the recovery instance originated from.

Type: String

Valid Values: ON_PREMISES | AWS

Required: No

pointInTimeSnapshotDateTime

The date and time of the Point in Time (PIT) snapshot that this Recovery Instance was launched from.

Type: String

Length Constraints: Minimum length of 19. Maximum length of 32.

Pattern: [1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z

Required: No

recoveryInstanceID

The ID of the Recovery Instance.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 19.

Pattern: i-[0-9a-fA-F]{8,}

Required: No

recoveryInstanceProperties

Properties of the Recovery Instance machine.

Type: RecoveryInstanceProperties object

Required: No

sourceOutpostArn

The ARN of the source Outpost

Type: String

Length Constraints: Minimum length of 20. Maximum length of 255.

Pattern: arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}

Required: No

sourceServerID

The Source Server ID that this Recovery Instance is associated with.

Type: String

Length Constraints: Fixed length of 19.

Pattern: s-[0-9a-zA-Z]{17}

Required: No

tags

An array of tags that are associated with the Recovery Instance.

Type: String to string map

Key Length Constraints: Minimum length of 0. Maximum length of 256.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: