drs.d.ts 113 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855
  1. import {Request} from '../lib/request';
  2. import {Response} from '../lib/response';
  3. import {AWSError} from '../lib/error';
  4. import {Service} from '../lib/service';
  5. import {ServiceConfigurationOptions} from '../lib/service';
  6. import {ConfigBase as Config} from '../lib/config-base';
  7. interface Blob {}
  8. declare class Drs extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: Drs.Types.ClientConfiguration)
  13. config: Config & Drs.Types.ClientConfiguration;
  14. /**
  15. * Associate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network. Can be used for reverting to previously deployed CloudFormation stacks.
  16. */
  17. associateSourceNetworkStack(params: Drs.Types.AssociateSourceNetworkStackRequest, callback?: (err: AWSError, data: Drs.Types.AssociateSourceNetworkStackResponse) => void): Request<Drs.Types.AssociateSourceNetworkStackResponse, AWSError>;
  18. /**
  19. * Associate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network. Can be used for reverting to previously deployed CloudFormation stacks.
  20. */
  21. associateSourceNetworkStack(callback?: (err: AWSError, data: Drs.Types.AssociateSourceNetworkStackResponse) => void): Request<Drs.Types.AssociateSourceNetworkStackResponse, AWSError>;
  22. /**
  23. * Create an extended source server in the target Account based on the source server in staging account.
  24. */
  25. createExtendedSourceServer(params: Drs.Types.CreateExtendedSourceServerRequest, callback?: (err: AWSError, data: Drs.Types.CreateExtendedSourceServerResponse) => void): Request<Drs.Types.CreateExtendedSourceServerResponse, AWSError>;
  26. /**
  27. * Create an extended source server in the target Account based on the source server in staging account.
  28. */
  29. createExtendedSourceServer(callback?: (err: AWSError, data: Drs.Types.CreateExtendedSourceServerResponse) => void): Request<Drs.Types.CreateExtendedSourceServerResponse, AWSError>;
  30. /**
  31. * Creates a new Launch Configuration Template.
  32. */
  33. createLaunchConfigurationTemplate(params: Drs.Types.CreateLaunchConfigurationTemplateRequest, callback?: (err: AWSError, data: Drs.Types.CreateLaunchConfigurationTemplateResponse) => void): Request<Drs.Types.CreateLaunchConfigurationTemplateResponse, AWSError>;
  34. /**
  35. * Creates a new Launch Configuration Template.
  36. */
  37. createLaunchConfigurationTemplate(callback?: (err: AWSError, data: Drs.Types.CreateLaunchConfigurationTemplateResponse) => void): Request<Drs.Types.CreateLaunchConfigurationTemplateResponse, AWSError>;
  38. /**
  39. * Creates a new ReplicationConfigurationTemplate.
  40. */
  41. createReplicationConfigurationTemplate(params: Drs.Types.CreateReplicationConfigurationTemplateRequest, callback?: (err: AWSError, data: Drs.Types.ReplicationConfigurationTemplate) => void): Request<Drs.Types.ReplicationConfigurationTemplate, AWSError>;
  42. /**
  43. * Creates a new ReplicationConfigurationTemplate.
  44. */
  45. createReplicationConfigurationTemplate(callback?: (err: AWSError, data: Drs.Types.ReplicationConfigurationTemplate) => void): Request<Drs.Types.ReplicationConfigurationTemplate, AWSError>;
  46. /**
  47. * Create a new Source Network resource for a provided VPC ID.
  48. */
  49. createSourceNetwork(params: Drs.Types.CreateSourceNetworkRequest, callback?: (err: AWSError, data: Drs.Types.CreateSourceNetworkResponse) => void): Request<Drs.Types.CreateSourceNetworkResponse, AWSError>;
  50. /**
  51. * Create a new Source Network resource for a provided VPC ID.
  52. */
  53. createSourceNetwork(callback?: (err: AWSError, data: Drs.Types.CreateSourceNetworkResponse) => void): Request<Drs.Types.CreateSourceNetworkResponse, AWSError>;
  54. /**
  55. * Deletes a single Job by ID.
  56. */
  57. deleteJob(params: Drs.Types.DeleteJobRequest, callback?: (err: AWSError, data: Drs.Types.DeleteJobResponse) => void): Request<Drs.Types.DeleteJobResponse, AWSError>;
  58. /**
  59. * Deletes a single Job by ID.
  60. */
  61. deleteJob(callback?: (err: AWSError, data: Drs.Types.DeleteJobResponse) => void): Request<Drs.Types.DeleteJobResponse, AWSError>;
  62. /**
  63. * Deletes a resource launch action.
  64. */
  65. deleteLaunchAction(params: Drs.Types.DeleteLaunchActionRequest, callback?: (err: AWSError, data: Drs.Types.DeleteLaunchActionResponse) => void): Request<Drs.Types.DeleteLaunchActionResponse, AWSError>;
  66. /**
  67. * Deletes a resource launch action.
  68. */
  69. deleteLaunchAction(callback?: (err: AWSError, data: Drs.Types.DeleteLaunchActionResponse) => void): Request<Drs.Types.DeleteLaunchActionResponse, AWSError>;
  70. /**
  71. * Deletes a single Launch Configuration Template by ID.
  72. */
  73. deleteLaunchConfigurationTemplate(params: Drs.Types.DeleteLaunchConfigurationTemplateRequest, callback?: (err: AWSError, data: Drs.Types.DeleteLaunchConfigurationTemplateResponse) => void): Request<Drs.Types.DeleteLaunchConfigurationTemplateResponse, AWSError>;
  74. /**
  75. * Deletes a single Launch Configuration Template by ID.
  76. */
  77. deleteLaunchConfigurationTemplate(callback?: (err: AWSError, data: Drs.Types.DeleteLaunchConfigurationTemplateResponse) => void): Request<Drs.Types.DeleteLaunchConfigurationTemplateResponse, AWSError>;
  78. /**
  79. * Deletes a single Recovery Instance by ID. This deletes the Recovery Instance resource from Elastic Disaster Recovery. The Recovery Instance must be disconnected first in order to delete it.
  80. */
  81. deleteRecoveryInstance(params: Drs.Types.DeleteRecoveryInstanceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  82. /**
  83. * Deletes a single Recovery Instance by ID. This deletes the Recovery Instance resource from Elastic Disaster Recovery. The Recovery Instance must be disconnected first in order to delete it.
  84. */
  85. deleteRecoveryInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  86. /**
  87. * Deletes a single Replication Configuration Template by ID
  88. */
  89. deleteReplicationConfigurationTemplate(params: Drs.Types.DeleteReplicationConfigurationTemplateRequest, callback?: (err: AWSError, data: Drs.Types.DeleteReplicationConfigurationTemplateResponse) => void): Request<Drs.Types.DeleteReplicationConfigurationTemplateResponse, AWSError>;
  90. /**
  91. * Deletes a single Replication Configuration Template by ID
  92. */
  93. deleteReplicationConfigurationTemplate(callback?: (err: AWSError, data: Drs.Types.DeleteReplicationConfigurationTemplateResponse) => void): Request<Drs.Types.DeleteReplicationConfigurationTemplateResponse, AWSError>;
  94. /**
  95. * Delete Source Network resource.
  96. */
  97. deleteSourceNetwork(params: Drs.Types.DeleteSourceNetworkRequest, callback?: (err: AWSError, data: Drs.Types.DeleteSourceNetworkResponse) => void): Request<Drs.Types.DeleteSourceNetworkResponse, AWSError>;
  98. /**
  99. * Delete Source Network resource.
  100. */
  101. deleteSourceNetwork(callback?: (err: AWSError, data: Drs.Types.DeleteSourceNetworkResponse) => void): Request<Drs.Types.DeleteSourceNetworkResponse, AWSError>;
  102. /**
  103. * Deletes a single Source Server by ID. The Source Server must be disconnected first.
  104. */
  105. deleteSourceServer(params: Drs.Types.DeleteSourceServerRequest, callback?: (err: AWSError, data: Drs.Types.DeleteSourceServerResponse) => void): Request<Drs.Types.DeleteSourceServerResponse, AWSError>;
  106. /**
  107. * Deletes a single Source Server by ID. The Source Server must be disconnected first.
  108. */
  109. deleteSourceServer(callback?: (err: AWSError, data: Drs.Types.DeleteSourceServerResponse) => void): Request<Drs.Types.DeleteSourceServerResponse, AWSError>;
  110. /**
  111. * Retrieves a detailed Job log with pagination.
  112. */
  113. describeJobLogItems(params: Drs.Types.DescribeJobLogItemsRequest, callback?: (err: AWSError, data: Drs.Types.DescribeJobLogItemsResponse) => void): Request<Drs.Types.DescribeJobLogItemsResponse, AWSError>;
  114. /**
  115. * Retrieves a detailed Job log with pagination.
  116. */
  117. describeJobLogItems(callback?: (err: AWSError, data: Drs.Types.DescribeJobLogItemsResponse) => void): Request<Drs.Types.DescribeJobLogItemsResponse, AWSError>;
  118. /**
  119. * Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.
  120. */
  121. describeJobs(params: Drs.Types.DescribeJobsRequest, callback?: (err: AWSError, data: Drs.Types.DescribeJobsResponse) => void): Request<Drs.Types.DescribeJobsResponse, AWSError>;
  122. /**
  123. * Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.
  124. */
  125. describeJobs(callback?: (err: AWSError, data: Drs.Types.DescribeJobsResponse) => void): Request<Drs.Types.DescribeJobsResponse, AWSError>;
  126. /**
  127. * Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs
  128. */
  129. describeLaunchConfigurationTemplates(params: Drs.Types.DescribeLaunchConfigurationTemplatesRequest, callback?: (err: AWSError, data: Drs.Types.DescribeLaunchConfigurationTemplatesResponse) => void): Request<Drs.Types.DescribeLaunchConfigurationTemplatesResponse, AWSError>;
  130. /**
  131. * Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs
  132. */
  133. describeLaunchConfigurationTemplates(callback?: (err: AWSError, data: Drs.Types.DescribeLaunchConfigurationTemplatesResponse) => void): Request<Drs.Types.DescribeLaunchConfigurationTemplatesResponse, AWSError>;
  134. /**
  135. * Lists all Recovery Instances or multiple Recovery Instances by ID.
  136. */
  137. describeRecoveryInstances(params: Drs.Types.DescribeRecoveryInstancesRequest, callback?: (err: AWSError, data: Drs.Types.DescribeRecoveryInstancesResponse) => void): Request<Drs.Types.DescribeRecoveryInstancesResponse, AWSError>;
  138. /**
  139. * Lists all Recovery Instances or multiple Recovery Instances by ID.
  140. */
  141. describeRecoveryInstances(callback?: (err: AWSError, data: Drs.Types.DescribeRecoveryInstancesResponse) => void): Request<Drs.Types.DescribeRecoveryInstancesResponse, AWSError>;
  142. /**
  143. * Lists all Recovery Snapshots for a single Source Server.
  144. */
  145. describeRecoverySnapshots(params: Drs.Types.DescribeRecoverySnapshotsRequest, callback?: (err: AWSError, data: Drs.Types.DescribeRecoverySnapshotsResponse) => void): Request<Drs.Types.DescribeRecoverySnapshotsResponse, AWSError>;
  146. /**
  147. * Lists all Recovery Snapshots for a single Source Server.
  148. */
  149. describeRecoverySnapshots(callback?: (err: AWSError, data: Drs.Types.DescribeRecoverySnapshotsResponse) => void): Request<Drs.Types.DescribeRecoverySnapshotsResponse, AWSError>;
  150. /**
  151. * Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
  152. */
  153. describeReplicationConfigurationTemplates(params: Drs.Types.DescribeReplicationConfigurationTemplatesRequest, callback?: (err: AWSError, data: Drs.Types.DescribeReplicationConfigurationTemplatesResponse) => void): Request<Drs.Types.DescribeReplicationConfigurationTemplatesResponse, AWSError>;
  154. /**
  155. * Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
  156. */
  157. describeReplicationConfigurationTemplates(callback?: (err: AWSError, data: Drs.Types.DescribeReplicationConfigurationTemplatesResponse) => void): Request<Drs.Types.DescribeReplicationConfigurationTemplatesResponse, AWSError>;
  158. /**
  159. * Lists all Source Networks or multiple Source Networks filtered by ID.
  160. */
  161. describeSourceNetworks(params: Drs.Types.DescribeSourceNetworksRequest, callback?: (err: AWSError, data: Drs.Types.DescribeSourceNetworksResponse) => void): Request<Drs.Types.DescribeSourceNetworksResponse, AWSError>;
  162. /**
  163. * Lists all Source Networks or multiple Source Networks filtered by ID.
  164. */
  165. describeSourceNetworks(callback?: (err: AWSError, data: Drs.Types.DescribeSourceNetworksResponse) => void): Request<Drs.Types.DescribeSourceNetworksResponse, AWSError>;
  166. /**
  167. * Lists all Source Servers or multiple Source Servers filtered by ID.
  168. */
  169. describeSourceServers(params: Drs.Types.DescribeSourceServersRequest, callback?: (err: AWSError, data: Drs.Types.DescribeSourceServersResponse) => void): Request<Drs.Types.DescribeSourceServersResponse, AWSError>;
  170. /**
  171. * Lists all Source Servers or multiple Source Servers filtered by ID.
  172. */
  173. describeSourceServers(callback?: (err: AWSError, data: Drs.Types.DescribeSourceServersResponse) => void): Request<Drs.Types.DescribeSourceServersResponse, AWSError>;
  174. /**
  175. * Disconnect a Recovery Instance from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Recovery Instance will be terminated / deleted within 90 minutes. If the agent on the Recovery Instance has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the Recovery Instance will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.
  176. */
  177. disconnectRecoveryInstance(params: Drs.Types.DisconnectRecoveryInstanceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  178. /**
  179. * Disconnect a Recovery Instance from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Recovery Instance will be terminated / deleted within 90 minutes. If the agent on the Recovery Instance has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the Recovery Instance will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.
  180. */
  181. disconnectRecoveryInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  182. /**
  183. * Disconnects a specific Source Server from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Source Server will be terminated / deleted within 90 minutes. You cannot disconnect a Source Server if it has a Recovery Instance. If the agent on the Source Server has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.
  184. */
  185. disconnectSourceServer(params: Drs.Types.DisconnectSourceServerRequest, callback?: (err: AWSError, data: Drs.Types.SourceServer) => void): Request<Drs.Types.SourceServer, AWSError>;
  186. /**
  187. * Disconnects a specific Source Server from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Source Server will be terminated / deleted within 90 minutes. You cannot disconnect a Source Server if it has a Recovery Instance. If the agent on the Source Server has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.
  188. */
  189. disconnectSourceServer(callback?: (err: AWSError, data: Drs.Types.SourceServer) => void): Request<Drs.Types.SourceServer, AWSError>;
  190. /**
  191. * Export the Source Network CloudFormation template to an S3 bucket.
  192. */
  193. exportSourceNetworkCfnTemplate(params: Drs.Types.ExportSourceNetworkCfnTemplateRequest, callback?: (err: AWSError, data: Drs.Types.ExportSourceNetworkCfnTemplateResponse) => void): Request<Drs.Types.ExportSourceNetworkCfnTemplateResponse, AWSError>;
  194. /**
  195. * Export the Source Network CloudFormation template to an S3 bucket.
  196. */
  197. exportSourceNetworkCfnTemplate(callback?: (err: AWSError, data: Drs.Types.ExportSourceNetworkCfnTemplateResponse) => void): Request<Drs.Types.ExportSourceNetworkCfnTemplateResponse, AWSError>;
  198. /**
  199. * Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.
  200. */
  201. getFailbackReplicationConfiguration(params: Drs.Types.GetFailbackReplicationConfigurationRequest, callback?: (err: AWSError, data: Drs.Types.GetFailbackReplicationConfigurationResponse) => void): Request<Drs.Types.GetFailbackReplicationConfigurationResponse, AWSError>;
  202. /**
  203. * Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.
  204. */
  205. getFailbackReplicationConfiguration(callback?: (err: AWSError, data: Drs.Types.GetFailbackReplicationConfigurationResponse) => void): Request<Drs.Types.GetFailbackReplicationConfigurationResponse, AWSError>;
  206. /**
  207. * Gets a LaunchConfiguration, filtered by Source Server IDs.
  208. */
  209. getLaunchConfiguration(params: Drs.Types.GetLaunchConfigurationRequest, callback?: (err: AWSError, data: Drs.Types.LaunchConfiguration) => void): Request<Drs.Types.LaunchConfiguration, AWSError>;
  210. /**
  211. * Gets a LaunchConfiguration, filtered by Source Server IDs.
  212. */
  213. getLaunchConfiguration(callback?: (err: AWSError, data: Drs.Types.LaunchConfiguration) => void): Request<Drs.Types.LaunchConfiguration, AWSError>;
  214. /**
  215. * Gets a ReplicationConfiguration, filtered by Source Server ID.
  216. */
  217. getReplicationConfiguration(params: Drs.Types.GetReplicationConfigurationRequest, callback?: (err: AWSError, data: Drs.Types.ReplicationConfiguration) => void): Request<Drs.Types.ReplicationConfiguration, AWSError>;
  218. /**
  219. * Gets a ReplicationConfiguration, filtered by Source Server ID.
  220. */
  221. getReplicationConfiguration(callback?: (err: AWSError, data: Drs.Types.ReplicationConfiguration) => void): Request<Drs.Types.ReplicationConfiguration, AWSError>;
  222. /**
  223. * Initialize Elastic Disaster Recovery.
  224. */
  225. initializeService(params: Drs.Types.InitializeServiceRequest, callback?: (err: AWSError, data: Drs.Types.InitializeServiceResponse) => void): Request<Drs.Types.InitializeServiceResponse, AWSError>;
  226. /**
  227. * Initialize Elastic Disaster Recovery.
  228. */
  229. initializeService(callback?: (err: AWSError, data: Drs.Types.InitializeServiceResponse) => void): Request<Drs.Types.InitializeServiceResponse, AWSError>;
  230. /**
  231. * Returns a list of source servers on a staging account that are extensible, which means that: a. The source server is not already extended into this Account. b. The source server on the Account we’re reading from is not an extension of another source server.
  232. */
  233. listExtensibleSourceServers(params: Drs.Types.ListExtensibleSourceServersRequest, callback?: (err: AWSError, data: Drs.Types.ListExtensibleSourceServersResponse) => void): Request<Drs.Types.ListExtensibleSourceServersResponse, AWSError>;
  234. /**
  235. * Returns a list of source servers on a staging account that are extensible, which means that: a. The source server is not already extended into this Account. b. The source server on the Account we’re reading from is not an extension of another source server.
  236. */
  237. listExtensibleSourceServers(callback?: (err: AWSError, data: Drs.Types.ListExtensibleSourceServersResponse) => void): Request<Drs.Types.ListExtensibleSourceServersResponse, AWSError>;
  238. /**
  239. * Lists resource launch actions.
  240. */
  241. listLaunchActions(params: Drs.Types.ListLaunchActionsRequest, callback?: (err: AWSError, data: Drs.Types.ListLaunchActionsResponse) => void): Request<Drs.Types.ListLaunchActionsResponse, AWSError>;
  242. /**
  243. * Lists resource launch actions.
  244. */
  245. listLaunchActions(callback?: (err: AWSError, data: Drs.Types.ListLaunchActionsResponse) => void): Request<Drs.Types.ListLaunchActionsResponse, AWSError>;
  246. /**
  247. * Returns an array of staging accounts for existing extended source servers.
  248. */
  249. listStagingAccounts(params: Drs.Types.ListStagingAccountsRequest, callback?: (err: AWSError, data: Drs.Types.ListStagingAccountsResponse) => void): Request<Drs.Types.ListStagingAccountsResponse, AWSError>;
  250. /**
  251. * Returns an array of staging accounts for existing extended source servers.
  252. */
  253. listStagingAccounts(callback?: (err: AWSError, data: Drs.Types.ListStagingAccountsResponse) => void): Request<Drs.Types.ListStagingAccountsResponse, AWSError>;
  254. /**
  255. * List all tags for your Elastic Disaster Recovery resources.
  256. */
  257. listTagsForResource(params: Drs.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Drs.Types.ListTagsForResourceResponse) => void): Request<Drs.Types.ListTagsForResourceResponse, AWSError>;
  258. /**
  259. * List all tags for your Elastic Disaster Recovery resources.
  260. */
  261. listTagsForResource(callback?: (err: AWSError, data: Drs.Types.ListTagsForResourceResponse) => void): Request<Drs.Types.ListTagsForResourceResponse, AWSError>;
  262. /**
  263. * Puts a resource launch action.
  264. */
  265. putLaunchAction(params: Drs.Types.PutLaunchActionRequest, callback?: (err: AWSError, data: Drs.Types.PutLaunchActionResponse) => void): Request<Drs.Types.PutLaunchActionResponse, AWSError>;
  266. /**
  267. * Puts a resource launch action.
  268. */
  269. putLaunchAction(callback?: (err: AWSError, data: Drs.Types.PutLaunchActionResponse) => void): Request<Drs.Types.PutLaunchActionResponse, AWSError>;
  270. /**
  271. * WARNING: RetryDataReplication is deprecated. Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state.
  272. */
  273. retryDataReplication(params: Drs.Types.RetryDataReplicationRequest, callback?: (err: AWSError, data: Drs.Types.SourceServer) => void): Request<Drs.Types.SourceServer, AWSError>;
  274. /**
  275. * WARNING: RetryDataReplication is deprecated. Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state.
  276. */
  277. retryDataReplication(callback?: (err: AWSError, data: Drs.Types.SourceServer) => void): Request<Drs.Types.SourceServer, AWSError>;
  278. /**
  279. * Start replication to origin / target region - applies only to protected instances that originated in EC2. For recovery instances on target region - starts replication back to origin region. For failback instances on origin region - starts replication to target region to re-protect them.
  280. */
  281. reverseReplication(params: Drs.Types.ReverseReplicationRequest, callback?: (err: AWSError, data: Drs.Types.ReverseReplicationResponse) => void): Request<Drs.Types.ReverseReplicationResponse, AWSError>;
  282. /**
  283. * Start replication to origin / target region - applies only to protected instances that originated in EC2. For recovery instances on target region - starts replication back to origin region. For failback instances on origin region - starts replication to target region to re-protect them.
  284. */
  285. reverseReplication(callback?: (err: AWSError, data: Drs.Types.ReverseReplicationResponse) => void): Request<Drs.Types.ReverseReplicationResponse, AWSError>;
  286. /**
  287. * Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance. This will run conversion on the failback client and will reboot your machine, thus completing the failback process.
  288. */
  289. startFailbackLaunch(params: Drs.Types.StartFailbackLaunchRequest, callback?: (err: AWSError, data: Drs.Types.StartFailbackLaunchResponse) => void): Request<Drs.Types.StartFailbackLaunchResponse, AWSError>;
  290. /**
  291. * Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance. This will run conversion on the failback client and will reboot your machine, thus completing the failback process.
  292. */
  293. startFailbackLaunch(callback?: (err: AWSError, data: Drs.Types.StartFailbackLaunchResponse) => void): Request<Drs.Types.StartFailbackLaunchResponse, AWSError>;
  294. /**
  295. * Launches Recovery Instances for the specified Source Servers. For each Source Server you may choose a point in time snapshot to launch from, or use an on demand snapshot.
  296. */
  297. startRecovery(params: Drs.Types.StartRecoveryRequest, callback?: (err: AWSError, data: Drs.Types.StartRecoveryResponse) => void): Request<Drs.Types.StartRecoveryResponse, AWSError>;
  298. /**
  299. * Launches Recovery Instances for the specified Source Servers. For each Source Server you may choose a point in time snapshot to launch from, or use an on demand snapshot.
  300. */
  301. startRecovery(callback?: (err: AWSError, data: Drs.Types.StartRecoveryResponse) => void): Request<Drs.Types.StartRecoveryResponse, AWSError>;
  302. /**
  303. * Starts replication for a stopped Source Server. This action would make the Source Server protected again and restart billing for it.
  304. */
  305. startReplication(params: Drs.Types.StartReplicationRequest, callback?: (err: AWSError, data: Drs.Types.StartReplicationResponse) => void): Request<Drs.Types.StartReplicationResponse, AWSError>;
  306. /**
  307. * Starts replication for a stopped Source Server. This action would make the Source Server protected again and restart billing for it.
  308. */
  309. startReplication(callback?: (err: AWSError, data: Drs.Types.StartReplicationResponse) => void): Request<Drs.Types.StartReplicationResponse, AWSError>;
  310. /**
  311. * Deploy VPC for the specified Source Network and modify launch templates to use this network. The VPC will be deployed using a dedicated CloudFormation stack.
  312. */
  313. startSourceNetworkRecovery(params: Drs.Types.StartSourceNetworkRecoveryRequest, callback?: (err: AWSError, data: Drs.Types.StartSourceNetworkRecoveryResponse) => void): Request<Drs.Types.StartSourceNetworkRecoveryResponse, AWSError>;
  314. /**
  315. * Deploy VPC for the specified Source Network and modify launch templates to use this network. The VPC will be deployed using a dedicated CloudFormation stack.
  316. */
  317. startSourceNetworkRecovery(callback?: (err: AWSError, data: Drs.Types.StartSourceNetworkRecoveryResponse) => void): Request<Drs.Types.StartSourceNetworkRecoveryResponse, AWSError>;
  318. /**
  319. * Starts replication for a Source Network. This action would make the Source Network protected.
  320. */
  321. startSourceNetworkReplication(params: Drs.Types.StartSourceNetworkReplicationRequest, callback?: (err: AWSError, data: Drs.Types.StartSourceNetworkReplicationResponse) => void): Request<Drs.Types.StartSourceNetworkReplicationResponse, AWSError>;
  322. /**
  323. * Starts replication for a Source Network. This action would make the Source Network protected.
  324. */
  325. startSourceNetworkReplication(callback?: (err: AWSError, data: Drs.Types.StartSourceNetworkReplicationResponse) => void): Request<Drs.Types.StartSourceNetworkReplicationResponse, AWSError>;
  326. /**
  327. * Stops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED.
  328. */
  329. stopFailback(params: Drs.Types.StopFailbackRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  330. /**
  331. * Stops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED.
  332. */
  333. stopFailback(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  334. /**
  335. * Stops replication for a Source Server. This action would make the Source Server unprotected, delete its existing snapshots and stop billing for it.
  336. */
  337. stopReplication(params: Drs.Types.StopReplicationRequest, callback?: (err: AWSError, data: Drs.Types.StopReplicationResponse) => void): Request<Drs.Types.StopReplicationResponse, AWSError>;
  338. /**
  339. * Stops replication for a Source Server. This action would make the Source Server unprotected, delete its existing snapshots and stop billing for it.
  340. */
  341. stopReplication(callback?: (err: AWSError, data: Drs.Types.StopReplicationResponse) => void): Request<Drs.Types.StopReplicationResponse, AWSError>;
  342. /**
  343. * Stops replication for a Source Network. This action would make the Source Network unprotected.
  344. */
  345. stopSourceNetworkReplication(params: Drs.Types.StopSourceNetworkReplicationRequest, callback?: (err: AWSError, data: Drs.Types.StopSourceNetworkReplicationResponse) => void): Request<Drs.Types.StopSourceNetworkReplicationResponse, AWSError>;
  346. /**
  347. * Stops replication for a Source Network. This action would make the Source Network unprotected.
  348. */
  349. stopSourceNetworkReplication(callback?: (err: AWSError, data: Drs.Types.StopSourceNetworkReplicationResponse) => void): Request<Drs.Types.StopSourceNetworkReplicationResponse, AWSError>;
  350. /**
  351. * Adds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.
  352. */
  353. tagResource(params: Drs.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  354. /**
  355. * Adds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.
  356. */
  357. tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  358. /**
  359. * Initiates a Job for terminating the EC2 resources associated with the specified Recovery Instances, and then will delete the Recovery Instances from the Elastic Disaster Recovery service.
  360. */
  361. terminateRecoveryInstances(params: Drs.Types.TerminateRecoveryInstancesRequest, callback?: (err: AWSError, data: Drs.Types.TerminateRecoveryInstancesResponse) => void): Request<Drs.Types.TerminateRecoveryInstancesResponse, AWSError>;
  362. /**
  363. * Initiates a Job for terminating the EC2 resources associated with the specified Recovery Instances, and then will delete the Recovery Instances from the Elastic Disaster Recovery service.
  364. */
  365. terminateRecoveryInstances(callback?: (err: AWSError, data: Drs.Types.TerminateRecoveryInstancesResponse) => void): Request<Drs.Types.TerminateRecoveryInstancesResponse, AWSError>;
  366. /**
  367. * Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.
  368. */
  369. untagResource(params: Drs.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  370. /**
  371. * Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.
  372. */
  373. untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  374. /**
  375. * Allows you to update the failback replication configuration of a Recovery Instance by ID.
  376. */
  377. updateFailbackReplicationConfiguration(params: Drs.Types.UpdateFailbackReplicationConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  378. /**
  379. * Allows you to update the failback replication configuration of a Recovery Instance by ID.
  380. */
  381. updateFailbackReplicationConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  382. /**
  383. * Updates a LaunchConfiguration by Source Server ID.
  384. */
  385. updateLaunchConfiguration(params: Drs.Types.UpdateLaunchConfigurationRequest, callback?: (err: AWSError, data: Drs.Types.LaunchConfiguration) => void): Request<Drs.Types.LaunchConfiguration, AWSError>;
  386. /**
  387. * Updates a LaunchConfiguration by Source Server ID.
  388. */
  389. updateLaunchConfiguration(callback?: (err: AWSError, data: Drs.Types.LaunchConfiguration) => void): Request<Drs.Types.LaunchConfiguration, AWSError>;
  390. /**
  391. * Updates an existing Launch Configuration Template by ID.
  392. */
  393. updateLaunchConfigurationTemplate(params: Drs.Types.UpdateLaunchConfigurationTemplateRequest, callback?: (err: AWSError, data: Drs.Types.UpdateLaunchConfigurationTemplateResponse) => void): Request<Drs.Types.UpdateLaunchConfigurationTemplateResponse, AWSError>;
  394. /**
  395. * Updates an existing Launch Configuration Template by ID.
  396. */
  397. updateLaunchConfigurationTemplate(callback?: (err: AWSError, data: Drs.Types.UpdateLaunchConfigurationTemplateResponse) => void): Request<Drs.Types.UpdateLaunchConfigurationTemplateResponse, AWSError>;
  398. /**
  399. * Allows you to update a ReplicationConfiguration by Source Server ID.
  400. */
  401. updateReplicationConfiguration(params: Drs.Types.UpdateReplicationConfigurationRequest, callback?: (err: AWSError, data: Drs.Types.ReplicationConfiguration) => void): Request<Drs.Types.ReplicationConfiguration, AWSError>;
  402. /**
  403. * Allows you to update a ReplicationConfiguration by Source Server ID.
  404. */
  405. updateReplicationConfiguration(callback?: (err: AWSError, data: Drs.Types.ReplicationConfiguration) => void): Request<Drs.Types.ReplicationConfiguration, AWSError>;
  406. /**
  407. * Updates a ReplicationConfigurationTemplate by ID.
  408. */
  409. updateReplicationConfigurationTemplate(params: Drs.Types.UpdateReplicationConfigurationTemplateRequest, callback?: (err: AWSError, data: Drs.Types.ReplicationConfigurationTemplate) => void): Request<Drs.Types.ReplicationConfigurationTemplate, AWSError>;
  410. /**
  411. * Updates a ReplicationConfigurationTemplate by ID.
  412. */
  413. updateReplicationConfigurationTemplate(callback?: (err: AWSError, data: Drs.Types.ReplicationConfigurationTemplate) => void): Request<Drs.Types.ReplicationConfigurationTemplate, AWSError>;
  414. }
  415. declare namespace Drs {
  416. export type ARN = string;
  417. export interface Account {
  418. /**
  419. * Account ID of AWS account.
  420. */
  421. accountID?: AccountID;
  422. }
  423. export type AccountID = string;
  424. export type AccountIDs = AccountID[];
  425. export type Accounts = Account[];
  426. export type AgentVersion = string;
  427. export interface AssociateSourceNetworkStackRequest {
  428. /**
  429. * CloudFormation template to associate with a Source Network.
  430. */
  431. cfnStackName: CfnStackName;
  432. /**
  433. * The Source Network ID to associate with CloudFormation template.
  434. */
  435. sourceNetworkID: SourceNetworkID;
  436. }
  437. export interface AssociateSourceNetworkStackResponse {
  438. /**
  439. * The Source Network association Job.
  440. */
  441. job?: Job;
  442. }
  443. export type AwsAvailabilityZone = string;
  444. export type AwsRegion = string;
  445. export type Boolean = boolean;
  446. export type BoundedString = string;
  447. export interface CPU {
  448. /**
  449. * The number of CPU cores.
  450. */
  451. cores?: PositiveInteger;
  452. /**
  453. * The model name of the CPU.
  454. */
  455. modelName?: BoundedString;
  456. }
  457. export type CfnStackName = string;
  458. export type ConversionMap = {[key: string]: EbsSnapshot};
  459. export interface ConversionProperties {
  460. /**
  461. * The timestamp of when the snapshot being converted was taken
  462. */
  463. dataTimestamp?: LargeBoundedString;
  464. /**
  465. * Whether the volume being converted uses UEFI or not
  466. */
  467. forceUefi?: Boolean;
  468. /**
  469. * The root volume name of a conversion job
  470. */
  471. rootVolumeName?: LargeBoundedString;
  472. /**
  473. * A mapping between the volumes being converted and the converted snapshot ids
  474. */
  475. volumeToConversionMap?: VolumeToConversionMap;
  476. /**
  477. * A mapping between the volumes being converted and the product codes associated with them
  478. */
  479. volumeToProductCodes?: VolumeToProductCodes;
  480. /**
  481. * A mapping between the volumes and their sizes
  482. */
  483. volumeToVolumeSize?: VolumeToSizeMap;
  484. }
  485. export type Cpus = CPU[];
  486. export interface CreateExtendedSourceServerRequest {
  487. /**
  488. * This defines the ARN of the source server in staging Account based on which you want to create an extended source server.
  489. */
  490. sourceServerArn: SourceServerARN;
  491. /**
  492. * A list of tags associated with the extended source server.
  493. */
  494. tags?: TagsMap;
  495. }
  496. export interface CreateExtendedSourceServerResponse {
  497. /**
  498. * Created extended source server.
  499. */
  500. sourceServer?: SourceServer;
  501. }
  502. export interface CreateLaunchConfigurationTemplateRequest {
  503. /**
  504. * Copy private IP.
  505. */
  506. copyPrivateIp?: Boolean;
  507. /**
  508. * Copy tags.
  509. */
  510. copyTags?: Boolean;
  511. /**
  512. * S3 bucket ARN to export Source Network templates.
  513. */
  514. exportBucketArn?: ARN;
  515. /**
  516. * Launch disposition.
  517. */
  518. launchDisposition?: LaunchDisposition;
  519. /**
  520. * DRS will set the 'launch into instance ID' of any source server when performing a drill, recovery or failback to the previous region or availability zone, using the instance ID of the source instance.
  521. */
  522. launchIntoSourceInstance?: Boolean;
  523. /**
  524. * Licensing.
  525. */
  526. licensing?: Licensing;
  527. /**
  528. * Whether we want to activate post-launch actions.
  529. */
  530. postLaunchEnabled?: Boolean;
  531. /**
  532. * Request to associate tags during creation of a Launch Configuration Template.
  533. */
  534. tags?: TagsMap;
  535. /**
  536. * Target instance type right-sizing method.
  537. */
  538. targetInstanceTypeRightSizingMethod?: TargetInstanceTypeRightSizingMethod;
  539. }
  540. export interface CreateLaunchConfigurationTemplateResponse {
  541. /**
  542. * Created Launch Configuration Template.
  543. */
  544. launchConfigurationTemplate?: LaunchConfigurationTemplate;
  545. }
  546. export interface CreateReplicationConfigurationTemplateRequest {
  547. /**
  548. * Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
  549. */
  550. associateDefaultSecurityGroup: Boolean;
  551. /**
  552. * Whether to allow the AWS replication agent to automatically replicate newly added disks.
  553. */
  554. autoReplicateNewDisks?: Boolean;
  555. /**
  556. * Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
  557. */
  558. bandwidthThrottling: PositiveInteger;
  559. /**
  560. * Whether to create a Public IP for the Recovery Instance by default.
  561. */
  562. createPublicIP: Boolean;
  563. /**
  564. * The data plane routing mechanism that will be used for replication.
  565. */
  566. dataPlaneRouting: ReplicationConfigurationDataPlaneRouting;
  567. /**
  568. * The Staging Disk EBS volume type to be used during replication.
  569. */
  570. defaultLargeStagingDiskType: ReplicationConfigurationDefaultLargeStagingDiskType;
  571. /**
  572. * The type of EBS encryption to be used during replication.
  573. */
  574. ebsEncryption: ReplicationConfigurationEbsEncryption;
  575. /**
  576. * The ARN of the EBS encryption key to be used during replication.
  577. */
  578. ebsEncryptionKeyArn?: ARN;
  579. /**
  580. * The Point in time (PIT) policy to manage snapshots taken during replication.
  581. */
  582. pitPolicy: PITPolicy;
  583. /**
  584. * The instance type to be used for the replication server.
  585. */
  586. replicationServerInstanceType: EC2InstanceType;
  587. /**
  588. * The security group IDs that will be used by the replication server.
  589. */
  590. replicationServersSecurityGroupsIDs: ReplicationServersSecurityGroupsIDs;
  591. /**
  592. * The subnet to be used by the replication staging area.
  593. */
  594. stagingAreaSubnetId: SubnetID;
  595. /**
  596. * A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
  597. */
  598. stagingAreaTags: TagsMap;
  599. /**
  600. * A set of tags to be associated with the Replication Configuration Template resource.
  601. */
  602. tags?: TagsMap;
  603. /**
  604. * Whether to use a dedicated Replication Server in the replication staging area.
  605. */
  606. useDedicatedReplicationServer: Boolean;
  607. }
  608. export interface CreateSourceNetworkRequest {
  609. /**
  610. * Account containing the VPC to protect.
  611. */
  612. originAccountID: AccountID;
  613. /**
  614. * Region containing the VPC to protect.
  615. */
  616. originRegion: AwsRegion;
  617. /**
  618. * A set of tags to be associated with the Source Network resource.
  619. */
  620. tags?: TagsMap;
  621. /**
  622. * Which VPC ID to protect.
  623. */
  624. vpcID: VpcID;
  625. }
  626. export interface CreateSourceNetworkResponse {
  627. /**
  628. * ID of the created Source Network.
  629. */
  630. sourceNetworkID?: SourceNetworkID;
  631. }
  632. export interface DataReplicationError {
  633. /**
  634. * Error in data replication.
  635. */
  636. error?: DataReplicationErrorString;
  637. /**
  638. * Error in data replication.
  639. */
  640. rawError?: LargeBoundedString;
  641. }
  642. export type DataReplicationErrorString = "AGENT_NOT_SEEN"|"SNAPSHOTS_FAILURE"|"NOT_CONVERGING"|"UNSTABLE_NETWORK"|"FAILED_TO_CREATE_SECURITY_GROUP"|"FAILED_TO_LAUNCH_REPLICATION_SERVER"|"FAILED_TO_BOOT_REPLICATION_SERVER"|"FAILED_TO_AUTHENTICATE_WITH_SERVICE"|"FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE"|"FAILED_TO_CREATE_STAGING_DISKS"|"FAILED_TO_ATTACH_STAGING_DISKS"|"FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT"|"FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER"|"FAILED_TO_START_DATA_TRANSFER"|string;
  643. export interface DataReplicationInfo {
  644. /**
  645. * Error in data replication.
  646. */
  647. dataReplicationError?: DataReplicationError;
  648. /**
  649. * Information about whether the data replication has been initiated.
  650. */
  651. dataReplicationInitiation?: DataReplicationInitiation;
  652. /**
  653. * The state of the data replication.
  654. */
  655. dataReplicationState?: DataReplicationState;
  656. /**
  657. * An estimate of when the data replication will be completed.
  658. */
  659. etaDateTime?: ISO8601DatetimeString;
  660. /**
  661. * Data replication lag duration.
  662. */
  663. lagDuration?: ISO8601DurationString;
  664. /**
  665. * The disks that should be replicated.
  666. */
  667. replicatedDisks?: DataReplicationInfoReplicatedDisks;
  668. /**
  669. * AWS Availability zone into which data is being replicated.
  670. */
  671. stagingAvailabilityZone?: AwsAvailabilityZone;
  672. /**
  673. * The ARN of the staging Outpost
  674. */
  675. stagingOutpostArn?: OutpostARN;
  676. }
  677. export interface DataReplicationInfoReplicatedDisk {
  678. /**
  679. * The size of the replication backlog in bytes.
  680. */
  681. backloggedStorageBytes?: PositiveInteger;
  682. /**
  683. * The name of the device.
  684. */
  685. deviceName?: BoundedString;
  686. /**
  687. * The amount of data replicated so far in bytes.
  688. */
  689. replicatedStorageBytes?: PositiveInteger;
  690. /**
  691. * The amount of data to be rescanned in bytes.
  692. */
  693. rescannedStorageBytes?: PositiveInteger;
  694. /**
  695. * The total amount of data to be replicated in bytes.
  696. */
  697. totalStorageBytes?: PositiveInteger;
  698. /**
  699. * The status of the volume.
  700. */
  701. volumeStatus?: VolumeStatus;
  702. }
  703. export type DataReplicationInfoReplicatedDisks = DataReplicationInfoReplicatedDisk[];
  704. export interface DataReplicationInitiation {
  705. /**
  706. * The date and time of the next attempt to initiate data replication.
  707. */
  708. nextAttemptDateTime?: ISO8601DatetimeString;
  709. /**
  710. * The date and time of the current attempt to initiate data replication.
  711. */
  712. startDateTime?: ISO8601DatetimeString;
  713. /**
  714. * The steps of the current attempt to initiate data replication.
  715. */
  716. steps?: DataReplicationInitiationSteps;
  717. }
  718. export interface DataReplicationInitiationStep {
  719. /**
  720. * The name of the step.
  721. */
  722. name?: DataReplicationInitiationStepName;
  723. /**
  724. * The status of the step.
  725. */
  726. status?: DataReplicationInitiationStepStatus;
  727. }
  728. export type DataReplicationInitiationStepName = "WAIT"|"CREATE_SECURITY_GROUP"|"LAUNCH_REPLICATION_SERVER"|"BOOT_REPLICATION_SERVER"|"AUTHENTICATE_WITH_SERVICE"|"DOWNLOAD_REPLICATION_SOFTWARE"|"CREATE_STAGING_DISKS"|"ATTACH_STAGING_DISKS"|"PAIR_REPLICATION_SERVER_WITH_AGENT"|"CONNECT_AGENT_TO_REPLICATION_SERVER"|"START_DATA_TRANSFER"|string;
  729. export type DataReplicationInitiationStepStatus = "NOT_STARTED"|"IN_PROGRESS"|"SUCCEEDED"|"FAILED"|"SKIPPED"|string;
  730. export type DataReplicationInitiationSteps = DataReplicationInitiationStep[];
  731. export type DataReplicationState = "STOPPED"|"INITIATING"|"INITIAL_SYNC"|"BACKLOG"|"CREATING_SNAPSHOT"|"CONTINUOUS"|"PAUSED"|"RESCAN"|"STALLED"|"DISCONNECTED"|string;
  732. export interface DeleteJobRequest {
  733. /**
  734. * The ID of the Job to be deleted.
  735. */
  736. jobID: JobID;
  737. }
  738. export interface DeleteJobResponse {
  739. }
  740. export interface DeleteLaunchActionRequest {
  741. actionId: LaunchActionId;
  742. resourceId: LaunchActionResourceId;
  743. }
  744. export interface DeleteLaunchActionResponse {
  745. }
  746. export interface DeleteLaunchConfigurationTemplateRequest {
  747. /**
  748. * The ID of the Launch Configuration Template to be deleted.
  749. */
  750. launchConfigurationTemplateID: LaunchConfigurationTemplateID;
  751. }
  752. export interface DeleteLaunchConfigurationTemplateResponse {
  753. }
  754. export interface DeleteRecoveryInstanceRequest {
  755. /**
  756. * The ID of the Recovery Instance to be deleted.
  757. */
  758. recoveryInstanceID: RecoveryInstanceID;
  759. }
  760. export interface DeleteReplicationConfigurationTemplateRequest {
  761. /**
  762. * The ID of the Replication Configuration Template to be deleted.
  763. */
  764. replicationConfigurationTemplateID: ReplicationConfigurationTemplateID;
  765. }
  766. export interface DeleteReplicationConfigurationTemplateResponse {
  767. }
  768. export interface DeleteSourceNetworkRequest {
  769. /**
  770. * ID of the Source Network to delete.
  771. */
  772. sourceNetworkID: SourceNetworkID;
  773. }
  774. export interface DeleteSourceNetworkResponse {
  775. }
  776. export interface DeleteSourceServerRequest {
  777. /**
  778. * The ID of the Source Server to be deleted.
  779. */
  780. sourceServerID: SourceServerID;
  781. }
  782. export interface DeleteSourceServerResponse {
  783. }
  784. export interface DescribeJobLogItemsRequest {
  785. /**
  786. * The ID of the Job for which Job log items will be retrieved.
  787. */
  788. jobID: JobID;
  789. /**
  790. * Maximum number of Job log items to retrieve.
  791. */
  792. maxResults?: StrictlyPositiveInteger;
  793. /**
  794. * The token of the next Job log items to retrieve.
  795. */
  796. nextToken?: PaginationToken;
  797. }
  798. export interface DescribeJobLogItemsResponse {
  799. /**
  800. * An array of Job log items.
  801. */
  802. items?: JobLogs;
  803. /**
  804. * The token of the next Job log items to retrieve.
  805. */
  806. nextToken?: PaginationToken;
  807. }
  808. export interface DescribeJobsRequest {
  809. /**
  810. * A set of filters by which to return Jobs.
  811. */
  812. filters?: DescribeJobsRequestFilters;
  813. /**
  814. * Maximum number of Jobs to retrieve.
  815. */
  816. maxResults?: StrictlyPositiveInteger;
  817. /**
  818. * The token of the next Job to retrieve.
  819. */
  820. nextToken?: PaginationToken;
  821. }
  822. export interface DescribeJobsRequestFilters {
  823. /**
  824. * The start date in a date range query.
  825. */
  826. fromDate?: ISO8601DatetimeString;
  827. /**
  828. * An array of Job IDs that should be returned. An empty array means all jobs.
  829. */
  830. jobIDs?: DescribeJobsRequestFiltersJobIDs;
  831. /**
  832. * The end date in a date range query.
  833. */
  834. toDate?: ISO8601DatetimeString;
  835. }
  836. export type DescribeJobsRequestFiltersJobIDs = JobID[];
  837. export interface DescribeJobsResponse {
  838. /**
  839. * An array of Jobs.
  840. */
  841. items?: JobsList;
  842. /**
  843. * The token of the next Job to retrieve.
  844. */
  845. nextToken?: PaginationToken;
  846. }
  847. export interface DescribeLaunchConfigurationTemplatesRequest {
  848. /**
  849. * Request to filter Launch Configuration Templates list by Launch Configuration Template ID.
  850. */
  851. launchConfigurationTemplateIDs?: LaunchConfigurationTemplateIDs;
  852. /**
  853. * Maximum results to be returned in DescribeLaunchConfigurationTemplates.
  854. */
  855. maxResults?: MaxResultsType;
  856. /**
  857. * The token of the next Launch Configuration Template to retrieve.
  858. */
  859. nextToken?: PaginationToken;
  860. }
  861. export interface DescribeLaunchConfigurationTemplatesResponse {
  862. /**
  863. * List of items returned by DescribeLaunchConfigurationTemplates.
  864. */
  865. items?: LaunchConfigurationTemplates;
  866. /**
  867. * The token of the next Launch Configuration Template to retrieve.
  868. */
  869. nextToken?: PaginationToken;
  870. }
  871. export type DescribeRecoveryInstancesItems = RecoveryInstance[];
  872. export interface DescribeRecoveryInstancesRequest {
  873. /**
  874. * A set of filters by which to return Recovery Instances.
  875. */
  876. filters?: DescribeRecoveryInstancesRequestFilters;
  877. /**
  878. * Maximum number of Recovery Instances to retrieve.
  879. */
  880. maxResults?: StrictlyPositiveInteger;
  881. /**
  882. * The token of the next Recovery Instance to retrieve.
  883. */
  884. nextToken?: PaginationToken;
  885. }
  886. export interface DescribeRecoveryInstancesRequestFilters {
  887. /**
  888. * An array of Recovery Instance IDs that should be returned. An empty array means all Recovery Instances.
  889. */
  890. recoveryInstanceIDs?: RecoveryInstanceIDs;
  891. /**
  892. * An array of Source Server IDs for which associated Recovery Instances should be returned.
  893. */
  894. sourceServerIDs?: SourceServerIDs;
  895. }
  896. export interface DescribeRecoveryInstancesResponse {
  897. /**
  898. * An array of Recovery Instances.
  899. */
  900. items?: DescribeRecoveryInstancesItems;
  901. /**
  902. * The token of the next Recovery Instance to retrieve.
  903. */
  904. nextToken?: PaginationToken;
  905. }
  906. export interface DescribeRecoverySnapshotsRequest {
  907. /**
  908. * A set of filters by which to return Recovery Snapshots.
  909. */
  910. filters?: DescribeRecoverySnapshotsRequestFilters;
  911. /**
  912. * Maximum number of Recovery Snapshots to retrieve.
  913. */
  914. maxResults?: StrictlyPositiveInteger;
  915. /**
  916. * The token of the next Recovery Snapshot to retrieve.
  917. */
  918. nextToken?: PaginationToken;
  919. /**
  920. * The sorted ordering by which to return Recovery Snapshots.
  921. */
  922. order?: RecoverySnapshotsOrder;
  923. /**
  924. * Filter Recovery Snapshots by Source Server ID.
  925. */
  926. sourceServerID: SourceServerID;
  927. }
  928. export interface DescribeRecoverySnapshotsRequestFilters {
  929. /**
  930. * The start date in a date range query.
  931. */
  932. fromDateTime?: ISO8601DatetimeString;
  933. /**
  934. * The end date in a date range query.
  935. */
  936. toDateTime?: ISO8601DatetimeString;
  937. }
  938. export interface DescribeRecoverySnapshotsResponse {
  939. /**
  940. * An array of Recovery Snapshots.
  941. */
  942. items?: RecoverySnapshotsList;
  943. /**
  944. * The token of the next Recovery Snapshot to retrieve.
  945. */
  946. nextToken?: PaginationToken;
  947. }
  948. export interface DescribeReplicationConfigurationTemplatesRequest {
  949. /**
  950. * Maximum number of Replication Configuration Templates to retrieve.
  951. */
  952. maxResults?: StrictlyPositiveInteger;
  953. /**
  954. * The token of the next Replication Configuration Template to retrieve.
  955. */
  956. nextToken?: PaginationToken;
  957. /**
  958. * The IDs of the Replication Configuration Templates to retrieve. An empty list means all Replication Configuration Templates.
  959. */
  960. replicationConfigurationTemplateIDs?: ReplicationConfigurationTemplateIDs;
  961. }
  962. export interface DescribeReplicationConfigurationTemplatesResponse {
  963. /**
  964. * An array of Replication Configuration Templates.
  965. */
  966. items?: ReplicationConfigurationTemplates;
  967. /**
  968. * The token of the next Replication Configuration Template to retrieve.
  969. */
  970. nextToken?: PaginationToken;
  971. }
  972. export interface DescribeSourceNetworksRequest {
  973. /**
  974. * A set of filters by which to return Source Networks.
  975. */
  976. filters?: DescribeSourceNetworksRequestFilters;
  977. /**
  978. * Maximum number of Source Networks to retrieve.
  979. */
  980. maxResults?: StrictlyPositiveInteger;
  981. /**
  982. * The token of the next Source Networks to retrieve.
  983. */
  984. nextToken?: PaginationToken;
  985. }
  986. export interface DescribeSourceNetworksRequestFilters {
  987. /**
  988. * Filter Source Networks by account ID containing the protected VPCs.
  989. */
  990. originAccountID?: AccountID;
  991. /**
  992. * Filter Source Networks by the region containing the protected VPCs.
  993. */
  994. originRegion?: AwsRegion;
  995. /**
  996. * An array of Source Network IDs that should be returned. An empty array means all Source Networks.
  997. */
  998. sourceNetworkIDs?: DescribeSourceNetworksRequestFiltersIDs;
  999. }
  1000. export type DescribeSourceNetworksRequestFiltersIDs = SourceNetworkID[];
  1001. export interface DescribeSourceNetworksResponse {
  1002. /**
  1003. * An array of Source Networks.
  1004. */
  1005. items?: SourceNetworksList;
  1006. /**
  1007. * The token of the next Source Networks to retrieve.
  1008. */
  1009. nextToken?: PaginationToken;
  1010. }
  1011. export interface DescribeSourceServersRequest {
  1012. /**
  1013. * A set of filters by which to return Source Servers.
  1014. */
  1015. filters?: DescribeSourceServersRequestFilters;
  1016. /**
  1017. * Maximum number of Source Servers to retrieve.
  1018. */
  1019. maxResults?: StrictlyPositiveInteger;
  1020. /**
  1021. * The token of the next Source Server to retrieve.
  1022. */
  1023. nextToken?: PaginationToken;
  1024. }
  1025. export interface DescribeSourceServersRequestFilters {
  1026. /**
  1027. * An ID that describes the hardware of the Source Server. This is either an EC2 instance id, a VMware uuid or a mac address.
  1028. */
  1029. hardwareId?: BoundedString;
  1030. /**
  1031. * An array of Source Servers IDs that should be returned. An empty array means all Source Servers.
  1032. */
  1033. sourceServerIDs?: DescribeSourceServersRequestFiltersIDs;
  1034. /**
  1035. * An array of staging account IDs that extended source servers belong to. An empty array means all source servers will be shown.
  1036. */
  1037. stagingAccountIDs?: AccountIDs;
  1038. }
  1039. export type DescribeSourceServersRequestFiltersIDs = SourceServerID[];
  1040. export interface DescribeSourceServersResponse {
  1041. /**
  1042. * An array of Source Servers.
  1043. */
  1044. items?: SourceServersList;
  1045. /**
  1046. * The token of the next Source Server to retrieve.
  1047. */
  1048. nextToken?: PaginationToken;
  1049. }
  1050. export interface DisconnectRecoveryInstanceRequest {
  1051. /**
  1052. * The ID of the Recovery Instance to disconnect.
  1053. */
  1054. recoveryInstanceID: RecoveryInstanceID;
  1055. }
  1056. export interface DisconnectSourceServerRequest {
  1057. /**
  1058. * The ID of the Source Server to disconnect.
  1059. */
  1060. sourceServerID: SourceServerID;
  1061. }
  1062. export interface Disk {
  1063. /**
  1064. * The amount of storage on the disk in bytes.
  1065. */
  1066. bytes?: PositiveInteger;
  1067. /**
  1068. * The disk or device name.
  1069. */
  1070. deviceName?: BoundedString;
  1071. }
  1072. export type Disks = Disk[];
  1073. export type EC2InstanceID = string;
  1074. export type EC2InstanceState = "PENDING"|"RUNNING"|"STOPPING"|"STOPPED"|"SHUTTING-DOWN"|"TERMINATED"|"NOT_FOUND"|string;
  1075. export type EC2InstanceType = string;
  1076. export type EbsSnapshot = string;
  1077. export type EbsSnapshotsList = EbsSnapshot[];
  1078. export type EbsVolumeID = string;
  1079. export interface EventResourceData {
  1080. /**
  1081. * Source Network properties.
  1082. */
  1083. sourceNetworkData?: SourceNetworkData;
  1084. }
  1085. export interface ExportSourceNetworkCfnTemplateRequest {
  1086. /**
  1087. * The Source Network ID to export its CloudFormation template to an S3 bucket.
  1088. */
  1089. sourceNetworkID: SourceNetworkID;
  1090. }
  1091. export interface ExportSourceNetworkCfnTemplateResponse {
  1092. /**
  1093. * S3 bucket URL where the Source Network CloudFormation template was exported to.
  1094. */
  1095. s3DestinationUrl?: LargeBoundedString;
  1096. }
  1097. export type ExtensionStatus = "EXTENDED"|"EXTENSION_ERROR"|"NOT_EXTENDED"|string;
  1098. export type FailbackLaunchType = "RECOVERY"|"DRILL"|string;
  1099. export type FailbackReplicationError = "AGENT_NOT_SEEN"|"FAILBACK_CLIENT_NOT_SEEN"|"NOT_CONVERGING"|"UNSTABLE_NETWORK"|"FAILED_TO_ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION"|"FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT"|"FAILED_TO_CONFIGURE_REPLICATION_SOFTWARE"|"FAILED_TO_PAIR_AGENT_WITH_REPLICATION_SOFTWARE"|"FAILED_TO_ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION"|"FAILED_GETTING_REPLICATION_STATE"|"SNAPSHOTS_FAILURE"|"FAILED_TO_CREATE_SECURITY_GROUP"|"FAILED_TO_LAUNCH_REPLICATION_SERVER"|"FAILED_TO_BOOT_REPLICATION_SERVER"|"FAILED_TO_AUTHENTICATE_WITH_SERVICE"|"FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE"|"FAILED_TO_CREATE_STAGING_DISKS"|"FAILED_TO_ATTACH_STAGING_DISKS"|"FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT"|"FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER"|"FAILED_TO_START_DATA_TRANSFER"|string;
  1100. export type FailbackState = "FAILBACK_NOT_STARTED"|"FAILBACK_IN_PROGRESS"|"FAILBACK_READY_FOR_LAUNCH"|"FAILBACK_COMPLETED"|"FAILBACK_ERROR"|"FAILBACK_NOT_READY_FOR_LAUNCH"|"FAILBACK_LAUNCH_STATE_NOT_AVAILABLE"|string;
  1101. export type FailureReason = string;
  1102. export interface GetFailbackReplicationConfigurationRequest {
  1103. /**
  1104. * The ID of the Recovery Instance whose failback replication configuration should be returned.
  1105. */
  1106. recoveryInstanceID: RecoveryInstanceID;
  1107. }
  1108. export interface GetFailbackReplicationConfigurationResponse {
  1109. /**
  1110. * Configure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.
  1111. */
  1112. bandwidthThrottling?: PositiveInteger;
  1113. /**
  1114. * The name of the Failback Replication Configuration.
  1115. */
  1116. name?: BoundedString;
  1117. /**
  1118. * The ID of the Recovery Instance.
  1119. */
  1120. recoveryInstanceID: RecoveryInstanceID;
  1121. /**
  1122. * Whether to use Private IP for the failback replication of the Recovery Instance.
  1123. */
  1124. usePrivateIP?: Boolean;
  1125. }
  1126. export interface GetLaunchConfigurationRequest {
  1127. /**
  1128. * The ID of the Source Server that we want to retrieve a Launch Configuration for.
  1129. */
  1130. sourceServerID: SourceServerID;
  1131. }
  1132. export interface GetReplicationConfigurationRequest {
  1133. /**
  1134. * The ID of the Source Serve for this Replication Configuration.r
  1135. */
  1136. sourceServerID: SourceServerID;
  1137. }
  1138. export type IPsList = BoundedString[];
  1139. export type ISO8601DatetimeString = string;
  1140. export type ISO8601DurationString = string;
  1141. export interface IdentificationHints {
  1142. /**
  1143. * AWS Instance ID identification hint.
  1144. */
  1145. awsInstanceID?: EC2InstanceID;
  1146. /**
  1147. * Fully Qualified Domain Name identification hint.
  1148. */
  1149. fqdn?: BoundedString;
  1150. /**
  1151. * Hostname identification hint.
  1152. */
  1153. hostname?: BoundedString;
  1154. /**
  1155. * vCenter VM path identification hint.
  1156. */
  1157. vmWareUuid?: BoundedString;
  1158. }
  1159. export interface InitializeServiceRequest {
  1160. }
  1161. export interface InitializeServiceResponse {
  1162. }
  1163. export type InitiatedBy = "START_RECOVERY"|"START_DRILL"|"FAILBACK"|"DIAGNOSTIC"|"TERMINATE_RECOVERY_INSTANCES"|"TARGET_ACCOUNT"|"CREATE_NETWORK_RECOVERY"|"UPDATE_NETWORK_RECOVERY"|"ASSOCIATE_NETWORK_RECOVERY"|string;
  1164. export interface Job {
  1165. /**
  1166. * The ARN of a Job.
  1167. */
  1168. arn?: ARN;
  1169. /**
  1170. * The date and time of when the Job was created.
  1171. */
  1172. creationDateTime?: ISO8601DatetimeString;
  1173. /**
  1174. * The date and time of when the Job ended.
  1175. */
  1176. endDateTime?: ISO8601DatetimeString;
  1177. /**
  1178. * A string representing who initiated the Job.
  1179. */
  1180. initiatedBy?: InitiatedBy;
  1181. /**
  1182. * The ID of the Job.
  1183. */
  1184. jobID: JobID;
  1185. /**
  1186. * A list of resources that the Job is acting upon.
  1187. */
  1188. participatingResources?: ParticipatingResources;
  1189. /**
  1190. * A list of servers that the Job is acting upon.
  1191. */
  1192. participatingServers?: ParticipatingServers;
  1193. /**
  1194. * The status of the Job.
  1195. */
  1196. status?: JobStatus;
  1197. /**
  1198. * A list of tags associated with the Job.
  1199. */
  1200. tags?: TagsMap;
  1201. /**
  1202. * The type of the Job.
  1203. */
  1204. type?: JobType;
  1205. }
  1206. export type JobID = string;
  1207. export interface JobLog {
  1208. /**
  1209. * The event represents the type of a log.
  1210. */
  1211. event?: JobLogEvent;
  1212. /**
  1213. * Metadata associated with a Job log.
  1214. */
  1215. eventData?: JobLogEventData;
  1216. /**
  1217. * The date and time the log was taken.
  1218. */
  1219. logDateTime?: ISO8601DatetimeString;
  1220. }
  1221. export type JobLogEvent = "JOB_START"|"SERVER_SKIPPED"|"CLEANUP_START"|"CLEANUP_END"|"CLEANUP_FAIL"|"SNAPSHOT_START"|"SNAPSHOT_END"|"SNAPSHOT_FAIL"|"USING_PREVIOUS_SNAPSHOT"|"USING_PREVIOUS_SNAPSHOT_FAILED"|"CONVERSION_START"|"CONVERSION_END"|"CONVERSION_FAIL"|"LAUNCH_START"|"LAUNCH_FAILED"|"JOB_CANCEL"|"JOB_END"|"DEPLOY_NETWORK_CONFIGURATION_START"|"DEPLOY_NETWORK_CONFIGURATION_END"|"DEPLOY_NETWORK_CONFIGURATION_FAILED"|"UPDATE_NETWORK_CONFIGURATION_START"|"UPDATE_NETWORK_CONFIGURATION_END"|"UPDATE_NETWORK_CONFIGURATION_FAILED"|"UPDATE_LAUNCH_TEMPLATE_START"|"UPDATE_LAUNCH_TEMPLATE_END"|"UPDATE_LAUNCH_TEMPLATE_FAILED"|"NETWORK_RECOVERY_FAIL"|string;
  1222. export interface JobLogEventData {
  1223. /**
  1224. * Properties of a conversion job
  1225. */
  1226. conversionProperties?: ConversionProperties;
  1227. /**
  1228. * The ID of a conversion server.
  1229. */
  1230. conversionServerID?: EC2InstanceID;
  1231. /**
  1232. * Properties of resource related to a job event.
  1233. */
  1234. eventResourceData?: EventResourceData;
  1235. /**
  1236. * A string representing a job error.
  1237. */
  1238. rawError?: LargeBoundedString;
  1239. /**
  1240. * The ID of a Source Server.
  1241. */
  1242. sourceServerID?: SourceServerID;
  1243. /**
  1244. * The ID of a Recovery Instance.
  1245. */
  1246. targetInstanceID?: EC2InstanceID;
  1247. }
  1248. export type JobLogs = JobLog[];
  1249. export type JobStatus = "PENDING"|"STARTED"|"COMPLETED"|string;
  1250. export type JobType = "LAUNCH"|"TERMINATE"|"CREATE_CONVERTED_SNAPSHOT"|string;
  1251. export type JobsList = Job[];
  1252. export type LargeBoundedString = string;
  1253. export type LastLaunchResult = "NOT_STARTED"|"PENDING"|"SUCCEEDED"|"FAILED"|string;
  1254. export type LastLaunchType = "RECOVERY"|"DRILL"|string;
  1255. export interface LaunchAction {
  1256. /**
  1257. * Launch action code.
  1258. */
  1259. actionCode?: SsmDocumentName;
  1260. actionId?: LaunchActionId;
  1261. actionVersion?: LaunchActionVersion;
  1262. /**
  1263. * Whether the launch action is active.
  1264. */
  1265. active?: Boolean;
  1266. category?: LaunchActionCategory;
  1267. description?: LaunchActionDescription;
  1268. name?: LaunchActionName;
  1269. /**
  1270. * Whether the launch will not be marked as failed if this action fails.
  1271. */
  1272. optional?: Boolean;
  1273. order?: LaunchActionOrder;
  1274. parameters?: LaunchActionParameters;
  1275. /**
  1276. * Launch action type.
  1277. */
  1278. type?: LaunchActionType;
  1279. }
  1280. export type LaunchActionCategory = "MONITORING"|"VALIDATION"|"CONFIGURATION"|"SECURITY"|"OTHER"|string;
  1281. export type LaunchActionDescription = string;
  1282. export type LaunchActionId = string;
  1283. export type LaunchActionIds = LaunchActionId[];
  1284. export type LaunchActionName = string;
  1285. export type LaunchActionOrder = number;
  1286. export interface LaunchActionParameter {
  1287. /**
  1288. * Type.
  1289. */
  1290. type?: LaunchActionParameterType;
  1291. /**
  1292. * Value.
  1293. */
  1294. value?: LaunchActionParameterValue;
  1295. }
  1296. export type LaunchActionParameterName = string;
  1297. export type LaunchActionParameterType = "SSM_STORE"|"DYNAMIC"|string;
  1298. export type LaunchActionParameterValue = string;
  1299. export type LaunchActionParameters = {[key: string]: LaunchActionParameter};
  1300. export type LaunchActionResourceId = string;
  1301. export interface LaunchActionRun {
  1302. /**
  1303. * Action.
  1304. */
  1305. action?: LaunchAction;
  1306. /**
  1307. * Failure reason.
  1308. */
  1309. failureReason?: FailureReason;
  1310. /**
  1311. * Run Id.
  1312. */
  1313. runId?: LaunchActionRunId;
  1314. /**
  1315. * Run status.
  1316. */
  1317. status?: LaunchActionRunStatus;
  1318. }
  1319. export type LaunchActionRunId = string;
  1320. export type LaunchActionRunStatus = "IN_PROGRESS"|"SUCCEEDED"|"FAILED"|string;
  1321. export type LaunchActionRuns = LaunchActionRun[];
  1322. export type LaunchActionType = "SSM_AUTOMATION"|"SSM_COMMAND"|string;
  1323. export type LaunchActionVersion = string;
  1324. export type LaunchActions = LaunchAction[];
  1325. export interface LaunchActionsRequestFilters {
  1326. /**
  1327. * Launch actions Ids.
  1328. */
  1329. actionIds?: LaunchActionIds;
  1330. }
  1331. export interface LaunchActionsStatus {
  1332. /**
  1333. * List of post launch action status.
  1334. */
  1335. runs?: LaunchActionRuns;
  1336. /**
  1337. * Time where the AWS Systems Manager was detected as running on the launched instance.
  1338. */
  1339. ssmAgentDiscoveryDatetime?: ISO8601DatetimeString;
  1340. }
  1341. export interface LaunchConfiguration {
  1342. /**
  1343. * Whether we should copy the Private IP of the Source Server to the Recovery Instance.
  1344. */
  1345. copyPrivateIp?: Boolean;
  1346. /**
  1347. * Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.
  1348. */
  1349. copyTags?: Boolean;
  1350. /**
  1351. * The EC2 launch template ID of this launch configuration.
  1352. */
  1353. ec2LaunchTemplateID?: BoundedString;
  1354. /**
  1355. * The state of the Recovery Instance in EC2 after the recovery operation.
  1356. */
  1357. launchDisposition?: LaunchDisposition;
  1358. /**
  1359. * Launch into existing instance properties.
  1360. */
  1361. launchIntoInstanceProperties?: LaunchIntoInstanceProperties;
  1362. /**
  1363. * The licensing configuration to be used for this launch configuration.
  1364. */
  1365. licensing?: Licensing;
  1366. /**
  1367. * The name of the launch configuration.
  1368. */
  1369. name?: SmallBoundedString;
  1370. /**
  1371. * Whether we want to activate post-launch actions for the Source Server.
  1372. */
  1373. postLaunchEnabled?: Boolean;
  1374. /**
  1375. * The ID of the Source Server for this launch configuration.
  1376. */
  1377. sourceServerID?: SourceServerID;
  1378. /**
  1379. * Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.
  1380. */
  1381. targetInstanceTypeRightSizingMethod?: TargetInstanceTypeRightSizingMethod;
  1382. }
  1383. export interface LaunchConfigurationTemplate {
  1384. /**
  1385. * ARN of the Launch Configuration Template.
  1386. */
  1387. arn?: ARN;
  1388. /**
  1389. * Copy private IP.
  1390. */
  1391. copyPrivateIp?: Boolean;
  1392. /**
  1393. * Copy tags.
  1394. */
  1395. copyTags?: Boolean;
  1396. /**
  1397. * S3 bucket ARN to export Source Network templates.
  1398. */
  1399. exportBucketArn?: ARN;
  1400. /**
  1401. * ID of the Launch Configuration Template.
  1402. */
  1403. launchConfigurationTemplateID?: LaunchConfigurationTemplateID;
  1404. /**
  1405. * Launch disposition.
  1406. */
  1407. launchDisposition?: LaunchDisposition;
  1408. /**
  1409. * DRS will set the 'launch into instance ID' of any source server when performing a drill, recovery or failback to the previous region or availability zone, using the instance ID of the source instance.
  1410. */
  1411. launchIntoSourceInstance?: Boolean;
  1412. /**
  1413. * Licensing.
  1414. */
  1415. licensing?: Licensing;
  1416. /**
  1417. * Post-launch actions activated.
  1418. */
  1419. postLaunchEnabled?: Boolean;
  1420. /**
  1421. * Tags of the Launch Configuration Template.
  1422. */
  1423. tags?: TagsMap;
  1424. /**
  1425. * Target instance type right-sizing method.
  1426. */
  1427. targetInstanceTypeRightSizingMethod?: TargetInstanceTypeRightSizingMethod;
  1428. }
  1429. export type LaunchConfigurationTemplateID = string;
  1430. export type LaunchConfigurationTemplateIDs = LaunchConfigurationTemplateID[];
  1431. export type LaunchConfigurationTemplates = LaunchConfigurationTemplate[];
  1432. export type LaunchDisposition = "STOPPED"|"STARTED"|string;
  1433. export interface LaunchIntoInstanceProperties {
  1434. /**
  1435. * Optionally holds EC2 instance ID of an instance to launch into, instead of launching a new instance during drill, recovery or failback.
  1436. */
  1437. launchIntoEC2InstanceID?: EC2InstanceID;
  1438. }
  1439. export type LaunchStatus = "PENDING"|"IN_PROGRESS"|"LAUNCHED"|"FAILED"|"TERMINATED"|string;
  1440. export interface Licensing {
  1441. /**
  1442. * Whether to enable "Bring your own license" or not.
  1443. */
  1444. osByol?: Boolean;
  1445. }
  1446. export interface LifeCycle {
  1447. /**
  1448. * The date and time of when the Source Server was added to the service.
  1449. */
  1450. addedToServiceDateTime?: ISO8601DatetimeString;
  1451. /**
  1452. * The amount of time that the Source Server has been replicating for.
  1453. */
  1454. elapsedReplicationDuration?: ISO8601DurationString;
  1455. /**
  1456. * The date and time of the first byte that was replicated from the Source Server.
  1457. */
  1458. firstByteDateTime?: ISO8601DatetimeString;
  1459. /**
  1460. * An object containing information regarding the last launch of the Source Server.
  1461. */
  1462. lastLaunch?: LifeCycleLastLaunch;
  1463. /**
  1464. * The date and time this Source Server was last seen by the service.
  1465. */
  1466. lastSeenByServiceDateTime?: ISO8601DatetimeString;
  1467. }
  1468. export interface LifeCycleLastLaunch {
  1469. /**
  1470. * An object containing information regarding the initiation of the last launch of a Source Server.
  1471. */
  1472. initiated?: LifeCycleLastLaunchInitiated;
  1473. /**
  1474. * Status of Source Server's last launch.
  1475. */
  1476. status?: LaunchStatus;
  1477. }
  1478. export interface LifeCycleLastLaunchInitiated {
  1479. /**
  1480. * The date and time the last Source Server launch was initiated.
  1481. */
  1482. apiCallDateTime?: ISO8601DatetimeString;
  1483. /**
  1484. * The ID of the Job that was used to last launch the Source Server.
  1485. */
  1486. jobID?: JobID;
  1487. /**
  1488. * The Job type that was used to last launch the Source Server.
  1489. */
  1490. type?: LastLaunchType;
  1491. }
  1492. export interface ListExtensibleSourceServersRequest {
  1493. /**
  1494. * The maximum number of extensible source servers to retrieve.
  1495. */
  1496. maxResults?: MaxResultsReplicatingSourceServers;
  1497. /**
  1498. * The token of the next extensible source server to retrieve.
  1499. */
  1500. nextToken?: PaginationToken;
  1501. /**
  1502. * The Id of the staging Account to retrieve extensible source servers from.
  1503. */
  1504. stagingAccountID: AccountID;
  1505. }
  1506. export interface ListExtensibleSourceServersResponse {
  1507. /**
  1508. * A list of source servers on a staging Account that are extensible.
  1509. */
  1510. items?: StagingSourceServersList;
  1511. /**
  1512. * The token of the next extensible source server to retrieve.
  1513. */
  1514. nextToken?: PaginationToken;
  1515. }
  1516. export interface ListLaunchActionsRequest {
  1517. /**
  1518. * Filters to apply when listing resource launch actions.
  1519. */
  1520. filters?: LaunchActionsRequestFilters;
  1521. /**
  1522. * Maximum amount of items to return when listing resource launch actions.
  1523. */
  1524. maxResults?: MaxResultsType;
  1525. /**
  1526. * Next token to use when listing resource launch actions.
  1527. */
  1528. nextToken?: PaginationToken;
  1529. resourceId: LaunchActionResourceId;
  1530. }
  1531. export interface ListLaunchActionsResponse {
  1532. /**
  1533. * List of resource launch actions.
  1534. */
  1535. items?: LaunchActions;
  1536. /**
  1537. * Next token returned when listing resource launch actions.
  1538. */
  1539. nextToken?: PaginationToken;
  1540. }
  1541. export interface ListStagingAccountsRequest {
  1542. /**
  1543. * The maximum number of staging Accounts to retrieve.
  1544. */
  1545. maxResults?: ListStagingAccountsRequestMaxResultsInteger;
  1546. /**
  1547. * The token of the next staging Account to retrieve.
  1548. */
  1549. nextToken?: PaginationToken;
  1550. }
  1551. export type ListStagingAccountsRequestMaxResultsInteger = number;
  1552. export interface ListStagingAccountsResponse {
  1553. /**
  1554. * An array of staging AWS Accounts.
  1555. */
  1556. accounts?: Accounts;
  1557. /**
  1558. * The token of the next staging Account to retrieve.
  1559. */
  1560. nextToken?: PaginationToken;
  1561. }
  1562. export interface ListTagsForResourceRequest {
  1563. /**
  1564. * The ARN of the resource whose tags should be returned.
  1565. */
  1566. resourceArn: ARN;
  1567. }
  1568. export interface ListTagsForResourceResponse {
  1569. /**
  1570. * The tags of the requested resource.
  1571. */
  1572. tags?: TagsMap;
  1573. }
  1574. export type MaxResultsReplicatingSourceServers = number;
  1575. export type MaxResultsType = number;
  1576. export interface NetworkInterface {
  1577. /**
  1578. * Network interface IPs.
  1579. */
  1580. ips?: IPsList;
  1581. /**
  1582. * Whether this is the primary network interface.
  1583. */
  1584. isPrimary?: Boolean;
  1585. /**
  1586. * The MAC address of the network interface.
  1587. */
  1588. macAddress?: BoundedString;
  1589. }
  1590. export type NetworkInterfaces = NetworkInterface[];
  1591. export interface OS {
  1592. /**
  1593. * The long name of the Operating System.
  1594. */
  1595. fullString?: BoundedString;
  1596. }
  1597. export type OriginEnvironment = "ON_PREMISES"|"AWS"|string;
  1598. export type OutpostARN = string;
  1599. export type PITPolicy = PITPolicyRule[];
  1600. export interface PITPolicyRule {
  1601. /**
  1602. * Whether this rule is enabled or not.
  1603. */
  1604. enabled?: Boolean;
  1605. /**
  1606. * How often, in the chosen units, a snapshot should be taken.
  1607. */
  1608. interval: StrictlyPositiveInteger;
  1609. /**
  1610. * The duration to retain a snapshot for, in the chosen units.
  1611. */
  1612. retentionDuration: StrictlyPositiveInteger;
  1613. /**
  1614. * The ID of the rule.
  1615. */
  1616. ruleID?: PositiveInteger;
  1617. /**
  1618. * The units used to measure the interval and retentionDuration.
  1619. */
  1620. units: PITPolicyRuleUnits;
  1621. }
  1622. export type PITPolicyRuleUnits = "MINUTE"|"HOUR"|"DAY"|string;
  1623. export type PaginationToken = string;
  1624. export interface ParticipatingResource {
  1625. /**
  1626. * The launch status of a participating resource.
  1627. */
  1628. launchStatus?: LaunchStatus;
  1629. /**
  1630. * The ID of a participating resource.
  1631. */
  1632. participatingResourceID?: ParticipatingResourceID;
  1633. }
  1634. export interface ParticipatingResourceID {
  1635. /**
  1636. * Source Network ID.
  1637. */
  1638. sourceNetworkID?: SourceNetworkID;
  1639. }
  1640. export type ParticipatingResources = ParticipatingResource[];
  1641. export interface ParticipatingServer {
  1642. /**
  1643. * The post-launch action runs of a participating server.
  1644. */
  1645. launchActionsStatus?: LaunchActionsStatus;
  1646. /**
  1647. * The launch status of a participating server.
  1648. */
  1649. launchStatus?: LaunchStatus;
  1650. /**
  1651. * The Recovery Instance ID of a participating server.
  1652. */
  1653. recoveryInstanceID?: RecoveryInstanceID;
  1654. /**
  1655. * The Source Server ID of a participating server.
  1656. */
  1657. sourceServerID?: SourceServerID;
  1658. }
  1659. export type ParticipatingServers = ParticipatingServer[];
  1660. export type PositiveInteger = number;
  1661. export interface ProductCode {
  1662. /**
  1663. * Id of a product code associated with a volume.
  1664. */
  1665. productCodeId?: ProductCodeId;
  1666. /**
  1667. * Mode of a product code associated with a volume.
  1668. */
  1669. productCodeMode?: ProductCodeMode;
  1670. }
  1671. export type ProductCodeId = string;
  1672. export type ProductCodeMode = "ENABLED"|"DISABLED"|string;
  1673. export type ProductCodes = ProductCode[];
  1674. export interface PutLaunchActionRequest {
  1675. /**
  1676. * Launch action code.
  1677. */
  1678. actionCode: SsmDocumentName;
  1679. actionId: LaunchActionId;
  1680. actionVersion: LaunchActionVersion;
  1681. /**
  1682. * Whether the launch action is active.
  1683. */
  1684. active: Boolean;
  1685. category: LaunchActionCategory;
  1686. description: LaunchActionDescription;
  1687. name: LaunchActionName;
  1688. /**
  1689. * Whether the launch will not be marked as failed if this action fails.
  1690. */
  1691. optional: Boolean;
  1692. order: LaunchActionOrder;
  1693. parameters?: LaunchActionParameters;
  1694. resourceId: LaunchActionResourceId;
  1695. }
  1696. export interface PutLaunchActionResponse {
  1697. /**
  1698. * Launch action code.
  1699. */
  1700. actionCode?: SsmDocumentName;
  1701. actionId?: LaunchActionId;
  1702. actionVersion?: LaunchActionVersion;
  1703. /**
  1704. * Whether the launch action is active.
  1705. */
  1706. active?: Boolean;
  1707. category?: LaunchActionCategory;
  1708. description?: LaunchActionDescription;
  1709. name?: LaunchActionName;
  1710. /**
  1711. * Whether the launch will not be marked as failed if this action fails.
  1712. */
  1713. optional?: Boolean;
  1714. order?: LaunchActionOrder;
  1715. parameters?: LaunchActionParameters;
  1716. resourceId?: LaunchActionResourceId;
  1717. /**
  1718. * Launch action type.
  1719. */
  1720. type?: LaunchActionType;
  1721. }
  1722. export interface RecoveryInstance {
  1723. /**
  1724. * The version of the DRS agent installed on the recovery instance
  1725. */
  1726. agentVersion?: AgentVersion;
  1727. /**
  1728. * The ARN of the Recovery Instance.
  1729. */
  1730. arn?: ARN;
  1731. /**
  1732. * The Data Replication Info of the Recovery Instance.
  1733. */
  1734. dataReplicationInfo?: RecoveryInstanceDataReplicationInfo;
  1735. /**
  1736. * The EC2 instance ID of the Recovery Instance.
  1737. */
  1738. ec2InstanceID?: EC2InstanceID;
  1739. /**
  1740. * The state of the EC2 instance for this Recovery Instance.
  1741. */
  1742. ec2InstanceState?: EC2InstanceState;
  1743. /**
  1744. * An object representing failback related information of the Recovery Instance.
  1745. */
  1746. failback?: RecoveryInstanceFailback;
  1747. /**
  1748. * Whether this Recovery Instance was created for a drill or for an actual Recovery event.
  1749. */
  1750. isDrill?: Boolean;
  1751. /**
  1752. * The ID of the Job that created the Recovery Instance.
  1753. */
  1754. jobID?: JobID;
  1755. /**
  1756. * AWS availability zone associated with the recovery instance.
  1757. */
  1758. originAvailabilityZone?: AwsAvailabilityZone;
  1759. /**
  1760. * Environment (On Premises / AWS) of the instance that the recovery instance originated from.
  1761. */
  1762. originEnvironment?: OriginEnvironment;
  1763. /**
  1764. * The date and time of the Point in Time (PIT) snapshot that this Recovery Instance was launched from.
  1765. */
  1766. pointInTimeSnapshotDateTime?: ISO8601DatetimeString;
  1767. /**
  1768. * The ID of the Recovery Instance.
  1769. */
  1770. recoveryInstanceID?: RecoveryInstanceID;
  1771. /**
  1772. * Properties of the Recovery Instance machine.
  1773. */
  1774. recoveryInstanceProperties?: RecoveryInstanceProperties;
  1775. /**
  1776. * The ARN of the source Outpost
  1777. */
  1778. sourceOutpostArn?: OutpostARN;
  1779. /**
  1780. * The Source Server ID that this Recovery Instance is associated with.
  1781. */
  1782. sourceServerID?: SourceServerID;
  1783. /**
  1784. * An array of tags that are associated with the Recovery Instance.
  1785. */
  1786. tags?: TagsMap;
  1787. }
  1788. export interface RecoveryInstanceDataReplicationError {
  1789. /**
  1790. * Error in data replication.
  1791. */
  1792. error?: FailbackReplicationError;
  1793. /**
  1794. * Error in data replication.
  1795. */
  1796. rawError?: LargeBoundedString;
  1797. }
  1798. export interface RecoveryInstanceDataReplicationInfo {
  1799. /**
  1800. * Information about Data Replication
  1801. */
  1802. dataReplicationError?: RecoveryInstanceDataReplicationError;
  1803. /**
  1804. * Information about whether the data replication has been initiated.
  1805. */
  1806. dataReplicationInitiation?: RecoveryInstanceDataReplicationInitiation;
  1807. /**
  1808. * The state of the data replication.
  1809. */
  1810. dataReplicationState?: RecoveryInstanceDataReplicationState;
  1811. /**
  1812. * An estimate of when the data replication will be completed.
  1813. */
  1814. etaDateTime?: ISO8601DatetimeString;
  1815. /**
  1816. * Data replication lag duration.
  1817. */
  1818. lagDuration?: ISO8601DatetimeString;
  1819. /**
  1820. * The disks that should be replicated.
  1821. */
  1822. replicatedDisks?: RecoveryInstanceDataReplicationInfoReplicatedDisks;
  1823. /**
  1824. * AWS Availability zone into which data is being replicated.
  1825. */
  1826. stagingAvailabilityZone?: AwsAvailabilityZone;
  1827. /**
  1828. * The ARN of the staging Outpost
  1829. */
  1830. stagingOutpostArn?: OutpostARN;
  1831. }
  1832. export interface RecoveryInstanceDataReplicationInfoReplicatedDisk {
  1833. /**
  1834. * The size of the replication backlog in bytes.
  1835. */
  1836. backloggedStorageBytes?: PositiveInteger;
  1837. /**
  1838. * The name of the device.
  1839. */
  1840. deviceName?: BoundedString;
  1841. /**
  1842. * The amount of data replicated so far in bytes.
  1843. */
  1844. replicatedStorageBytes?: PositiveInteger;
  1845. /**
  1846. * The amount of data to be rescanned in bytes.
  1847. */
  1848. rescannedStorageBytes?: PositiveInteger;
  1849. /**
  1850. * The total amount of data to be replicated in bytes.
  1851. */
  1852. totalStorageBytes?: PositiveInteger;
  1853. }
  1854. export type RecoveryInstanceDataReplicationInfoReplicatedDisks = RecoveryInstanceDataReplicationInfoReplicatedDisk[];
  1855. export interface RecoveryInstanceDataReplicationInitiation {
  1856. /**
  1857. * The date and time of the current attempt to initiate data replication.
  1858. */
  1859. startDateTime?: ISO8601DatetimeString;
  1860. /**
  1861. * The steps of the current attempt to initiate data replication.
  1862. */
  1863. steps?: RecoveryInstanceDataReplicationInitiationSteps;
  1864. }
  1865. export interface RecoveryInstanceDataReplicationInitiationStep {
  1866. /**
  1867. * The name of the step.
  1868. */
  1869. name?: RecoveryInstanceDataReplicationInitiationStepName;
  1870. /**
  1871. * The status of the step.
  1872. */
  1873. status?: RecoveryInstanceDataReplicationInitiationStepStatus;
  1874. }
  1875. export type RecoveryInstanceDataReplicationInitiationStepName = "LINK_FAILBACK_CLIENT_WITH_RECOVERY_INSTANCE"|"COMPLETE_VOLUME_MAPPING"|"ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION"|"DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT"|"CONFIGURE_REPLICATION_SOFTWARE"|"PAIR_AGENT_WITH_REPLICATION_SOFTWARE"|"ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION"|"WAIT"|"CREATE_SECURITY_GROUP"|"LAUNCH_REPLICATION_SERVER"|"BOOT_REPLICATION_SERVER"|"AUTHENTICATE_WITH_SERVICE"|"DOWNLOAD_REPLICATION_SOFTWARE"|"CREATE_STAGING_DISKS"|"ATTACH_STAGING_DISKS"|"PAIR_REPLICATION_SERVER_WITH_AGENT"|"CONNECT_AGENT_TO_REPLICATION_SERVER"|"START_DATA_TRANSFER"|string;
  1876. export type RecoveryInstanceDataReplicationInitiationStepStatus = "NOT_STARTED"|"IN_PROGRESS"|"SUCCEEDED"|"FAILED"|"SKIPPED"|string;
  1877. export type RecoveryInstanceDataReplicationInitiationSteps = RecoveryInstanceDataReplicationInitiationStep[];
  1878. export type RecoveryInstanceDataReplicationState = "STOPPED"|"INITIATING"|"INITIAL_SYNC"|"BACKLOG"|"CREATING_SNAPSHOT"|"CONTINUOUS"|"PAUSED"|"RESCAN"|"STALLED"|"DISCONNECTED"|"REPLICATION_STATE_NOT_AVAILABLE"|"NOT_STARTED"|string;
  1879. export interface RecoveryInstanceDisk {
  1880. /**
  1881. * The amount of storage on the disk in bytes.
  1882. */
  1883. bytes?: PositiveInteger;
  1884. /**
  1885. * The EBS Volume ID of this disk.
  1886. */
  1887. ebsVolumeID?: EbsVolumeID;
  1888. /**
  1889. * The internal device name of this disk. This is the name that is visible on the machine itself and not from the EC2 console.
  1890. */
  1891. internalDeviceName?: BoundedString;
  1892. }
  1893. export type RecoveryInstanceDisks = RecoveryInstanceDisk[];
  1894. export interface RecoveryInstanceFailback {
  1895. /**
  1896. * The date and time the agent on the Recovery Instance was last seen by the service.
  1897. */
  1898. agentLastSeenByServiceDateTime?: ISO8601DatetimeString;
  1899. /**
  1900. * The amount of time that the Recovery Instance has been replicating for.
  1901. */
  1902. elapsedReplicationDuration?: ISO8601DatetimeString;
  1903. /**
  1904. * The ID of the failback client that this Recovery Instance is associated with.
  1905. */
  1906. failbackClientID?: BoundedString;
  1907. /**
  1908. * The date and time that the failback client was last seen by the service.
  1909. */
  1910. failbackClientLastSeenByServiceDateTime?: ISO8601DatetimeString;
  1911. /**
  1912. * The date and time that the failback initiation started.
  1913. */
  1914. failbackInitiationTime?: ISO8601DatetimeString;
  1915. /**
  1916. * The Job ID of the last failback log for this Recovery Instance.
  1917. */
  1918. failbackJobID?: JobID;
  1919. /**
  1920. * The launch type (Recovery / Drill) of the last launch for the failback replication of this recovery instance.
  1921. */
  1922. failbackLaunchType?: FailbackLaunchType;
  1923. /**
  1924. * Whether we are failing back to the original Source Server for this Recovery Instance.
  1925. */
  1926. failbackToOriginalServer?: Boolean;
  1927. /**
  1928. * The date and time of the first byte that was replicated from the Recovery Instance.
  1929. */
  1930. firstByteDateTime?: ISO8601DatetimeString;
  1931. /**
  1932. * The state of the failback process that this Recovery Instance is in.
  1933. */
  1934. state?: FailbackState;
  1935. }
  1936. export type RecoveryInstanceID = string;
  1937. export type RecoveryInstanceIDs = RecoveryInstanceID[];
  1938. export interface RecoveryInstanceProperties {
  1939. /**
  1940. * An array of CPUs.
  1941. */
  1942. cpus?: Cpus;
  1943. /**
  1944. * An array of disks.
  1945. */
  1946. disks?: RecoveryInstanceDisks;
  1947. /**
  1948. * Hints used to uniquely identify a machine.
  1949. */
  1950. identificationHints?: IdentificationHints;
  1951. /**
  1952. * The date and time the Recovery Instance properties were last updated on.
  1953. */
  1954. lastUpdatedDateTime?: ISO8601DatetimeString;
  1955. /**
  1956. * An array of network interfaces.
  1957. */
  1958. networkInterfaces?: NetworkInterfaces;
  1959. /**
  1960. * Operating system.
  1961. */
  1962. os?: OS;
  1963. /**
  1964. * The amount of RAM in bytes.
  1965. */
  1966. ramBytes?: PositiveInteger;
  1967. }
  1968. export type RecoveryInstancesForTerminationRequest = RecoveryInstanceID[];
  1969. export interface RecoveryLifeCycle {
  1970. /**
  1971. * The date and time the last Source Network recovery was initiated.
  1972. */
  1973. apiCallDateTime?: SyntheticTimestamp_date_time;
  1974. /**
  1975. * The ID of the Job that was used to last recover the Source Network.
  1976. */
  1977. jobID?: JobID;
  1978. /**
  1979. * The status of the last recovery status of this Source Network.
  1980. */
  1981. lastRecoveryResult?: RecoveryResult;
  1982. }
  1983. export type RecoveryResult = "NOT_STARTED"|"IN_PROGRESS"|"SUCCESS"|"FAIL"|"PARTIAL_SUCCESS"|"ASSOCIATE_SUCCESS"|"ASSOCIATE_FAIL"|string;
  1984. export interface RecoverySnapshot {
  1985. /**
  1986. * A list of EBS snapshots.
  1987. */
  1988. ebsSnapshots?: EbsSnapshotsList;
  1989. /**
  1990. * The timestamp of when we expect the snapshot to be taken.
  1991. */
  1992. expectedTimestamp: ISO8601DatetimeString;
  1993. /**
  1994. * The ID of the Recovery Snapshot.
  1995. */
  1996. snapshotID: RecoverySnapshotID;
  1997. /**
  1998. * The ID of the Source Server that the snapshot was taken for.
  1999. */
  2000. sourceServerID: SourceServerID;
  2001. /**
  2002. * The actual timestamp that the snapshot was taken.
  2003. */
  2004. timestamp?: ISO8601DatetimeString;
  2005. }
  2006. export type RecoverySnapshotID = string;
  2007. export type RecoverySnapshotsList = RecoverySnapshot[];
  2008. export type RecoverySnapshotsOrder = "ASC"|"DESC"|string;
  2009. export interface ReplicationConfiguration {
  2010. /**
  2011. * Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.
  2012. */
  2013. associateDefaultSecurityGroup?: Boolean;
  2014. /**
  2015. * Whether to allow the AWS replication agent to automatically replicate newly added disks.
  2016. */
  2017. autoReplicateNewDisks?: Boolean;
  2018. /**
  2019. * Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
  2020. */
  2021. bandwidthThrottling?: PositiveInteger;
  2022. /**
  2023. * Whether to create a Public IP for the Recovery Instance by default.
  2024. */
  2025. createPublicIP?: Boolean;
  2026. /**
  2027. * The data plane routing mechanism that will be used for replication.
  2028. */
  2029. dataPlaneRouting?: ReplicationConfigurationDataPlaneRouting;
  2030. /**
  2031. * The Staging Disk EBS volume type to be used during replication.
  2032. */
  2033. defaultLargeStagingDiskType?: ReplicationConfigurationDefaultLargeStagingDiskType;
  2034. /**
  2035. * The type of EBS encryption to be used during replication.
  2036. */
  2037. ebsEncryption?: ReplicationConfigurationEbsEncryption;
  2038. /**
  2039. * The ARN of the EBS encryption key to be used during replication.
  2040. */
  2041. ebsEncryptionKeyArn?: ARN;
  2042. /**
  2043. * The name of the Replication Configuration.
  2044. */
  2045. name?: SmallBoundedString;
  2046. /**
  2047. * The Point in time (PIT) policy to manage snapshots taken during replication.
  2048. */
  2049. pitPolicy?: PITPolicy;
  2050. /**
  2051. * The configuration of the disks of the Source Server to be replicated.
  2052. */
  2053. replicatedDisks?: ReplicationConfigurationReplicatedDisks;
  2054. /**
  2055. * The instance type to be used for the replication server.
  2056. */
  2057. replicationServerInstanceType?: EC2InstanceType;
  2058. /**
  2059. * The security group IDs that will be used by the replication server.
  2060. */
  2061. replicationServersSecurityGroupsIDs?: ReplicationServersSecurityGroupsIDs;
  2062. /**
  2063. * The ID of the Source Server for this Replication Configuration.
  2064. */
  2065. sourceServerID?: SourceServerID;
  2066. /**
  2067. * The subnet to be used by the replication staging area.
  2068. */
  2069. stagingAreaSubnetId?: SubnetID;
  2070. /**
  2071. * A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
  2072. */
  2073. stagingAreaTags?: TagsMap;
  2074. /**
  2075. * Whether to use a dedicated Replication Server in the replication staging area.
  2076. */
  2077. useDedicatedReplicationServer?: Boolean;
  2078. }
  2079. export type ReplicationConfigurationDataPlaneRouting = "PRIVATE_IP"|"PUBLIC_IP"|string;
  2080. export type ReplicationConfigurationDefaultLargeStagingDiskType = "GP2"|"GP3"|"ST1"|"AUTO"|string;
  2081. export type ReplicationConfigurationEbsEncryption = "DEFAULT"|"CUSTOM"|"NONE"|string;
  2082. export interface ReplicationConfigurationReplicatedDisk {
  2083. /**
  2084. * The name of the device.
  2085. */
  2086. deviceName?: BoundedString;
  2087. /**
  2088. * The requested number of I/O operations per second (IOPS).
  2089. */
  2090. iops?: PositiveInteger;
  2091. /**
  2092. * Whether to boot from this disk or not.
  2093. */
  2094. isBootDisk?: Boolean;
  2095. /**
  2096. * The Staging Disk EBS volume type to be used during replication when stagingDiskType is set to Auto. This is a read-only field.
  2097. */
  2098. optimizedStagingDiskType?: ReplicationConfigurationReplicatedDiskStagingDiskType;
  2099. /**
  2100. * The Staging Disk EBS volume type to be used during replication.
  2101. */
  2102. stagingDiskType?: ReplicationConfigurationReplicatedDiskStagingDiskType;
  2103. /**
  2104. * The throughput to use for the EBS volume in MiB/s. This parameter is valid only for gp3 volumes.
  2105. */
  2106. throughput?: PositiveInteger;
  2107. }
  2108. export type ReplicationConfigurationReplicatedDiskStagingDiskType = "AUTO"|"GP2"|"GP3"|"IO1"|"SC1"|"ST1"|"STANDARD"|string;
  2109. export type ReplicationConfigurationReplicatedDisks = ReplicationConfigurationReplicatedDisk[];
  2110. export interface ReplicationConfigurationTemplate {
  2111. /**
  2112. * The Replication Configuration Template ARN.
  2113. */
  2114. arn?: ARN;
  2115. /**
  2116. * Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
  2117. */
  2118. associateDefaultSecurityGroup?: Boolean;
  2119. /**
  2120. * Whether to allow the AWS replication agent to automatically replicate newly added disks.
  2121. */
  2122. autoReplicateNewDisks?: Boolean;
  2123. /**
  2124. * Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
  2125. */
  2126. bandwidthThrottling?: PositiveInteger;
  2127. /**
  2128. * Whether to create a Public IP for the Recovery Instance by default.
  2129. */
  2130. createPublicIP?: Boolean;
  2131. /**
  2132. * The data plane routing mechanism that will be used for replication.
  2133. */
  2134. dataPlaneRouting?: ReplicationConfigurationDataPlaneRouting;
  2135. /**
  2136. * The Staging Disk EBS volume type to be used during replication.
  2137. */
  2138. defaultLargeStagingDiskType?: ReplicationConfigurationDefaultLargeStagingDiskType;
  2139. /**
  2140. * The type of EBS encryption to be used during replication.
  2141. */
  2142. ebsEncryption?: ReplicationConfigurationEbsEncryption;
  2143. /**
  2144. * The ARN of the EBS encryption key to be used during replication.
  2145. */
  2146. ebsEncryptionKeyArn?: ARN;
  2147. /**
  2148. * The Point in time (PIT) policy to manage snapshots taken during replication.
  2149. */
  2150. pitPolicy?: PITPolicy;
  2151. /**
  2152. * The Replication Configuration Template ID.
  2153. */
  2154. replicationConfigurationTemplateID: ReplicationConfigurationTemplateID;
  2155. /**
  2156. * The instance type to be used for the replication server.
  2157. */
  2158. replicationServerInstanceType?: EC2InstanceType;
  2159. /**
  2160. * The security group IDs that will be used by the replication server.
  2161. */
  2162. replicationServersSecurityGroupsIDs?: ReplicationServersSecurityGroupsIDs;
  2163. /**
  2164. * The subnet to be used by the replication staging area.
  2165. */
  2166. stagingAreaSubnetId?: SubnetID;
  2167. /**
  2168. * A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
  2169. */
  2170. stagingAreaTags?: TagsMap;
  2171. /**
  2172. * A set of tags to be associated with the Replication Configuration Template resource.
  2173. */
  2174. tags?: TagsMap;
  2175. /**
  2176. * Whether to use a dedicated Replication Server in the replication staging area.
  2177. */
  2178. useDedicatedReplicationServer?: Boolean;
  2179. }
  2180. export type ReplicationConfigurationTemplateID = string;
  2181. export type ReplicationConfigurationTemplateIDs = ReplicationConfigurationTemplateID[];
  2182. export type ReplicationConfigurationTemplates = ReplicationConfigurationTemplate[];
  2183. export type ReplicationDirection = "FAILOVER"|"FAILBACK"|string;
  2184. export type ReplicationServersSecurityGroupsIDs = SecurityGroupID[];
  2185. export type ReplicationStatus = "STOPPED"|"IN_PROGRESS"|"PROTECTED"|"ERROR"|string;
  2186. export interface RetryDataReplicationRequest {
  2187. /**
  2188. * The ID of the Source Server whose data replication should be retried.
  2189. */
  2190. sourceServerID: SourceServerID;
  2191. }
  2192. export interface ReverseReplicationRequest {
  2193. /**
  2194. * The ID of the Recovery Instance that we want to reverse the replication for.
  2195. */
  2196. recoveryInstanceID: RecoveryInstanceID;
  2197. }
  2198. export interface ReverseReplicationResponse {
  2199. /**
  2200. * ARN of created SourceServer.
  2201. */
  2202. reversedDirectionSourceServerArn?: SourceServerARN;
  2203. }
  2204. export type SecurityGroupID = string;
  2205. export type SensitiveBoundedString = string;
  2206. export type SmallBoundedString = string;
  2207. export interface SourceCloudProperties {
  2208. /**
  2209. * AWS Account ID for an EC2-originated Source Server.
  2210. */
  2211. originAccountID?: AccountID;
  2212. /**
  2213. * AWS Availability Zone for an EC2-originated Source Server.
  2214. */
  2215. originAvailabilityZone?: AwsAvailabilityZone;
  2216. /**
  2217. * AWS Region for an EC2-originated Source Server.
  2218. */
  2219. originRegion?: AwsRegion;
  2220. /**
  2221. * The ARN of the source Outpost
  2222. */
  2223. sourceOutpostArn?: OutpostARN;
  2224. }
  2225. export interface SourceNetwork {
  2226. /**
  2227. * The ARN of the Source Network.
  2228. */
  2229. arn?: ARN;
  2230. /**
  2231. * CloudFormation stack name that was deployed for recovering the Source Network.
  2232. */
  2233. cfnStackName?: CfnStackName;
  2234. /**
  2235. * An object containing information regarding the last recovery of the Source Network.
  2236. */
  2237. lastRecovery?: RecoveryLifeCycle;
  2238. /**
  2239. * ID of the recovered VPC following Source Network recovery.
  2240. */
  2241. launchedVpcID?: VpcID;
  2242. /**
  2243. * Status of Source Network Replication. Possible values: (a) STOPPED - Source Network is not replicating. (b) IN_PROGRESS - Source Network is being replicated. (c) PROTECTED - Source Network was replicated successfully and is being synchronized for changes. (d) ERROR - Source Network replication has failed
  2244. */
  2245. replicationStatus?: ReplicationStatus;
  2246. /**
  2247. * Error details in case Source Network replication status is ERROR.
  2248. */
  2249. replicationStatusDetails?: SensitiveBoundedString;
  2250. /**
  2251. * Account ID containing the VPC protected by the Source Network.
  2252. */
  2253. sourceAccountID?: AccountID;
  2254. /**
  2255. * Source Network ID.
  2256. */
  2257. sourceNetworkID?: SourceNetworkID;
  2258. /**
  2259. * Region containing the VPC protected by the Source Network.
  2260. */
  2261. sourceRegion?: AwsRegion;
  2262. /**
  2263. * VPC ID protected by the Source Network.
  2264. */
  2265. sourceVpcID?: VpcID;
  2266. /**
  2267. * A list of tags associated with the Source Network.
  2268. */
  2269. tags?: TagsMap;
  2270. }
  2271. export interface SourceNetworkData {
  2272. /**
  2273. * Source Network ID.
  2274. */
  2275. sourceNetworkID?: SourceNetworkID;
  2276. /**
  2277. * VPC ID protected by the Source Network.
  2278. */
  2279. sourceVpc?: VpcID;
  2280. /**
  2281. * CloudFormation stack name that was deployed for recovering the Source Network.
  2282. */
  2283. stackName?: LargeBoundedString;
  2284. /**
  2285. * ID of the recovered VPC following Source Network recovery.
  2286. */
  2287. targetVpc?: VpcID;
  2288. }
  2289. export type SourceNetworkID = string;
  2290. export type SourceNetworksList = SourceNetwork[];
  2291. export interface SourceProperties {
  2292. /**
  2293. * An array of CPUs.
  2294. */
  2295. cpus?: Cpus;
  2296. /**
  2297. * An array of disks.
  2298. */
  2299. disks?: Disks;
  2300. /**
  2301. * Hints used to uniquely identify a machine.
  2302. */
  2303. identificationHints?: IdentificationHints;
  2304. /**
  2305. * The date and time the Source Properties were last updated on.
  2306. */
  2307. lastUpdatedDateTime?: ISO8601DatetimeString;
  2308. /**
  2309. * An array of network interfaces.
  2310. */
  2311. networkInterfaces?: NetworkInterfaces;
  2312. /**
  2313. * Operating system.
  2314. */
  2315. os?: OS;
  2316. /**
  2317. * The amount of RAM in bytes.
  2318. */
  2319. ramBytes?: PositiveInteger;
  2320. /**
  2321. * The recommended EC2 instance type that will be used when recovering the Source Server.
  2322. */
  2323. recommendedInstanceType?: EC2InstanceType;
  2324. /**
  2325. * Are EC2 nitro instance types supported when recovering the Source Server.
  2326. */
  2327. supportsNitroInstances?: Boolean;
  2328. }
  2329. export interface SourceServer {
  2330. /**
  2331. * The version of the DRS agent installed on the source server
  2332. */
  2333. agentVersion?: AgentVersion;
  2334. /**
  2335. * The ARN of the Source Server.
  2336. */
  2337. arn?: ARN;
  2338. /**
  2339. * The Data Replication Info of the Source Server.
  2340. */
  2341. dataReplicationInfo?: DataReplicationInfo;
  2342. /**
  2343. * The status of the last recovery launch of this Source Server.
  2344. */
  2345. lastLaunchResult?: LastLaunchResult;
  2346. /**
  2347. * The lifecycle information of this Source Server.
  2348. */
  2349. lifeCycle?: LifeCycle;
  2350. /**
  2351. * The ID of the Recovery Instance associated with this Source Server.
  2352. */
  2353. recoveryInstanceId?: RecoveryInstanceID;
  2354. /**
  2355. * Replication direction of the Source Server.
  2356. */
  2357. replicationDirection?: ReplicationDirection;
  2358. /**
  2359. * For EC2-originated Source Servers which have been failed over and then failed back, this value will mean the ARN of the Source Server on the opposite replication direction.
  2360. */
  2361. reversedDirectionSourceServerArn?: SourceServerARN;
  2362. /**
  2363. * Source cloud properties of the Source Server.
  2364. */
  2365. sourceCloudProperties?: SourceCloudProperties;
  2366. /**
  2367. * ID of the Source Network which is protecting this Source Server's network.
  2368. */
  2369. sourceNetworkID?: SourceNetworkID;
  2370. /**
  2371. * The source properties of the Source Server.
  2372. */
  2373. sourceProperties?: SourceProperties;
  2374. /**
  2375. * The ID of the Source Server.
  2376. */
  2377. sourceServerID?: SourceServerID;
  2378. /**
  2379. * The staging area of the source server.
  2380. */
  2381. stagingArea?: StagingArea;
  2382. /**
  2383. * The tags associated with the Source Server.
  2384. */
  2385. tags?: TagsMap;
  2386. }
  2387. export type SourceServerARN = string;
  2388. export type SourceServerID = string;
  2389. export type SourceServerIDs = SourceServerID[];
  2390. export type SourceServersList = SourceServer[];
  2391. export type SsmDocumentName = string;
  2392. export interface StagingArea {
  2393. /**
  2394. * Shows an error message that occurred when DRS tried to access the staging source server. In this case StagingArea$status will have value EXTENSION_ERROR
  2395. */
  2396. errorMessage?: LargeBoundedString;
  2397. /**
  2398. * Account ID of the account to which source server belongs. If this source server is extended - shows Account ID of staging source server.
  2399. */
  2400. stagingAccountID?: AccountID;
  2401. /**
  2402. * Arn of the staging source server if this source server is extended
  2403. */
  2404. stagingSourceServerArn?: ARN;
  2405. /**
  2406. * Status of Source server extension. Possible values: (a) NOT_EXTENDED - This is a source server that is replicating in the current account. (b) EXTENDED - Source server is extended from a staging source server. In this case, the value of stagingSourceServerArn is pointing to the Arn of the source server in the staging account. (c) EXTENSION_ERROR - Some issue occurred when accessing staging source server. In this case, errorMessage field will contain an error message that explains what happened.
  2407. */
  2408. status?: ExtensionStatus;
  2409. }
  2410. export interface StagingSourceServer {
  2411. /**
  2412. * The ARN of the source server.
  2413. */
  2414. arn?: SourceServerARN;
  2415. /**
  2416. * Hostname of staging source server.
  2417. */
  2418. hostname?: BoundedString;
  2419. /**
  2420. * A list of tags associated with the staging source server.
  2421. */
  2422. tags?: TagsMap;
  2423. }
  2424. export type StagingSourceServersList = StagingSourceServer[];
  2425. export interface StartFailbackLaunchRequest {
  2426. /**
  2427. * The IDs of the Recovery Instance whose failback launch we want to request.
  2428. */
  2429. recoveryInstanceIDs: StartFailbackRequestRecoveryInstanceIDs;
  2430. /**
  2431. * The tags to be associated with the failback launch Job.
  2432. */
  2433. tags?: TagsMap;
  2434. }
  2435. export interface StartFailbackLaunchResponse {
  2436. /**
  2437. * The failback launch Job.
  2438. */
  2439. job?: Job;
  2440. }
  2441. export type StartFailbackRequestRecoveryInstanceIDs = RecoveryInstanceID[];
  2442. export interface StartRecoveryRequest {
  2443. /**
  2444. * Whether this Source Server Recovery operation is a drill or not.
  2445. */
  2446. isDrill?: Boolean;
  2447. /**
  2448. * The Source Servers that we want to start a Recovery Job for.
  2449. */
  2450. sourceServers: StartRecoveryRequestSourceServers;
  2451. /**
  2452. * The tags to be associated with the Recovery Job.
  2453. */
  2454. tags?: TagsMap;
  2455. }
  2456. export interface StartRecoveryRequestSourceServer {
  2457. /**
  2458. * The ID of a Recovery Snapshot we want to recover from. Omit this field to launch from the latest data by taking an on-demand snapshot.
  2459. */
  2460. recoverySnapshotID?: RecoverySnapshotID;
  2461. /**
  2462. * The ID of the Source Server you want to recover.
  2463. */
  2464. sourceServerID: SourceServerID;
  2465. }
  2466. export type StartRecoveryRequestSourceServers = StartRecoveryRequestSourceServer[];
  2467. export interface StartRecoveryResponse {
  2468. /**
  2469. * The Recovery Job.
  2470. */
  2471. job?: Job;
  2472. }
  2473. export interface StartReplicationRequest {
  2474. /**
  2475. * The ID of the Source Server to start replication for.
  2476. */
  2477. sourceServerID: SourceServerID;
  2478. }
  2479. export interface StartReplicationResponse {
  2480. /**
  2481. * The Source Server that this action was targeted on.
  2482. */
  2483. sourceServer?: SourceServer;
  2484. }
  2485. export interface StartSourceNetworkRecoveryRequest {
  2486. /**
  2487. * Don't update existing CloudFormation Stack, recover the network using a new stack.
  2488. */
  2489. deployAsNew?: Boolean;
  2490. /**
  2491. * The Source Networks that we want to start a Recovery Job for.
  2492. */
  2493. sourceNetworks: StartSourceNetworkRecoveryRequestNetworkEntries;
  2494. /**
  2495. * The tags to be associated with the Source Network recovery Job.
  2496. */
  2497. tags?: TagsMap;
  2498. }
  2499. export type StartSourceNetworkRecoveryRequestNetworkEntries = StartSourceNetworkRecoveryRequestNetworkEntry[];
  2500. export interface StartSourceNetworkRecoveryRequestNetworkEntry {
  2501. /**
  2502. * CloudFormation stack name to be used for recovering the network.
  2503. */
  2504. cfnStackName?: CfnStackName;
  2505. /**
  2506. * The ID of the Source Network you want to recover.
  2507. */
  2508. sourceNetworkID: SourceNetworkID;
  2509. }
  2510. export interface StartSourceNetworkRecoveryResponse {
  2511. /**
  2512. * The Source Network recovery Job.
  2513. */
  2514. job?: Job;
  2515. }
  2516. export interface StartSourceNetworkReplicationRequest {
  2517. /**
  2518. * ID of the Source Network to replicate.
  2519. */
  2520. sourceNetworkID: SourceNetworkID;
  2521. }
  2522. export interface StartSourceNetworkReplicationResponse {
  2523. /**
  2524. * Source Network which was requested for replication.
  2525. */
  2526. sourceNetwork?: SourceNetwork;
  2527. }
  2528. export interface StopFailbackRequest {
  2529. /**
  2530. * The ID of the Recovery Instance we want to stop failback for.
  2531. */
  2532. recoveryInstanceID: RecoveryInstanceID;
  2533. }
  2534. export interface StopReplicationRequest {
  2535. /**
  2536. * The ID of the Source Server to stop replication for.
  2537. */
  2538. sourceServerID: SourceServerID;
  2539. }
  2540. export interface StopReplicationResponse {
  2541. /**
  2542. * The Source Server that this action was targeted on.
  2543. */
  2544. sourceServer?: SourceServer;
  2545. }
  2546. export interface StopSourceNetworkReplicationRequest {
  2547. /**
  2548. * ID of the Source Network to stop replication.
  2549. */
  2550. sourceNetworkID: SourceNetworkID;
  2551. }
  2552. export interface StopSourceNetworkReplicationResponse {
  2553. /**
  2554. * Source Network which was requested to stop replication.
  2555. */
  2556. sourceNetwork?: SourceNetwork;
  2557. }
  2558. export type StrictlyPositiveInteger = number;
  2559. export type SubnetID = string;
  2560. export type SyntheticTimestamp_date_time = Date;
  2561. export type TagKey = string;
  2562. export type TagKeys = TagKey[];
  2563. export interface TagResourceRequest {
  2564. /**
  2565. * ARN of the resource for which tags are to be added or updated.
  2566. */
  2567. resourceArn: ARN;
  2568. /**
  2569. * Array of tags to be added or updated.
  2570. */
  2571. tags: TagsMap;
  2572. }
  2573. export type TagValue = string;
  2574. export type TagsMap = {[key: string]: TagValue};
  2575. export type TargetInstanceTypeRightSizingMethod = "NONE"|"BASIC"|"IN_AWS"|string;
  2576. export interface TerminateRecoveryInstancesRequest {
  2577. /**
  2578. * The IDs of the Recovery Instances that should be terminated.
  2579. */
  2580. recoveryInstanceIDs: RecoveryInstancesForTerminationRequest;
  2581. }
  2582. export interface TerminateRecoveryInstancesResponse {
  2583. /**
  2584. * The Job for terminating the Recovery Instances.
  2585. */
  2586. job?: Job;
  2587. }
  2588. export interface UntagResourceRequest {
  2589. /**
  2590. * ARN of the resource for which tags are to be removed.
  2591. */
  2592. resourceArn: ARN;
  2593. /**
  2594. * Array of tags to be removed.
  2595. */
  2596. tagKeys: TagKeys;
  2597. }
  2598. export interface UpdateFailbackReplicationConfigurationRequest {
  2599. /**
  2600. * Configure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.
  2601. */
  2602. bandwidthThrottling?: PositiveInteger;
  2603. /**
  2604. * The name of the Failback Replication Configuration.
  2605. */
  2606. name?: BoundedString;
  2607. /**
  2608. * The ID of the Recovery Instance.
  2609. */
  2610. recoveryInstanceID: RecoveryInstanceID;
  2611. /**
  2612. * Whether to use Private IP for the failback replication of the Recovery Instance.
  2613. */
  2614. usePrivateIP?: Boolean;
  2615. }
  2616. export interface UpdateLaunchConfigurationRequest {
  2617. /**
  2618. * Whether we should copy the Private IP of the Source Server to the Recovery Instance.
  2619. */
  2620. copyPrivateIp?: Boolean;
  2621. /**
  2622. * Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.
  2623. */
  2624. copyTags?: Boolean;
  2625. /**
  2626. * The state of the Recovery Instance in EC2 after the recovery operation.
  2627. */
  2628. launchDisposition?: LaunchDisposition;
  2629. /**
  2630. * Launch into existing instance properties.
  2631. */
  2632. launchIntoInstanceProperties?: LaunchIntoInstanceProperties;
  2633. /**
  2634. * The licensing configuration to be used for this launch configuration.
  2635. */
  2636. licensing?: Licensing;
  2637. /**
  2638. * The name of the launch configuration.
  2639. */
  2640. name?: SmallBoundedString;
  2641. /**
  2642. * Whether we want to enable post-launch actions for the Source Server.
  2643. */
  2644. postLaunchEnabled?: Boolean;
  2645. /**
  2646. * The ID of the Source Server that we want to retrieve a Launch Configuration for.
  2647. */
  2648. sourceServerID: SourceServerID;
  2649. /**
  2650. * Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.
  2651. */
  2652. targetInstanceTypeRightSizingMethod?: TargetInstanceTypeRightSizingMethod;
  2653. }
  2654. export interface UpdateLaunchConfigurationTemplateRequest {
  2655. /**
  2656. * Copy private IP.
  2657. */
  2658. copyPrivateIp?: Boolean;
  2659. /**
  2660. * Copy tags.
  2661. */
  2662. copyTags?: Boolean;
  2663. /**
  2664. * S3 bucket ARN to export Source Network templates.
  2665. */
  2666. exportBucketArn?: ARN;
  2667. /**
  2668. * Launch Configuration Template ID.
  2669. */
  2670. launchConfigurationTemplateID: LaunchConfigurationTemplateID;
  2671. /**
  2672. * Launch disposition.
  2673. */
  2674. launchDisposition?: LaunchDisposition;
  2675. /**
  2676. * DRS will set the 'launch into instance ID' of any source server when performing a drill, recovery or failback to the previous region or availability zone, using the instance ID of the source instance.
  2677. */
  2678. launchIntoSourceInstance?: Boolean;
  2679. /**
  2680. * Licensing.
  2681. */
  2682. licensing?: Licensing;
  2683. /**
  2684. * Whether we want to activate post-launch actions.
  2685. */
  2686. postLaunchEnabled?: Boolean;
  2687. /**
  2688. * Target instance type right-sizing method.
  2689. */
  2690. targetInstanceTypeRightSizingMethod?: TargetInstanceTypeRightSizingMethod;
  2691. }
  2692. export interface UpdateLaunchConfigurationTemplateResponse {
  2693. /**
  2694. * Updated Launch Configuration Template.
  2695. */
  2696. launchConfigurationTemplate?: LaunchConfigurationTemplate;
  2697. }
  2698. export interface UpdateReplicationConfigurationRequest {
  2699. /**
  2700. * Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.
  2701. */
  2702. associateDefaultSecurityGroup?: Boolean;
  2703. /**
  2704. * Whether to allow the AWS replication agent to automatically replicate newly added disks.
  2705. */
  2706. autoReplicateNewDisks?: Boolean;
  2707. /**
  2708. * Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
  2709. */
  2710. bandwidthThrottling?: PositiveInteger;
  2711. /**
  2712. * Whether to create a Public IP for the Recovery Instance by default.
  2713. */
  2714. createPublicIP?: Boolean;
  2715. /**
  2716. * The data plane routing mechanism that will be used for replication.
  2717. */
  2718. dataPlaneRouting?: ReplicationConfigurationDataPlaneRouting;
  2719. /**
  2720. * The Staging Disk EBS volume type to be used during replication.
  2721. */
  2722. defaultLargeStagingDiskType?: ReplicationConfigurationDefaultLargeStagingDiskType;
  2723. /**
  2724. * The type of EBS encryption to be used during replication.
  2725. */
  2726. ebsEncryption?: ReplicationConfigurationEbsEncryption;
  2727. /**
  2728. * The ARN of the EBS encryption key to be used during replication.
  2729. */
  2730. ebsEncryptionKeyArn?: ARN;
  2731. /**
  2732. * The name of the Replication Configuration.
  2733. */
  2734. name?: SmallBoundedString;
  2735. /**
  2736. * The Point in time (PIT) policy to manage snapshots taken during replication.
  2737. */
  2738. pitPolicy?: PITPolicy;
  2739. /**
  2740. * The configuration of the disks of the Source Server to be replicated.
  2741. */
  2742. replicatedDisks?: ReplicationConfigurationReplicatedDisks;
  2743. /**
  2744. * The instance type to be used for the replication server.
  2745. */
  2746. replicationServerInstanceType?: EC2InstanceType;
  2747. /**
  2748. * The security group IDs that will be used by the replication server.
  2749. */
  2750. replicationServersSecurityGroupsIDs?: ReplicationServersSecurityGroupsIDs;
  2751. /**
  2752. * The ID of the Source Server for this Replication Configuration.
  2753. */
  2754. sourceServerID: SourceServerID;
  2755. /**
  2756. * The subnet to be used by the replication staging area.
  2757. */
  2758. stagingAreaSubnetId?: SubnetID;
  2759. /**
  2760. * A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
  2761. */
  2762. stagingAreaTags?: TagsMap;
  2763. /**
  2764. * Whether to use a dedicated Replication Server in the replication staging area.
  2765. */
  2766. useDedicatedReplicationServer?: Boolean;
  2767. }
  2768. export interface UpdateReplicationConfigurationTemplateRequest {
  2769. /**
  2770. * The Replication Configuration Template ARN.
  2771. */
  2772. arn?: ARN;
  2773. /**
  2774. * Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
  2775. */
  2776. associateDefaultSecurityGroup?: Boolean;
  2777. /**
  2778. * Whether to allow the AWS replication agent to automatically replicate newly added disks.
  2779. */
  2780. autoReplicateNewDisks?: Boolean;
  2781. /**
  2782. * Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
  2783. */
  2784. bandwidthThrottling?: PositiveInteger;
  2785. /**
  2786. * Whether to create a Public IP for the Recovery Instance by default.
  2787. */
  2788. createPublicIP?: Boolean;
  2789. /**
  2790. * The data plane routing mechanism that will be used for replication.
  2791. */
  2792. dataPlaneRouting?: ReplicationConfigurationDataPlaneRouting;
  2793. /**
  2794. * The Staging Disk EBS volume type to be used during replication.
  2795. */
  2796. defaultLargeStagingDiskType?: ReplicationConfigurationDefaultLargeStagingDiskType;
  2797. /**
  2798. * The type of EBS encryption to be used during replication.
  2799. */
  2800. ebsEncryption?: ReplicationConfigurationEbsEncryption;
  2801. /**
  2802. * The ARN of the EBS encryption key to be used during replication.
  2803. */
  2804. ebsEncryptionKeyArn?: ARN;
  2805. /**
  2806. * The Point in time (PIT) policy to manage snapshots taken during replication.
  2807. */
  2808. pitPolicy?: PITPolicy;
  2809. /**
  2810. * The Replication Configuration Template ID.
  2811. */
  2812. replicationConfigurationTemplateID: ReplicationConfigurationTemplateID;
  2813. /**
  2814. * The instance type to be used for the replication server.
  2815. */
  2816. replicationServerInstanceType?: EC2InstanceType;
  2817. /**
  2818. * The security group IDs that will be used by the replication server.
  2819. */
  2820. replicationServersSecurityGroupsIDs?: ReplicationServersSecurityGroupsIDs;
  2821. /**
  2822. * The subnet to be used by the replication staging area.
  2823. */
  2824. stagingAreaSubnetId?: SubnetID;
  2825. /**
  2826. * A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
  2827. */
  2828. stagingAreaTags?: TagsMap;
  2829. /**
  2830. * Whether to use a dedicated Replication Server in the replication staging area.
  2831. */
  2832. useDedicatedReplicationServer?: Boolean;
  2833. }
  2834. export type VolumeStatus = "REGULAR"|"CONTAINS_MARKETPLACE_PRODUCT_CODES"|"MISSING_VOLUME_ATTRIBUTES"|"MISSING_VOLUME_ATTRIBUTES_AND_PRECHECK_UNAVAILABLE"|"PENDING"|string;
  2835. export type VolumeToConversionMap = {[key: string]: ConversionMap};
  2836. export type VolumeToProductCodes = {[key: string]: ProductCodes};
  2837. export type VolumeToSizeMap = {[key: string]: PositiveInteger};
  2838. export type VpcID = string;
  2839. /**
  2840. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  2841. */
  2842. export type apiVersion = "2020-02-26"|"latest"|string;
  2843. export interface ClientApiVersions {
  2844. /**
  2845. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  2846. */
  2847. apiVersion?: apiVersion;
  2848. }
  2849. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  2850. /**
  2851. * Contains interfaces for use with the Drs client.
  2852. */
  2853. export import Types = Drs;
  2854. }
  2855. export = Drs;