route53recoverycontrolconfig.d.ts 52 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949
  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 {WaiterConfiguration} from '../lib/service';
  6. import {ServiceConfigurationOptions} from '../lib/service';
  7. import {ConfigBase as Config} from '../lib/config-base';
  8. interface Blob {}
  9. declare class Route53RecoveryControlConfig extends Service {
  10. /**
  11. * Constructs a service object. This object has one method for each API operation.
  12. */
  13. constructor(options?: Route53RecoveryControlConfig.Types.ClientConfiguration)
  14. config: Config & Route53RecoveryControlConfig.Types.ClientConfiguration;
  15. /**
  16. * Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane.
  17. */
  18. createCluster(params: Route53RecoveryControlConfig.Types.CreateClusterRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.CreateClusterResponse) => void): Request<Route53RecoveryControlConfig.Types.CreateClusterResponse, AWSError>;
  19. /**
  20. * Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane.
  21. */
  22. createCluster(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.CreateClusterResponse) => void): Request<Route53RecoveryControlConfig.Types.CreateClusterResponse, AWSError>;
  23. /**
  24. * Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region.
  25. */
  26. createControlPanel(params: Route53RecoveryControlConfig.Types.CreateControlPanelRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.CreateControlPanelResponse) => void): Request<Route53RecoveryControlConfig.Types.CreateControlPanelResponse, AWSError>;
  27. /**
  28. * Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region.
  29. */
  30. createControlPanel(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.CreateControlPanelResponse) => void): Request<Route53RecoveryControlConfig.Types.CreateControlPanelResponse, AWSError>;
  31. /**
  32. * Creates a new routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.
  33. */
  34. createRoutingControl(params: Route53RecoveryControlConfig.Types.CreateRoutingControlRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.CreateRoutingControlResponse) => void): Request<Route53RecoveryControlConfig.Types.CreateRoutingControlResponse, AWSError>;
  35. /**
  36. * Creates a new routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.
  37. */
  38. createRoutingControl(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.CreateRoutingControlResponse) => void): Request<Route53RecoveryControlConfig.Types.CreateRoutingControlResponse, AWSError>;
  39. /**
  40. * Creates a safety rule in a control panel. Safety rules let you add safeguards around changing routing control states, and for enabling and disabling routing controls, to help prevent unexpected outcomes. There are two types of safety rules: assertion rules and gating rules. Assertion rule: An assertion rule enforces that, when you change a routing control state, that a certain criteria is met. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario. Gating rule: A gating rule lets you configure a gating routing control as an overall "on/off" switch for a group of routing controls. Or, you can configure more complex gating scenarios, for example by configuring multiple gating routing controls. For more information, see Safety rules in the Amazon Route 53 Application Recovery Controller Developer Guide.
  41. */
  42. createSafetyRule(params: Route53RecoveryControlConfig.Types.CreateSafetyRuleRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.CreateSafetyRuleResponse) => void): Request<Route53RecoveryControlConfig.Types.CreateSafetyRuleResponse, AWSError>;
  43. /**
  44. * Creates a safety rule in a control panel. Safety rules let you add safeguards around changing routing control states, and for enabling and disabling routing controls, to help prevent unexpected outcomes. There are two types of safety rules: assertion rules and gating rules. Assertion rule: An assertion rule enforces that, when you change a routing control state, that a certain criteria is met. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario. Gating rule: A gating rule lets you configure a gating routing control as an overall "on/off" switch for a group of routing controls. Or, you can configure more complex gating scenarios, for example by configuring multiple gating routing controls. For more information, see Safety rules in the Amazon Route 53 Application Recovery Controller Developer Guide.
  45. */
  46. createSafetyRule(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.CreateSafetyRuleResponse) => void): Request<Route53RecoveryControlConfig.Types.CreateSafetyRuleResponse, AWSError>;
  47. /**
  48. * Delete a cluster.
  49. */
  50. deleteCluster(params: Route53RecoveryControlConfig.Types.DeleteClusterRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DeleteClusterResponse) => void): Request<Route53RecoveryControlConfig.Types.DeleteClusterResponse, AWSError>;
  51. /**
  52. * Delete a cluster.
  53. */
  54. deleteCluster(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DeleteClusterResponse) => void): Request<Route53RecoveryControlConfig.Types.DeleteClusterResponse, AWSError>;
  55. /**
  56. * Deletes a control panel.
  57. */
  58. deleteControlPanel(params: Route53RecoveryControlConfig.Types.DeleteControlPanelRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DeleteControlPanelResponse) => void): Request<Route53RecoveryControlConfig.Types.DeleteControlPanelResponse, AWSError>;
  59. /**
  60. * Deletes a control panel.
  61. */
  62. deleteControlPanel(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DeleteControlPanelResponse) => void): Request<Route53RecoveryControlConfig.Types.DeleteControlPanelResponse, AWSError>;
  63. /**
  64. * Deletes a routing control.
  65. */
  66. deleteRoutingControl(params: Route53RecoveryControlConfig.Types.DeleteRoutingControlRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DeleteRoutingControlResponse) => void): Request<Route53RecoveryControlConfig.Types.DeleteRoutingControlResponse, AWSError>;
  67. /**
  68. * Deletes a routing control.
  69. */
  70. deleteRoutingControl(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DeleteRoutingControlResponse) => void): Request<Route53RecoveryControlConfig.Types.DeleteRoutingControlResponse, AWSError>;
  71. /**
  72. * Deletes a safety rule./&gt;
  73. */
  74. deleteSafetyRule(params: Route53RecoveryControlConfig.Types.DeleteSafetyRuleRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DeleteSafetyRuleResponse) => void): Request<Route53RecoveryControlConfig.Types.DeleteSafetyRuleResponse, AWSError>;
  75. /**
  76. * Deletes a safety rule./&gt;
  77. */
  78. deleteSafetyRule(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DeleteSafetyRuleResponse) => void): Request<Route53RecoveryControlConfig.Types.DeleteSafetyRuleResponse, AWSError>;
  79. /**
  80. * Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).
  81. */
  82. describeCluster(params: Route53RecoveryControlConfig.Types.DescribeClusterRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeClusterResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeClusterResponse, AWSError>;
  83. /**
  84. * Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).
  85. */
  86. describeCluster(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeClusterResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeClusterResponse, AWSError>;
  87. /**
  88. * Displays details about a control panel.
  89. */
  90. describeControlPanel(params: Route53RecoveryControlConfig.Types.DescribeControlPanelRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeControlPanelResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeControlPanelResponse, AWSError>;
  91. /**
  92. * Displays details about a control panel.
  93. */
  94. describeControlPanel(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeControlPanelResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeControlPanelResponse, AWSError>;
  95. /**
  96. * Displays details about a routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.
  97. */
  98. describeRoutingControl(params: Route53RecoveryControlConfig.Types.DescribeRoutingControlRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeRoutingControlResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeRoutingControlResponse, AWSError>;
  99. /**
  100. * Displays details about a routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.
  101. */
  102. describeRoutingControl(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeRoutingControlResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeRoutingControlResponse, AWSError>;
  103. /**
  104. * Returns information about a safety rule.
  105. */
  106. describeSafetyRule(params: Route53RecoveryControlConfig.Types.DescribeSafetyRuleRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeSafetyRuleResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeSafetyRuleResponse, AWSError>;
  107. /**
  108. * Returns information about a safety rule.
  109. */
  110. describeSafetyRule(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeSafetyRuleResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeSafetyRuleResponse, AWSError>;
  111. /**
  112. * Get information about the resource policy for a cluster.
  113. */
  114. getResourcePolicy(params: Route53RecoveryControlConfig.Types.GetResourcePolicyRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.GetResourcePolicyResponse) => void): Request<Route53RecoveryControlConfig.Types.GetResourcePolicyResponse, AWSError>;
  115. /**
  116. * Get information about the resource policy for a cluster.
  117. */
  118. getResourcePolicy(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.GetResourcePolicyResponse) => void): Request<Route53RecoveryControlConfig.Types.GetResourcePolicyResponse, AWSError>;
  119. /**
  120. * Returns an array of all Amazon Route 53 health checks associated with a specific routing control.
  121. */
  122. listAssociatedRoute53HealthChecks(params: Route53RecoveryControlConfig.Types.ListAssociatedRoute53HealthChecksRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.ListAssociatedRoute53HealthChecksResponse) => void): Request<Route53RecoveryControlConfig.Types.ListAssociatedRoute53HealthChecksResponse, AWSError>;
  123. /**
  124. * Returns an array of all Amazon Route 53 health checks associated with a specific routing control.
  125. */
  126. listAssociatedRoute53HealthChecks(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.ListAssociatedRoute53HealthChecksResponse) => void): Request<Route53RecoveryControlConfig.Types.ListAssociatedRoute53HealthChecksResponse, AWSError>;
  127. /**
  128. * Returns an array of all the clusters in an account.
  129. */
  130. listClusters(params: Route53RecoveryControlConfig.Types.ListClustersRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.ListClustersResponse) => void): Request<Route53RecoveryControlConfig.Types.ListClustersResponse, AWSError>;
  131. /**
  132. * Returns an array of all the clusters in an account.
  133. */
  134. listClusters(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.ListClustersResponse) => void): Request<Route53RecoveryControlConfig.Types.ListClustersResponse, AWSError>;
  135. /**
  136. * Returns an array of control panels in an account or in a cluster.
  137. */
  138. listControlPanels(params: Route53RecoveryControlConfig.Types.ListControlPanelsRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.ListControlPanelsResponse) => void): Request<Route53RecoveryControlConfig.Types.ListControlPanelsResponse, AWSError>;
  139. /**
  140. * Returns an array of control panels in an account or in a cluster.
  141. */
  142. listControlPanels(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.ListControlPanelsResponse) => void): Request<Route53RecoveryControlConfig.Types.ListControlPanelsResponse, AWSError>;
  143. /**
  144. * Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.
  145. */
  146. listRoutingControls(params: Route53RecoveryControlConfig.Types.ListRoutingControlsRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.ListRoutingControlsResponse) => void): Request<Route53RecoveryControlConfig.Types.ListRoutingControlsResponse, AWSError>;
  147. /**
  148. * Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.
  149. */
  150. listRoutingControls(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.ListRoutingControlsResponse) => void): Request<Route53RecoveryControlConfig.Types.ListRoutingControlsResponse, AWSError>;
  151. /**
  152. * List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.
  153. */
  154. listSafetyRules(params: Route53RecoveryControlConfig.Types.ListSafetyRulesRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.ListSafetyRulesResponse) => void): Request<Route53RecoveryControlConfig.Types.ListSafetyRulesResponse, AWSError>;
  155. /**
  156. * List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.
  157. */
  158. listSafetyRules(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.ListSafetyRulesResponse) => void): Request<Route53RecoveryControlConfig.Types.ListSafetyRulesResponse, AWSError>;
  159. /**
  160. * Lists the tags for a resource.
  161. */
  162. listTagsForResource(params: Route53RecoveryControlConfig.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.ListTagsForResourceResponse) => void): Request<Route53RecoveryControlConfig.Types.ListTagsForResourceResponse, AWSError>;
  163. /**
  164. * Lists the tags for a resource.
  165. */
  166. listTagsForResource(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.ListTagsForResourceResponse) => void): Request<Route53RecoveryControlConfig.Types.ListTagsForResourceResponse, AWSError>;
  167. /**
  168. * Adds a tag to a resource.
  169. */
  170. tagResource(params: Route53RecoveryControlConfig.Types.TagResourceRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.TagResourceResponse) => void): Request<Route53RecoveryControlConfig.Types.TagResourceResponse, AWSError>;
  171. /**
  172. * Adds a tag to a resource.
  173. */
  174. tagResource(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.TagResourceResponse) => void): Request<Route53RecoveryControlConfig.Types.TagResourceResponse, AWSError>;
  175. /**
  176. * Removes a tag from a resource.
  177. */
  178. untagResource(params: Route53RecoveryControlConfig.Types.UntagResourceRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.UntagResourceResponse) => void): Request<Route53RecoveryControlConfig.Types.UntagResourceResponse, AWSError>;
  179. /**
  180. * Removes a tag from a resource.
  181. */
  182. untagResource(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.UntagResourceResponse) => void): Request<Route53RecoveryControlConfig.Types.UntagResourceResponse, AWSError>;
  183. /**
  184. * Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.
  185. */
  186. updateControlPanel(params: Route53RecoveryControlConfig.Types.UpdateControlPanelRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.UpdateControlPanelResponse) => void): Request<Route53RecoveryControlConfig.Types.UpdateControlPanelResponse, AWSError>;
  187. /**
  188. * Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.
  189. */
  190. updateControlPanel(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.UpdateControlPanelResponse) => void): Request<Route53RecoveryControlConfig.Types.UpdateControlPanelResponse, AWSError>;
  191. /**
  192. * Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.
  193. */
  194. updateRoutingControl(params: Route53RecoveryControlConfig.Types.UpdateRoutingControlRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.UpdateRoutingControlResponse) => void): Request<Route53RecoveryControlConfig.Types.UpdateRoutingControlResponse, AWSError>;
  195. /**
  196. * Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.
  197. */
  198. updateRoutingControl(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.UpdateRoutingControlResponse) => void): Request<Route53RecoveryControlConfig.Types.UpdateRoutingControlResponse, AWSError>;
  199. /**
  200. * Update a safety rule (an assertion rule or gating rule). You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new one.
  201. */
  202. updateSafetyRule(params: Route53RecoveryControlConfig.Types.UpdateSafetyRuleRequest, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.UpdateSafetyRuleResponse) => void): Request<Route53RecoveryControlConfig.Types.UpdateSafetyRuleResponse, AWSError>;
  203. /**
  204. * Update a safety rule (an assertion rule or gating rule). You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new one.
  205. */
  206. updateSafetyRule(callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.UpdateSafetyRuleResponse) => void): Request<Route53RecoveryControlConfig.Types.UpdateSafetyRuleResponse, AWSError>;
  207. /**
  208. * Waits for the clusterCreated state by periodically calling the underlying Route53RecoveryControlConfig.describeClusteroperation every 5 seconds (at most 26 times). Wait until a cluster is created
  209. */
  210. waitFor(state: "clusterCreated", params: Route53RecoveryControlConfig.Types.DescribeClusterRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeClusterResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeClusterResponse, AWSError>;
  211. /**
  212. * Waits for the clusterCreated state by periodically calling the underlying Route53RecoveryControlConfig.describeClusteroperation every 5 seconds (at most 26 times). Wait until a cluster is created
  213. */
  214. waitFor(state: "clusterCreated", callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeClusterResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeClusterResponse, AWSError>;
  215. /**
  216. * Waits for the clusterDeleted state by periodically calling the underlying Route53RecoveryControlConfig.describeClusteroperation every 5 seconds (at most 26 times). Wait for a cluster to be deleted
  217. */
  218. waitFor(state: "clusterDeleted", params: Route53RecoveryControlConfig.Types.DescribeClusterRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeClusterResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeClusterResponse, AWSError>;
  219. /**
  220. * Waits for the clusterDeleted state by periodically calling the underlying Route53RecoveryControlConfig.describeClusteroperation every 5 seconds (at most 26 times). Wait for a cluster to be deleted
  221. */
  222. waitFor(state: "clusterDeleted", callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeClusterResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeClusterResponse, AWSError>;
  223. /**
  224. * Waits for the controlPanelCreated state by periodically calling the underlying Route53RecoveryControlConfig.describeControlPaneloperation every 5 seconds (at most 26 times). Wait until a control panel is created
  225. */
  226. waitFor(state: "controlPanelCreated", params: Route53RecoveryControlConfig.Types.DescribeControlPanelRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeControlPanelResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeControlPanelResponse, AWSError>;
  227. /**
  228. * Waits for the controlPanelCreated state by periodically calling the underlying Route53RecoveryControlConfig.describeControlPaneloperation every 5 seconds (at most 26 times). Wait until a control panel is created
  229. */
  230. waitFor(state: "controlPanelCreated", callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeControlPanelResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeControlPanelResponse, AWSError>;
  231. /**
  232. * Waits for the controlPanelDeleted state by periodically calling the underlying Route53RecoveryControlConfig.describeControlPaneloperation every 5 seconds (at most 26 times). Wait until a control panel is deleted
  233. */
  234. waitFor(state: "controlPanelDeleted", params: Route53RecoveryControlConfig.Types.DescribeControlPanelRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeControlPanelResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeControlPanelResponse, AWSError>;
  235. /**
  236. * Waits for the controlPanelDeleted state by periodically calling the underlying Route53RecoveryControlConfig.describeControlPaneloperation every 5 seconds (at most 26 times). Wait until a control panel is deleted
  237. */
  238. waitFor(state: "controlPanelDeleted", callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeControlPanelResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeControlPanelResponse, AWSError>;
  239. /**
  240. * Waits for the routingControlCreated state by periodically calling the underlying Route53RecoveryControlConfig.describeRoutingControloperation every 5 seconds (at most 26 times). Wait until a routing control is created
  241. */
  242. waitFor(state: "routingControlCreated", params: Route53RecoveryControlConfig.Types.DescribeRoutingControlRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeRoutingControlResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeRoutingControlResponse, AWSError>;
  243. /**
  244. * Waits for the routingControlCreated state by periodically calling the underlying Route53RecoveryControlConfig.describeRoutingControloperation every 5 seconds (at most 26 times). Wait until a routing control is created
  245. */
  246. waitFor(state: "routingControlCreated", callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeRoutingControlResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeRoutingControlResponse, AWSError>;
  247. /**
  248. * Waits for the routingControlDeleted state by periodically calling the underlying Route53RecoveryControlConfig.describeRoutingControloperation every 5 seconds (at most 26 times). Wait for a routing control to be deleted
  249. */
  250. waitFor(state: "routingControlDeleted", params: Route53RecoveryControlConfig.Types.DescribeRoutingControlRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeRoutingControlResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeRoutingControlResponse, AWSError>;
  251. /**
  252. * Waits for the routingControlDeleted state by periodically calling the underlying Route53RecoveryControlConfig.describeRoutingControloperation every 5 seconds (at most 26 times). Wait for a routing control to be deleted
  253. */
  254. waitFor(state: "routingControlDeleted", callback?: (err: AWSError, data: Route53RecoveryControlConfig.Types.DescribeRoutingControlResponse) => void): Request<Route53RecoveryControlConfig.Types.DescribeRoutingControlResponse, AWSError>;
  255. }
  256. declare namespace Route53RecoveryControlConfig {
  257. export interface AssertionRule {
  258. /**
  259. * The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.
  260. */
  261. AssertedControls: __listOf__stringMin1Max256PatternAZaZ09;
  262. /**
  263. * The Amazon Resource Name (ARN) of the control panel.
  264. */
  265. ControlPanelArn: __stringMin1Max256PatternAZaZ09;
  266. /**
  267. * Name of the assertion rule. You can use any non-white space character in the name.
  268. */
  269. Name: __stringMin1Max64PatternS;
  270. /**
  271. * The criteria that you set for specific assertion routing controls (AssertedControls) that designate how many routing control states must be ON as the result of a transaction. For example, if you have three assertion routing controls, you might specify ATLEAST 2 for your rule configuration. This means that at least two assertion routing control states must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.
  272. */
  273. RuleConfig: RuleConfig;
  274. /**
  275. * The Amazon Resource Name (ARN) of the assertion rule.
  276. */
  277. SafetyRuleArn: __stringMin1Max256PatternAZaZ09;
  278. /**
  279. * The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
  280. */
  281. Status: Status;
  282. /**
  283. * An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
  284. */
  285. WaitPeriodMs: __integer;
  286. /**
  287. * The Amazon Web Services account ID of the assertion rule owner.
  288. */
  289. Owner?: __stringMin12Max12PatternD12;
  290. }
  291. export interface AssertionRuleUpdate {
  292. /**
  293. * The name of the assertion rule. You can use any non-white space character in the name.
  294. */
  295. Name: __stringMin1Max64PatternS;
  296. /**
  297. * The Amazon Resource Name (ARN) of the assertion rule.
  298. */
  299. SafetyRuleArn: __stringMin1Max256PatternAZaZ09;
  300. /**
  301. * An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
  302. */
  303. WaitPeriodMs: __integer;
  304. }
  305. export interface Cluster {
  306. /**
  307. * The Amazon Resource Name (ARN) of the cluster.
  308. */
  309. ClusterArn?: __stringMin1Max256PatternAZaZ09;
  310. /**
  311. * Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster. To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.
  312. */
  313. ClusterEndpoints?: __listOfClusterEndpoint;
  314. /**
  315. * The name of the cluster.
  316. */
  317. Name?: __stringMin1Max64PatternS;
  318. /**
  319. * Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
  320. */
  321. Status?: Status;
  322. /**
  323. * The Amazon Web Services account ID of the cluster owner.
  324. */
  325. Owner?: __stringMin12Max12PatternD12;
  326. }
  327. export interface ClusterEndpoint {
  328. /**
  329. * A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster. To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.
  330. */
  331. Endpoint?: __stringMin1Max128PatternAZaZ09;
  332. /**
  333. * The Amazon Web Services Region for a cluster endpoint.
  334. */
  335. Region?: __stringMin1Max32PatternS;
  336. }
  337. export interface ControlPanel {
  338. /**
  339. * The Amazon Resource Name (ARN) of the cluster that includes the control panel.
  340. */
  341. ClusterArn?: __stringMin1Max256PatternAZaZ09;
  342. /**
  343. * The Amazon Resource Name (ARN) of the control panel.
  344. */
  345. ControlPanelArn?: __stringMin1Max256PatternAZaZ09;
  346. /**
  347. * A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.
  348. */
  349. DefaultControlPanel?: __boolean;
  350. /**
  351. * The name of the control panel. You can use any non-white space character in the name.
  352. */
  353. Name?: __stringMin1Max64PatternS;
  354. /**
  355. * The number of routing controls in the control panel.
  356. */
  357. RoutingControlCount?: __integer;
  358. /**
  359. * The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
  360. */
  361. Status?: Status;
  362. /**
  363. * The Amazon Web Services account ID of the control panel owner.
  364. */
  365. Owner?: __stringMin12Max12PatternD12;
  366. }
  367. export interface CreateClusterRequest {
  368. /**
  369. * A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.
  370. */
  371. ClientToken?: __stringMin1Max64PatternS;
  372. /**
  373. * The name of the cluster.
  374. */
  375. ClusterName: __stringMin1Max64PatternS;
  376. /**
  377. * The tags associated with the cluster.
  378. */
  379. Tags?: __mapOf__stringMin0Max256PatternS;
  380. }
  381. export interface CreateClusterResponse {
  382. /**
  383. * The cluster that was created.
  384. */
  385. Cluster?: Cluster;
  386. }
  387. export interface CreateControlPanelRequest {
  388. /**
  389. * A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.
  390. */
  391. ClientToken?: __stringMin1Max64PatternS;
  392. /**
  393. * The Amazon Resource Name (ARN) of the cluster for the control panel.
  394. */
  395. ClusterArn: __stringMin1Max256PatternAZaZ09;
  396. /**
  397. * The name of the control panel.
  398. */
  399. ControlPanelName: __stringMin1Max64PatternS;
  400. /**
  401. * The tags associated with the control panel.
  402. */
  403. Tags?: __mapOf__stringMin0Max256PatternS;
  404. }
  405. export interface CreateControlPanelResponse {
  406. /**
  407. * Information about a control panel.
  408. */
  409. ControlPanel?: ControlPanel;
  410. }
  411. export interface CreateRoutingControlRequest {
  412. /**
  413. * A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.
  414. */
  415. ClientToken?: __stringMin1Max64PatternS;
  416. /**
  417. * The Amazon Resource Name (ARN) of the cluster that includes the routing control.
  418. */
  419. ClusterArn: __stringMin1Max256PatternAZaZ09;
  420. /**
  421. * The Amazon Resource Name (ARN) of the control panel that includes the routing control.
  422. */
  423. ControlPanelArn?: __stringMin1Max256PatternAZaZ09;
  424. /**
  425. * The name of the routing control.
  426. */
  427. RoutingControlName: __stringMin1Max64PatternS;
  428. }
  429. export interface CreateRoutingControlResponse {
  430. /**
  431. * The routing control that is created.
  432. */
  433. RoutingControl?: RoutingControl;
  434. }
  435. export interface CreateSafetyRuleRequest {
  436. /**
  437. * The assertion rule requested.
  438. */
  439. AssertionRule?: NewAssertionRule;
  440. /**
  441. * A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.
  442. */
  443. ClientToken?: __stringMin1Max64PatternS;
  444. /**
  445. * The gating rule requested.
  446. */
  447. GatingRule?: NewGatingRule;
  448. /**
  449. * The tags associated with the safety rule.
  450. */
  451. Tags?: __mapOf__stringMin0Max256PatternS;
  452. }
  453. export interface CreateSafetyRuleResponse {
  454. /**
  455. * The assertion rule created.
  456. */
  457. AssertionRule?: AssertionRule;
  458. /**
  459. * The gating rule created.
  460. */
  461. GatingRule?: GatingRule;
  462. }
  463. export interface DeleteClusterRequest {
  464. /**
  465. * The Amazon Resource Name (ARN) of the cluster that you're deleting.
  466. */
  467. ClusterArn: __string;
  468. }
  469. export interface DeleteClusterResponse {
  470. }
  471. export interface DeleteControlPanelRequest {
  472. /**
  473. * The Amazon Resource Name (ARN) of the control panel.
  474. */
  475. ControlPanelArn: __string;
  476. }
  477. export interface DeleteControlPanelResponse {
  478. }
  479. export interface DeleteRoutingControlRequest {
  480. /**
  481. * The Amazon Resource Name (ARN) of the routing control that you're deleting.
  482. */
  483. RoutingControlArn: __string;
  484. }
  485. export interface DeleteRoutingControlResponse {
  486. }
  487. export interface DeleteSafetyRuleRequest {
  488. /**
  489. * The ARN of the safety rule.
  490. */
  491. SafetyRuleArn: __string;
  492. }
  493. export interface DeleteSafetyRuleResponse {
  494. }
  495. export interface DescribeClusterRequest {
  496. /**
  497. * The Amazon Resource Name (ARN) of the cluster.
  498. */
  499. ClusterArn: __string;
  500. }
  501. export interface DescribeClusterResponse {
  502. /**
  503. * The cluster for the DescribeCluster request.
  504. */
  505. Cluster?: Cluster;
  506. }
  507. export interface DescribeControlPanelRequest {
  508. /**
  509. * The Amazon Resource Name (ARN) of the control panel.
  510. */
  511. ControlPanelArn: __string;
  512. }
  513. export interface DescribeControlPanelResponse {
  514. /**
  515. * Information about the control panel.
  516. */
  517. ControlPanel?: ControlPanel;
  518. }
  519. export interface DescribeRoutingControlRequest {
  520. /**
  521. * The Amazon Resource Name (ARN) of the routing control.
  522. */
  523. RoutingControlArn: __string;
  524. }
  525. export interface DescribeRoutingControlResponse {
  526. /**
  527. * Information about the routing control.
  528. */
  529. RoutingControl?: RoutingControl;
  530. }
  531. export interface DescribeSafetyRuleRequest {
  532. /**
  533. * The ARN of the safety rule.
  534. */
  535. SafetyRuleArn: __string;
  536. }
  537. export interface DescribeSafetyRuleResponse {
  538. /**
  539. * The assertion rule in the response.
  540. */
  541. AssertionRule?: AssertionRule;
  542. /**
  543. * The gating rule in the response.
  544. */
  545. GatingRule?: GatingRule;
  546. }
  547. export interface GatingRule {
  548. /**
  549. * The Amazon Resource Name (ARN) of the control panel.
  550. */
  551. ControlPanelArn: __stringMin1Max256PatternAZaZ09;
  552. /**
  553. * An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.
  554. */
  555. GatingControls: __listOf__stringMin1Max256PatternAZaZ09;
  556. /**
  557. * The name for the gating rule. You can use any non-white space character in the name.
  558. */
  559. Name: __stringMin1Max64PatternS;
  560. /**
  561. * The criteria that you set for gating routing controls that designate how many of the routing control states must be ON to allow you to update target routing control states.
  562. */
  563. RuleConfig: RuleConfig;
  564. /**
  565. * The Amazon Resource Name (ARN) of the gating rule.
  566. */
  567. SafetyRuleArn: __stringMin1Max256PatternAZaZ09;
  568. /**
  569. * The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
  570. */
  571. Status: Status;
  572. /**
  573. * An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated failover, for example.
  574. */
  575. TargetControls: __listOf__stringMin1Max256PatternAZaZ09;
  576. /**
  577. * An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
  578. */
  579. WaitPeriodMs: __integer;
  580. /**
  581. * The Amazon Web Services account ID of the gating rule owner.
  582. */
  583. Owner?: __stringMin12Max12PatternD12;
  584. }
  585. export interface GatingRuleUpdate {
  586. /**
  587. * The name for the gating rule. You can use any non-white space character in the name.
  588. */
  589. Name: __stringMin1Max64PatternS;
  590. /**
  591. * The Amazon Resource Name (ARN) of the gating rule.
  592. */
  593. SafetyRuleArn: __stringMin1Max256PatternAZaZ09;
  594. /**
  595. * An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
  596. */
  597. WaitPeriodMs: __integer;
  598. }
  599. export interface GetResourcePolicyRequest {
  600. /**
  601. * The Amazon Resource Name (ARN) of the resource.
  602. */
  603. ResourceArn: __string;
  604. }
  605. export interface GetResourcePolicyResponse {
  606. /**
  607. * The resource policy.
  608. */
  609. Policy?: __policy;
  610. }
  611. export interface ListAssociatedRoute53HealthChecksRequest {
  612. /**
  613. * The number of objects that you want to return with this call.
  614. */
  615. MaxResults?: MaxResults;
  616. /**
  617. * The token that identifies which batch of results you want to see.
  618. */
  619. NextToken?: __string;
  620. /**
  621. * The Amazon Resource Name (ARN) of the routing control.
  622. */
  623. RoutingControlArn: __string;
  624. }
  625. export interface ListAssociatedRoute53HealthChecksResponse {
  626. /**
  627. * Identifiers for the health checks.
  628. */
  629. HealthCheckIds?: __listOf__stringMax36PatternS;
  630. /**
  631. * Next token for listing health checks.
  632. */
  633. NextToken?: __stringMin1Max8096PatternS;
  634. }
  635. export interface ListClustersRequest {
  636. /**
  637. * The number of objects that you want to return with this call.
  638. */
  639. MaxResults?: MaxResults;
  640. /**
  641. * The token that identifies which batch of results you want to see.
  642. */
  643. NextToken?: __string;
  644. }
  645. export interface ListClustersResponse {
  646. /**
  647. * An array of the clusters in an account.
  648. */
  649. Clusters?: __listOfCluster;
  650. /**
  651. * The token that identifies which batch of results you want to see.
  652. */
  653. NextToken?: __stringMin1Max8096PatternS;
  654. }
  655. export interface ListControlPanelsRequest {
  656. /**
  657. * The Amazon Resource Name (ARN) of a cluster.
  658. */
  659. ClusterArn?: __string;
  660. /**
  661. * The number of objects that you want to return with this call.
  662. */
  663. MaxResults?: MaxResults;
  664. /**
  665. * The token that identifies which batch of results you want to see.
  666. */
  667. NextToken?: __string;
  668. }
  669. export interface ListControlPanelsResponse {
  670. /**
  671. * The result of a successful ListControlPanel request.
  672. */
  673. ControlPanels?: __listOfControlPanel;
  674. /**
  675. * The token that identifies which batch of results you want to see.
  676. */
  677. NextToken?: __stringMin1Max8096PatternS;
  678. }
  679. export interface ListRoutingControlsRequest {
  680. /**
  681. * The Amazon Resource Name (ARN) of the control panel.
  682. */
  683. ControlPanelArn: __string;
  684. /**
  685. * The number of objects that you want to return with this call.
  686. */
  687. MaxResults?: MaxResults;
  688. /**
  689. * The token that identifies which batch of results you want to see.
  690. */
  691. NextToken?: __string;
  692. }
  693. export interface ListRoutingControlsResponse {
  694. /**
  695. * The token that identifies which batch of results you want to see.
  696. */
  697. NextToken?: __stringMin1Max8096PatternS;
  698. /**
  699. * An array of routing controls.
  700. */
  701. RoutingControls?: __listOfRoutingControl;
  702. }
  703. export interface ListSafetyRulesRequest {
  704. /**
  705. * The Amazon Resource Name (ARN) of the control panel.
  706. */
  707. ControlPanelArn: __string;
  708. /**
  709. * The number of objects that you want to return with this call.
  710. */
  711. MaxResults?: MaxResults;
  712. /**
  713. * The token that identifies which batch of results you want to see.
  714. */
  715. NextToken?: __string;
  716. }
  717. export interface ListSafetyRulesResponse {
  718. /**
  719. * The token that identifies which batch of results you want to see.
  720. */
  721. NextToken?: __stringMin1Max8096PatternS;
  722. /**
  723. * The list of safety rules in a control panel.
  724. */
  725. SafetyRules?: __listOfRule;
  726. }
  727. export interface ListTagsForResourceRequest {
  728. /**
  729. * The Amazon Resource Name (ARN) for the resource that's tagged.
  730. */
  731. ResourceArn: __string;
  732. }
  733. export interface ListTagsForResourceResponse {
  734. /**
  735. * The tags associated with the resource.
  736. */
  737. Tags?: __mapOf__stringMin0Max256PatternS;
  738. }
  739. export type MaxResults = number;
  740. export interface NewAssertionRule {
  741. /**
  742. * The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.
  743. */
  744. AssertedControls: __listOf__stringMin1Max256PatternAZaZ09;
  745. /**
  746. * The Amazon Resource Name (ARN) for the control panel.
  747. */
  748. ControlPanelArn: __stringMin1Max256PatternAZaZ09;
  749. /**
  750. * The name of the assertion rule. You can use any non-white space character in the name.
  751. */
  752. Name: __stringMin1Max64PatternS;
  753. /**
  754. * The criteria that you set for specific assertion controls (routing controls) that designate how many control states must be ON as the result of a transaction. For example, if you have three assertion controls, you might specify ATLEAST 2 for your rule configuration. This means that at least two assertion controls must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.
  755. */
  756. RuleConfig: RuleConfig;
  757. /**
  758. * An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
  759. */
  760. WaitPeriodMs: __integer;
  761. }
  762. export interface NewGatingRule {
  763. /**
  764. * The Amazon Resource Name (ARN) of the control panel.
  765. */
  766. ControlPanelArn: __stringMin1Max256PatternAZaZ09;
  767. /**
  768. * The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
  769. */
  770. GatingControls: __listOf__stringMin1Max256PatternAZaZ09;
  771. /**
  772. * The name for the new gating rule.
  773. */
  774. Name: __stringMin1Max64PatternS;
  775. /**
  776. * The criteria that you set for specific gating controls (routing controls) that designate how many control states must be ON to allow you to change (set or unset) the target control states.
  777. */
  778. RuleConfig: RuleConfig;
  779. /**
  780. * Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true. In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
  781. */
  782. TargetControls: __listOf__stringMin1Max256PatternAZaZ09;
  783. /**
  784. * An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
  785. */
  786. WaitPeriodMs: __integer;
  787. }
  788. export interface RoutingControl {
  789. /**
  790. * The Amazon Resource Name (ARN) of the control panel that includes the routing control.
  791. */
  792. ControlPanelArn?: __stringMin1Max256PatternAZaZ09;
  793. /**
  794. * The name of the routing control.
  795. */
  796. Name?: __stringMin1Max64PatternS;
  797. /**
  798. * The Amazon Resource Name (ARN) of the routing control.
  799. */
  800. RoutingControlArn?: __stringMin1Max256PatternAZaZ09;
  801. /**
  802. * The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
  803. */
  804. Status?: Status;
  805. /**
  806. * The Amazon Web Services account ID of the routing control owner.
  807. */
  808. Owner?: __stringMin12Max12PatternD12;
  809. }
  810. export interface Rule {
  811. /**
  812. * An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control state is not accepted. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.
  813. */
  814. ASSERTION?: AssertionRule;
  815. /**
  816. * A gating rule verifies that a gating routing control or set of gating routing controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete. For example, if you specify one gating routing control and you set the Type in the rule configuration to OR, that indicates that you must set the gating routing control to On for the rule to evaluate as true; that is, for the gating control "switch" to be "On". When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.
  817. */
  818. GATING?: GatingRule;
  819. }
  820. export interface RuleConfig {
  821. /**
  822. * Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
  823. */
  824. Inverted: __boolean;
  825. /**
  826. * The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.
  827. */
  828. Threshold: __integer;
  829. /**
  830. * A rule can be one of the following: ATLEAST, AND, or OR.
  831. */
  832. Type: RuleType;
  833. }
  834. export type RuleType = "ATLEAST"|"AND"|"OR"|string;
  835. export type Status = "PENDING"|"DEPLOYED"|"PENDING_DELETION"|string;
  836. export interface TagResourceRequest {
  837. /**
  838. * The Amazon Resource Name (ARN) for the resource that's tagged.
  839. */
  840. ResourceArn: __string;
  841. /**
  842. * The tags associated with the resource.
  843. */
  844. Tags: __mapOf__stringMin0Max256PatternS;
  845. }
  846. export interface TagResourceResponse {
  847. }
  848. export interface UntagResourceRequest {
  849. /**
  850. * The Amazon Resource Name (ARN) for the resource that's tagged.
  851. */
  852. ResourceArn: __string;
  853. /**
  854. * Keys for the tags to be removed.
  855. */
  856. TagKeys: __listOf__string;
  857. }
  858. export interface UntagResourceResponse {
  859. }
  860. export interface UpdateControlPanelRequest {
  861. /**
  862. * The Amazon Resource Name (ARN) of the control panel.
  863. */
  864. ControlPanelArn: __stringMin1Max256PatternAZaZ09;
  865. /**
  866. * The name of the control panel.
  867. */
  868. ControlPanelName: __stringMin1Max64PatternS;
  869. }
  870. export interface UpdateControlPanelResponse {
  871. /**
  872. * The control panel to update.
  873. */
  874. ControlPanel?: ControlPanel;
  875. }
  876. export interface UpdateRoutingControlRequest {
  877. /**
  878. * The Amazon Resource Name (ARN) of the routing control.
  879. */
  880. RoutingControlArn: __stringMin1Max256PatternAZaZ09;
  881. /**
  882. * The name of the routing control.
  883. */
  884. RoutingControlName: __stringMin1Max64PatternS;
  885. }
  886. export interface UpdateRoutingControlResponse {
  887. /**
  888. * The routing control that was updated.
  889. */
  890. RoutingControl?: RoutingControl;
  891. }
  892. export interface UpdateSafetyRuleRequest {
  893. /**
  894. * The assertion rule to update.
  895. */
  896. AssertionRuleUpdate?: AssertionRuleUpdate;
  897. /**
  898. * The gating rule to update.
  899. */
  900. GatingRuleUpdate?: GatingRuleUpdate;
  901. }
  902. export interface UpdateSafetyRuleResponse {
  903. /**
  904. * The assertion rule updated.
  905. */
  906. AssertionRule?: AssertionRule;
  907. /**
  908. * The gating rule updated.
  909. */
  910. GatingRule?: GatingRule;
  911. }
  912. export type __boolean = boolean;
  913. export type __integer = number;
  914. export type __listOfCluster = Cluster[];
  915. export type __listOfClusterEndpoint = ClusterEndpoint[];
  916. export type __listOfControlPanel = ControlPanel[];
  917. export type __listOfRoutingControl = RoutingControl[];
  918. export type __listOfRule = Rule[];
  919. export type __listOf__string = __string[];
  920. export type __listOf__stringMax36PatternS = __stringMax36PatternS[];
  921. export type __listOf__stringMin1Max256PatternAZaZ09 = __stringMin1Max256PatternAZaZ09[];
  922. export type __mapOf__stringMin0Max256PatternS = {[key: string]: __stringMin0Max256PatternS};
  923. export type __string = string;
  924. export type __stringMax36PatternS = string;
  925. export type __stringMin0Max256PatternS = string;
  926. export type __stringMin12Max12PatternD12 = string;
  927. export type __stringMin1Max128PatternAZaZ09 = string;
  928. export type __stringMin1Max256PatternAZaZ09 = string;
  929. export type __stringMin1Max32PatternS = string;
  930. export type __stringMin1Max64PatternS = string;
  931. export type __stringMin1Max8096PatternS = string;
  932. export type __policy = string;
  933. /**
  934. * 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.
  935. */
  936. export type apiVersion = "2020-11-02"|"latest"|string;
  937. export interface ClientApiVersions {
  938. /**
  939. * 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.
  940. */
  941. apiVersion?: apiVersion;
  942. }
  943. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  944. /**
  945. * Contains interfaces for use with the Route53RecoveryControlConfig client.
  946. */
  947. export import Types = Route53RecoveryControlConfig;
  948. }
  949. export = Route53RecoveryControlConfig;