@aws-sdk/client-route53-recovery-cluster 3.53.0 → 3.55.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/README.md +31 -14
  3. package/dist-cjs/Route53RecoveryClusterClient.js +13 -13
  4. package/dist-cjs/commands/GetRoutingControlStateCommand.js +3 -3
  5. package/dist-cjs/commands/UpdateRoutingControlStateCommand.js +3 -3
  6. package/dist-cjs/commands/UpdateRoutingControlStatesCommand.js +3 -3
  7. package/dist-cjs/endpoints.js +1 -1
  8. package/dist-cjs/protocols/Aws_json1_0.js +46 -28
  9. package/dist-cjs/runtimeConfig.browser.js +4 -4
  10. package/dist-cjs/runtimeConfig.js +9 -9
  11. package/dist-cjs/runtimeConfig.native.js +1 -1
  12. package/dist-es/Route53RecoveryCluster.js +3 -3
  13. package/dist-es/protocols/Aws_json1_0.js +19 -3
  14. package/dist-types/Route53RecoveryCluster.d.ts +131 -36
  15. package/dist-types/Route53RecoveryClusterClient.d.ts +36 -19
  16. package/dist-types/commands/GetRoutingControlStateCommand.d.ts +30 -10
  17. package/dist-types/commands/UpdateRoutingControlStateCommand.d.ts +34 -5
  18. package/dist-types/commands/UpdateRoutingControlStatesCommand.d.ts +33 -4
  19. package/dist-types/models/models_0.d.ts +18 -2
  20. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  21. package/dist-types/runtimeConfig.d.ts +1 -1
  22. package/dist-types/runtimeConfig.native.d.ts +3 -3
  23. package/dist-types/ts3.4/Route53RecoveryClusterClient.d.ts +2 -2
  24. package/dist-types/ts3.4/models/models_0.d.ts +4 -0
  25. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
  26. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
  27. package/dist-types/ts3.4/runtimeConfig.native.d.ts +3 -3
  28. package/package.json +34 -34
package/dist-types/Route53RecoveryCluster.d.ts CHANGED
@@ -4,61 +4,156 @@ import { UpdateRoutingControlStateCommandInput, UpdateRoutingControlStateCommand
4
4
  import { UpdateRoutingControlStatesCommandInput, UpdateRoutingControlStatesCommandOutput } from "./commands/UpdateRoutingControlStatesCommand";
5
5
  import { Route53RecoveryClusterClient } from "./Route53RecoveryClusterClient";
6
6
  /**
7
- * <p>Welcome to the Amazon Route 53 Application Recovery Controller API Reference Guide for Recovery Control Data Plane .</p>
8
- * <p>Recovery control in Route 53 Application Recovery Controller includes extremely reliable routing controls that enable you to recover applications
9
- * by rerouting traffic, for example, across Availability Zones or AWS Regions. Routing controls are simple on/off switches
10
- * hosted on a cluster. A cluster is a set of five redundant regional endpoints against which you can execute API calls to update or
11
- * get the state of routing controls. You use routing controls to failover traffic to recover your application
12
- * across Availability Zones or Regions.</p>
13
- * <p>This API guide includes information about how to get and update routing control states in Route 53 Application Recovery Controller.</p>
14
- * <p>For more information about Route 53 Application Recovery Controller, see the following:</p>
15
- * <ul>
7
+ * <p>Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.</p>
8
+ * <p>With Amazon Route 53 Application Recovery Controller, you can use routing control with extreme reliability to
9
+ * recover applications by rerouting traffic across
10
+ * Availability Zones or AWS Regions. Routing controls are simple on/off switches hosted
11
+ * on a highly available cluster in Application Recovery Controller. A cluster provides a set of five redundant Regional endpoints against which you
12
+ * can run API calls to get or update the state of routing controls. To implement failover, you set
13
+ * one routing control on and another one off, to reroute traffic from one Availability Zone or Amazon Web Services Region
14
+ * to another. </p>
15
+ * <p>
16
+ * <i>Be aware that you must specify the Regional endpoints for a cluster when you work with API cluster operations
17
+ * to get or update routing control states in Application Recovery Controller.</i> In addition, you must specify the US West (Oregon) Region
18
+ * for Application Recovery Controller API calls. For example, use the parameter <code>region us-west-2</code> with AWS CLI commands.
19
+ * For more information, see
20
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.api.html">
21
+ * Get and update routing control states using the API</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
22
+ * <p>This API guide includes information about the API operations for how to get and update routing control states
23
+ * in Application Recovery Controller. You also must set up the structures to support routing controls: clusters and control panels.</p>
24
+ * <p>For more information about working with routing control in Application Recovery Controller, see the following:</p>
25
+ * <ul>
16
26
  * <li>
17
- * <p>You can create clusters, routing controls, and control panels by using the control plane API for Recovery
18
- * Control. For more information, see <a href="https://docs.aws.amazon.com/recovery-cluster/latest/api/">Amazon Route 53 Application Recovery Controller Recovery Control API Reference</a>.</p>
19
- * </li>
27
+ * <p>To create clusters, routing controls, and control panels by using the control plane API
28
+ * for routing control, see the <a href="https://docs.aws.amazon.com/recovery-cluster/latest/api/">Recovery Control Configuration API Reference Guide for Amazon Route 53 Application Recovery Controller</a>.</p>
29
+ * </li>
20
30
  * <li>
21
- * <p>Route 53 Application Recovery Controller also provides continuous readiness checks to ensure that your applications are scaled to handle failover traffic.
22
- * For more information about the related API actions, see <a href="https://docs.aws.amazon.com/recovery-readiness/latest/api/">Amazon Route 53 Application Recovery Controller Recovery Readiness API Reference</a>.</p>
31
+ * <p>Learn about the components in recovery control configuration, including clusters,
32
+ * routing controls, and control panels. For more information, see
33
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/introduction-components.html#introduction-components-routing">
34
+ * Recovery control components</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
23
35
  * </li>
24
36
  * <li>
25
- * <p>For more information about creating resilient applications and preparing for recovery readiness with Route 53 Application Recovery Controller,
26
- * see the <a href="r53recovery/latest/dg/">Amazon Route 53 Application Recovery Controller Developer Guide</a>.</p>
27
- * </li>
37
+ * <p>Application Recovery Controller also provides readiness checks that run continually to help make sure that your
38
+ * applications are scaled and ready to handle failover traffic. For more information about
39
+ * the related API actions, see the <a href="https://docs.aws.amazon.com/recovery-readiness/latest/api/">Recovery Readiness API Reference Guide for Amazon Route 53 Application Recovery Controller</a>.</p>
40
+ * </li>
41
+ * <li>
42
+ * <p>For more information about creating resilient applications and preparing for
43
+ * recovery readiness with Application Recovery Controller, see the <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/">Amazon Route 53 Application Recovery Controller Developer Guide</a>.</p>
44
+ * </li>
28
45
  * </ul>
29
46
  */
30
47
  export declare class Route53RecoveryCluster extends Route53RecoveryClusterClient {
31
48
  /**
32
- * <p>Get the state for a routing control. A routing control is a simple on/off switch
33
- * that you can use to route traffic to cells. When the state is On, traffic flows to a cell. When it's off, traffic does not flow. </p>
34
- * <p>Before you can create a routing control, you first must create a cluster to host the control.
35
- * For more information, see
36
- * <a href="https://docs.aws.amazon.com/recovery-cluster/latest/api/cluster.html">CreateCluster</a>.
37
- * Access one of the endpoints for the cluster to get or update the routing control state to
38
- * redirect traffic.</p>
39
- * <p>For more information about working with routing controls, see
40
- * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Routing control</a>
41
- * in the Route 53 Application Recovery Controller Developer Guide.</p>
49
+ * <p>Get the state for a routing control. A routing control is a simple on/off switch that you
50
+ * can use to route traffic to cells. When the state is On, traffic flows to a cell. When
51
+ * it's Off, traffic does not flow. </p>
52
+ * <p>Before you can create a routing control, you must first create a cluster to host the control
53
+ * in a control panel. For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html">
54
+ * Create routing control structures</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.
55
+ * Then you access one of the endpoints for the cluster to get or update the routing control state to
56
+ * redirect traffic. </p>
57
+ * <p>
58
+ * <i>You must specify Regional endpoints when you work with API cluster operations
59
+ * to get or update routing control states in Application Recovery Controller.</i>
60
+ * </p>
61
+ * <p>To see a code example for getting a routing control state, including accessing Regional cluster endpoints
62
+ * in sequence, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html">API examples</a>
63
+ * in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
64
+ * <p>Learn more about working with routing controls in the following topics in the
65
+ * Amazon Route 53 Application Recovery Controller Developer Guide:</p>
66
+ * <ul>
67
+ * <li>
68
+ * <p>
69
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html">
70
+ * Viewing and updating routing control states</a>
71
+ * </p>
72
+ * </li>
73
+ * <li>
74
+ * <p>
75
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Working with routing controls overall</a>
76
+ * </p>
77
+ * </li>
78
+ * </ul>
42
79
  */
43
80
  getRoutingControlState(args: GetRoutingControlStateCommandInput, options?: __HttpHandlerOptions): Promise<GetRoutingControlStateCommandOutput>;
44
81
  getRoutingControlState(args: GetRoutingControlStateCommandInput, cb: (err: any, data?: GetRoutingControlStateCommandOutput) => void): void;
45
82
  getRoutingControlState(args: GetRoutingControlStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRoutingControlStateCommandOutput) => void): void;
46
83
  /**
47
- * <p>Set the state of the routing control to reroute traffic. You can set the value to be On or Off.
48
- * When the state is On, traffic flows to a cell. When it's off, traffic does not flow.</p>
49
- * <p>For more information about working with routing controls, see
50
- * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Routing control</a>
51
- * in the Route 53 Application Recovery Controller Developer Guide.</p>
84
+ * <p>Set the state of the routing control to reroute traffic. You can set the value to be On or
85
+ * Off. When the state is On, traffic flows to a cell. When it's Off, traffic does not
86
+ * flow.</p>
87
+ * <p>With Application Recovery Controller, you can add safety rules for routing controls, which are safeguards for routing
88
+ * control state updates that help prevent unexpected outcomes, like fail open traffic routing. However,
89
+ * there are scenarios when you might want to bypass the routing control safeguards that are enforced with
90
+ * safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery,
91
+ * and one or more safety rules might be unexpectedly preventing you from updating a routing control state to
92
+ * reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change
93
+ * a routing control state and fail over your application.</p>
94
+ * <p>The <code>SafetyRulesToOverride</code> property enables you override one or more safety rules and
95
+ * update routing control states. For more information, see
96
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html">
97
+ * Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
98
+ * <p>
99
+ * <i>You must specify Regional endpoints when you work with API cluster operations
100
+ * to get or update routing control states in Application Recovery Controller.</i>
101
+ * </p>
102
+ * <p>To see a code example for getting a routing control state, including accessing Regional cluster endpoints
103
+ * in sequence, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html">API examples</a>
104
+ * in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
105
+ * <ul>
106
+ * <li>
107
+ * <p>
108
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html">
109
+ * Viewing and updating routing control states</a>
110
+ * </p>
111
+ * </li>
112
+ * <li>
113
+ * <p>
114
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Working with routing controls overall</a>
115
+ * </p>
116
+ * </li>
117
+ * </ul>
52
118
  */
53
119
  updateRoutingControlState(args: UpdateRoutingControlStateCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRoutingControlStateCommandOutput>;
54
120
  updateRoutingControlState(args: UpdateRoutingControlStateCommandInput, cb: (err: any, data?: UpdateRoutingControlStateCommandOutput) => void): void;
55
121
  updateRoutingControlState(args: UpdateRoutingControlStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoutingControlStateCommandOutput) => void): void;
56
122
  /**
57
123
  * <p>Set multiple routing control states. You can set the value for each state to be On or Off.
58
- * When the state is On, traffic flows to a cell. When it's off, traffic does not flow.</p>
59
- * <p>For more information about working with routing controls, see
60
- * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Routing control</a>
61
- * in the Route 53 Application Recovery Controller Developer Guide.</p>
124
+ * When the state is On, traffic flows to a cell. When it's Off, traffic does not
125
+ * flow.</p>
126
+ * <p>With Application Recovery Controller, you can add safety rules for routing controls, which are safeguards for routing
127
+ * control state updates that help prevent unexpected outcomes, like fail open traffic routing. However,
128
+ * there are scenarios when you might want to bypass the routing control safeguards that are enforced with
129
+ * safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery,
130
+ * and one or more safety rules might be unexpectedly preventing you from updating a routing control state to
131
+ * reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change
132
+ * a routing control state and fail over your application.</p>
133
+ * <p>The <code>SafetyRulesToOverride</code> property enables you override one or more safety rules and
134
+ * update routing control states. For more information, see
135
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html">
136
+ * Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
137
+ * <p>
138
+ * <i>You must specify Regional endpoints when you work with API cluster operations
139
+ * to get or update routing control states in Application Recovery Controller.</i>
140
+ * </p>
141
+ * <p>To see a code example for getting a routing control state, including accessing Regional cluster endpoints
142
+ * in sequence, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html">API examples</a>
143
+ * in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
144
+ * <ul>
145
+ * <li>
146
+ * <p>
147
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html">
148
+ * Viewing and updating routing control states</a>
149
+ * </p>
150
+ * </li>
151
+ * <li>
152
+ * <p>
153
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Working with routing controls overall</a>
154
+ * </p>
155
+ * </li>
156
+ * </ul>
62
157
  */
63
158
  updateRoutingControlStates(args: UpdateRoutingControlStatesCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRoutingControlStatesCommandOutput>;
64
159
  updateRoutingControlStates(args: UpdateRoutingControlStatesCommandInput, cb: (err: any, data?: UpdateRoutingControlStatesCommandOutput) => void): void;
package/dist-types/Route53RecoveryClusterClient.d.ts CHANGED
@@ -5,7 +5,7 @@ import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-s
5
5
  import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
6
6
  import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
7
7
  import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
8
- import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
8
+ import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
9
9
  import { GetRoutingControlStateCommandInput, GetRoutingControlStateCommandOutput } from "./commands/GetRoutingControlStateCommand";
10
10
  import { UpdateRoutingControlStateCommandInput, UpdateRoutingControlStateCommandOutput } from "./commands/UpdateRoutingControlStateCommand";
11
11
  import { UpdateRoutingControlStatesCommandInput, UpdateRoutingControlStatesCommandOutput } from "./commands/UpdateRoutingControlStatesCommand";
@@ -31,7 +31,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
31
31
  * A function that can calculate the length of a request body.
32
32
  * @internal
33
33
  */
34
- bodyLengthChecker?: (body: any) => number | undefined;
34
+ bodyLengthChecker?: __BodyLengthCalculator;
35
35
  /**
36
36
  * A function that converts a stream into an array of bytes.
37
37
  * @internal
@@ -129,27 +129,44 @@ declare type Route53RecoveryClusterClientResolvedConfigType = __SmithyResolvedCo
129
129
  export interface Route53RecoveryClusterClientResolvedConfig extends Route53RecoveryClusterClientResolvedConfigType {
130
130
  }
131
131
  /**
132
- * <p>Welcome to the Amazon Route 53 Application Recovery Controller API Reference Guide for Recovery Control Data Plane .</p>
133
- * <p>Recovery control in Route 53 Application Recovery Controller includes extremely reliable routing controls that enable you to recover applications
134
- * by rerouting traffic, for example, across Availability Zones or AWS Regions. Routing controls are simple on/off switches
135
- * hosted on a cluster. A cluster is a set of five redundant regional endpoints against which you can execute API calls to update or
136
- * get the state of routing controls. You use routing controls to failover traffic to recover your application
137
- * across Availability Zones or Regions.</p>
138
- * <p>This API guide includes information about how to get and update routing control states in Route 53 Application Recovery Controller.</p>
139
- * <p>For more information about Route 53 Application Recovery Controller, see the following:</p>
140
- * <ul>
132
+ * <p>Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.</p>
133
+ * <p>With Amazon Route 53 Application Recovery Controller, you can use routing control with extreme reliability to
134
+ * recover applications by rerouting traffic across
135
+ * Availability Zones or AWS Regions. Routing controls are simple on/off switches hosted
136
+ * on a highly available cluster in Application Recovery Controller. A cluster provides a set of five redundant Regional endpoints against which you
137
+ * can run API calls to get or update the state of routing controls. To implement failover, you set
138
+ * one routing control on and another one off, to reroute traffic from one Availability Zone or Amazon Web Services Region
139
+ * to another. </p>
140
+ * <p>
141
+ * <i>Be aware that you must specify the Regional endpoints for a cluster when you work with API cluster operations
142
+ * to get or update routing control states in Application Recovery Controller.</i> In addition, you must specify the US West (Oregon) Region
143
+ * for Application Recovery Controller API calls. For example, use the parameter <code>region us-west-2</code> with AWS CLI commands.
144
+ * For more information, see
145
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.api.html">
146
+ * Get and update routing control states using the API</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
147
+ * <p>This API guide includes information about the API operations for how to get and update routing control states
148
+ * in Application Recovery Controller. You also must set up the structures to support routing controls: clusters and control panels.</p>
149
+ * <p>For more information about working with routing control in Application Recovery Controller, see the following:</p>
150
+ * <ul>
141
151
  * <li>
142
- * <p>You can create clusters, routing controls, and control panels by using the control plane API for Recovery
143
- * Control. For more information, see <a href="https://docs.aws.amazon.com/recovery-cluster/latest/api/">Amazon Route 53 Application Recovery Controller Recovery Control API Reference</a>.</p>
144
- * </li>
152
+ * <p>To create clusters, routing controls, and control panels by using the control plane API
153
+ * for routing control, see the <a href="https://docs.aws.amazon.com/recovery-cluster/latest/api/">Recovery Control Configuration API Reference Guide for Amazon Route 53 Application Recovery Controller</a>.</p>
154
+ * </li>
145
155
  * <li>
146
- * <p>Route 53 Application Recovery Controller also provides continuous readiness checks to ensure that your applications are scaled to handle failover traffic.
147
- * For more information about the related API actions, see <a href="https://docs.aws.amazon.com/recovery-readiness/latest/api/">Amazon Route 53 Application Recovery Controller Recovery Readiness API Reference</a>.</p>
156
+ * <p>Learn about the components in recovery control configuration, including clusters,
157
+ * routing controls, and control panels. For more information, see
158
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/introduction-components.html#introduction-components-routing">
159
+ * Recovery control components</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
148
160
  * </li>
149
161
  * <li>
150
- * <p>For more information about creating resilient applications and preparing for recovery readiness with Route 53 Application Recovery Controller,
151
- * see the <a href="r53recovery/latest/dg/">Amazon Route 53 Application Recovery Controller Developer Guide</a>.</p>
152
- * </li>
162
+ * <p>Application Recovery Controller also provides readiness checks that run continually to help make sure that your
163
+ * applications are scaled and ready to handle failover traffic. For more information about
164
+ * the related API actions, see the <a href="https://docs.aws.amazon.com/recovery-readiness/latest/api/">Recovery Readiness API Reference Guide for Amazon Route 53 Application Recovery Controller</a>.</p>
165
+ * </li>
166
+ * <li>
167
+ * <p>For more information about creating resilient applications and preparing for
168
+ * recovery readiness with Application Recovery Controller, see the <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/">Amazon Route 53 Application Recovery Controller Developer Guide</a>.</p>
169
+ * </li>
153
170
  * </ul>
154
171
  */
155
172
  export declare class Route53RecoveryClusterClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, Route53RecoveryClusterClientResolvedConfig> {
package/dist-types/commands/GetRoutingControlStateCommand.d.ts CHANGED
@@ -7,16 +7,36 @@ export interface GetRoutingControlStateCommandInput extends GetRoutingControlSta
7
7
  export interface GetRoutingControlStateCommandOutput extends GetRoutingControlStateResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Get the state for a routing control. A routing control is a simple on/off switch
11
- * that you can use to route traffic to cells. When the state is On, traffic flows to a cell. When it's off, traffic does not flow. </p>
12
- * <p>Before you can create a routing control, you first must create a cluster to host the control.
13
- * For more information, see
14
- * <a href="https://docs.aws.amazon.com/recovery-cluster/latest/api/cluster.html">CreateCluster</a>.
15
- * Access one of the endpoints for the cluster to get or update the routing control state to
16
- * redirect traffic.</p>
17
- * <p>For more information about working with routing controls, see
18
- * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Routing control</a>
19
- * in the Route 53 Application Recovery Controller Developer Guide.</p>
10
+ * <p>Get the state for a routing control. A routing control is a simple on/off switch that you
11
+ * can use to route traffic to cells. When the state is On, traffic flows to a cell. When
12
+ * it's Off, traffic does not flow. </p>
13
+ * <p>Before you can create a routing control, you must first create a cluster to host the control
14
+ * in a control panel. For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html">
15
+ * Create routing control structures</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.
16
+ * Then you access one of the endpoints for the cluster to get or update the routing control state to
17
+ * redirect traffic. </p>
18
+ * <p>
19
+ * <i>You must specify Regional endpoints when you work with API cluster operations
20
+ * to get or update routing control states in Application Recovery Controller.</i>
21
+ * </p>
22
+ * <p>To see a code example for getting a routing control state, including accessing Regional cluster endpoints
23
+ * in sequence, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html">API examples</a>
24
+ * in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
25
+ * <p>Learn more about working with routing controls in the following topics in the
26
+ * Amazon Route 53 Application Recovery Controller Developer Guide:</p>
27
+ * <ul>
28
+ * <li>
29
+ * <p>
30
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html">
31
+ * Viewing and updating routing control states</a>
32
+ * </p>
33
+ * </li>
34
+ * <li>
35
+ * <p>
36
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Working with routing controls overall</a>
37
+ * </p>
38
+ * </li>
39
+ * </ul>
20
40
  * @example
21
41
  * Use a bare-bones client and the command you need to make an API call.
22
42
  * ```javascript
package/dist-types/commands/UpdateRoutingControlStateCommand.d.ts CHANGED
@@ -7,11 +7,40 @@ export interface UpdateRoutingControlStateCommandInput extends UpdateRoutingCont
7
7
  export interface UpdateRoutingControlStateCommandOutput extends UpdateRoutingControlStateResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Set the state of the routing control to reroute traffic. You can set the value to be On or Off.
11
- * When the state is On, traffic flows to a cell. When it's off, traffic does not flow.</p>
12
- * <p>For more information about working with routing controls, see
13
- * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Routing control</a>
14
- * in the Route 53 Application Recovery Controller Developer Guide.</p>
10
+ * <p>Set the state of the routing control to reroute traffic. You can set the value to be On or
11
+ * Off. When the state is On, traffic flows to a cell. When it's Off, traffic does not
12
+ * flow.</p>
13
+ * <p>With Application Recovery Controller, you can add safety rules for routing controls, which are safeguards for routing
14
+ * control state updates that help prevent unexpected outcomes, like fail open traffic routing. However,
15
+ * there are scenarios when you might want to bypass the routing control safeguards that are enforced with
16
+ * safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery,
17
+ * and one or more safety rules might be unexpectedly preventing you from updating a routing control state to
18
+ * reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change
19
+ * a routing control state and fail over your application.</p>
20
+ * <p>The <code>SafetyRulesToOverride</code> property enables you override one or more safety rules and
21
+ * update routing control states. For more information, see
22
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html">
23
+ * Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
24
+ * <p>
25
+ * <i>You must specify Regional endpoints when you work with API cluster operations
26
+ * to get or update routing control states in Application Recovery Controller.</i>
27
+ * </p>
28
+ * <p>To see a code example for getting a routing control state, including accessing Regional cluster endpoints
29
+ * in sequence, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html">API examples</a>
30
+ * in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
31
+ * <ul>
32
+ * <li>
33
+ * <p>
34
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html">
35
+ * Viewing and updating routing control states</a>
36
+ * </p>
37
+ * </li>
38
+ * <li>
39
+ * <p>
40
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Working with routing controls overall</a>
41
+ * </p>
42
+ * </li>
43
+ * </ul>
15
44
  * @example
16
45
  * Use a bare-bones client and the command you need to make an API call.
17
46
  * ```javascript
package/dist-types/commands/UpdateRoutingControlStatesCommand.d.ts CHANGED
@@ -8,10 +8,39 @@ export interface UpdateRoutingControlStatesCommandOutput extends UpdateRoutingCo
8
8
  }
9
9
  /**
10
10
  * <p>Set multiple routing control states. You can set the value for each state to be On or Off.
11
- * When the state is On, traffic flows to a cell. When it's off, traffic does not flow.</p>
12
- * <p>For more information about working with routing controls, see
13
- * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Routing control</a>
14
- * in the Route 53 Application Recovery Controller Developer Guide.</p>
11
+ * When the state is On, traffic flows to a cell. When it's Off, traffic does not
12
+ * flow.</p>
13
+ * <p>With Application Recovery Controller, you can add safety rules for routing controls, which are safeguards for routing
14
+ * control state updates that help prevent unexpected outcomes, like fail open traffic routing. However,
15
+ * there are scenarios when you might want to bypass the routing control safeguards that are enforced with
16
+ * safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery,
17
+ * and one or more safety rules might be unexpectedly preventing you from updating a routing control state to
18
+ * reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change
19
+ * a routing control state and fail over your application.</p>
20
+ * <p>The <code>SafetyRulesToOverride</code> property enables you override one or more safety rules and
21
+ * update routing control states. For more information, see
22
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html">
23
+ * Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
24
+ * <p>
25
+ * <i>You must specify Regional endpoints when you work with API cluster operations
26
+ * to get or update routing control states in Application Recovery Controller.</i>
27
+ * </p>
28
+ * <p>To see a code example for getting a routing control state, including accessing Regional cluster endpoints
29
+ * in sequence, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html">API examples</a>
30
+ * in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
31
+ * <ul>
32
+ * <li>
33
+ * <p>
34
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html">
35
+ * Viewing and updating routing control states</a>
36
+ * </p>
37
+ * </li>
38
+ * <li>
39
+ * <p>
40
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Working with routing controls overall</a>
41
+ * </p>
42
+ * </li>
43
+ * </ul>
15
44
  * @example
16
45
  * Use a bare-bones client and the command you need to make an API call.
17
46
  * ```javascript
package/dist-types/models/models_0.d.ts CHANGED
@@ -175,6 +175,14 @@ export interface UpdateRoutingControlStateRequest {
175
175
  * <p>The state of the routing control. You can set the value to be On or Off.</p>
176
176
  */
177
177
  RoutingControlState: RoutingControlState | string | undefined;
178
+ /**
179
+ * <p>The Amazon Resource Numbers (ARNs) for the safety rules that you want to override when you're updating the state of
180
+ * a routing control. You can override one safety rule or multiple safety rules by including one or more ARNs, separated
181
+ * by commas.</p>
182
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html">
183
+ * Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
184
+ */
185
+ SafetyRulesToOverride?: string[];
178
186
  }
179
187
  export declare namespace UpdateRoutingControlStateRequest {
180
188
  /**
@@ -191,11 +199,11 @@ export declare namespace UpdateRoutingControlStateResponse {
191
199
  const filterSensitiveLog: (obj: UpdateRoutingControlStateResponse) => any;
192
200
  }
193
201
  /**
194
- * <p>A routing control state.</p>
202
+ * <p>A routing control state entry.</p>
195
203
  */
196
204
  export interface UpdateRoutingControlStateEntry {
197
205
  /**
198
- * <p>The Amazon Resource Number (ARN) for the routing control state entry.</p>
206
+ * <p>The Amazon Resource Number (ARN) for a routing control state entry.</p>
199
207
  */
200
208
  RoutingControlArn: string | undefined;
201
209
  /**
@@ -214,6 +222,14 @@ export interface UpdateRoutingControlStatesRequest {
214
222
  * <p>A set of routing control entries that you want to update.</p>
215
223
  */
216
224
  UpdateRoutingControlStateEntries: UpdateRoutingControlStateEntry[] | undefined;
225
+ /**
226
+ * <p>The Amazon Resource Numbers (ARNs) for the safety rules that you want to override when you're updating routing
227
+ * control states. You can override one safety rule or multiple safety rules by including one or more ARNs, separated
228
+ * by commas.</p>
229
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html">
230
+ * Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
231
+ */
232
+ SafetyRulesToOverride?: string[];
217
233
  }
218
234
  export declare namespace UpdateRoutingControlStatesRequest {
219
235
  /**
package/dist-types/runtimeConfig.browser.d.ts CHANGED
@@ -8,7 +8,7 @@ export declare const getRuntimeConfig: (config: Route53RecoveryClusterClientConf
8
8
  defaultsMode: import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").ResolvedDefaultsMode>;
9
9
  base64Decoder: import("@aws-sdk/types").Decoder;
10
10
  base64Encoder: import("@aws-sdk/types").Encoder;
11
- bodyLengthChecker: (body: any) => number | undefined;
11
+ bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
12
12
  credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
13
13
  defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
14
14
  maxAttempts: number | import("@aws-sdk/types").Provider<number>;
package/dist-types/runtimeConfig.d.ts CHANGED
@@ -8,7 +8,7 @@ export declare const getRuntimeConfig: (config: Route53RecoveryClusterClientConf
8
8
  defaultsMode: import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").ResolvedDefaultsMode>;
9
9
  base64Decoder: import("@aws-sdk/types").Decoder;
10
10
  base64Encoder: import("@aws-sdk/types").Encoder;
11
- bodyLengthChecker: (body: any) => number | undefined;
11
+ bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
12
12
  credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
13
13
  defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
14
14
  maxAttempts: number | import("@aws-sdk/types").Provider<number>;
package/dist-types/runtimeConfig.native.d.ts CHANGED
@@ -8,7 +8,7 @@ export declare const getRuntimeConfig: (config: Route53RecoveryClusterClientConf
8
8
  requestHandler: (import("@aws-sdk/types").RequestHandler<any, any, import("@aws-sdk/types").HttpHandlerOptions> & import("@aws-sdk/protocol-http").HttpHandler) | import("@aws-sdk/fetch-http-handler").FetchHttpHandler;
9
9
  apiVersion: string;
10
10
  urlParser: import("@aws-sdk/types").UrlParser;
11
- bodyLengthChecker: (body: any) => number | undefined;
11
+ bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
12
12
  streamCollector: import("@aws-sdk/types").StreamCollector;
13
13
  base64Decoder: import("@aws-sdk/types").Decoder;
14
14
  base64Encoder: import("@aws-sdk/types").Encoder;
@@ -21,11 +21,11 @@ export declare const getRuntimeConfig: (config: Route53RecoveryClusterClientConf
21
21
  useDualstackEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
22
22
  useFipsEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
23
23
  serviceId: string;
24
- region: string | import("@aws-sdk/types").Provider<string> | import("@aws-sdk/types").Provider<any>;
24
+ region: string | import("@aws-sdk/types").Provider<any>;
25
25
  credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
26
26
  regionInfoProvider: import("@aws-sdk/types").RegionInfoProvider;
27
27
  defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
28
- defaultsMode: import("@aws-sdk/smithy-client").DefaultsMode | import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").DefaultsMode> | import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").ResolvedDefaultsMode>;
28
+ defaultsMode: import("@aws-sdk/smithy-client").DefaultsMode | import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").DefaultsMode>;
29
29
  endpoint?: string | import("@aws-sdk/types").Endpoint | import("@aws-sdk/types").Provider<import("@aws-sdk/types").Endpoint> | undefined;
30
30
  tls?: boolean | undefined;
31
31
  retryStrategy?: import("@aws-sdk/types").RetryStrategy | undefined;
package/dist-types/ts3.4/Route53RecoveryClusterClient.d.ts CHANGED
@@ -5,7 +5,7 @@ import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-s
5
5
  import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
6
6
  import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
7
7
  import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
8
- import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
8
+ import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
9
9
  import { GetRoutingControlStateCommandInput, GetRoutingControlStateCommandOutput } from "./commands/GetRoutingControlStateCommand";
10
10
  import { UpdateRoutingControlStateCommandInput, UpdateRoutingControlStateCommandOutput } from "./commands/UpdateRoutingControlStateCommand";
11
11
  import { UpdateRoutingControlStatesCommandInput, UpdateRoutingControlStatesCommandOutput } from "./commands/UpdateRoutingControlStatesCommand";
@@ -19,7 +19,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
19
19
 
20
20
  urlParser?: __UrlParser;
21
21
 
22
- bodyLengthChecker?: (body: any) => number | undefined;
22
+ bodyLengthChecker?: __BodyLengthCalculator;
23
23
 
24
24
  streamCollector?: __StreamCollector;
25
25
 
package/dist-types/ts3.4/models/models_0.d.ts CHANGED
@@ -109,6 +109,8 @@ export interface UpdateRoutingControlStateRequest {
109
109
  RoutingControlArn: string | undefined;
110
110
 
111
111
  RoutingControlState: RoutingControlState | string | undefined;
112
+
113
+ SafetyRulesToOverride?: string[];
112
114
  }
113
115
  export declare namespace UpdateRoutingControlStateRequest {
114
116
 
@@ -134,6 +136,8 @@ export declare namespace UpdateRoutingControlStateEntry {
134
136
  export interface UpdateRoutingControlStatesRequest {
135
137
 
136
138
  UpdateRoutingControlStateEntries: UpdateRoutingControlStateEntry[] | undefined;
139
+
140
+ SafetyRulesToOverride?: string[];
137
141
  }
138
142
  export declare namespace UpdateRoutingControlStatesRequest {
139
143
 
package/dist-types/ts3.4/runtimeConfig.browser.d.ts CHANGED
@@ -6,7 +6,7 @@ export declare const getRuntimeConfig: (config: Route53RecoveryClusterClientConf
6
6
  defaultsMode: import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").ResolvedDefaultsMode>;
7
7
  base64Decoder: import("@aws-sdk/types").Decoder;
8
8
  base64Encoder: import("@aws-sdk/types").Encoder;
9
- bodyLengthChecker: (body: any) => number | undefined;
9
+ bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
10
10
  credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
11
11
  defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
12
12
  maxAttempts: number | import("@aws-sdk/types").Provider<number>;
package/dist-types/ts3.4/runtimeConfig.d.ts CHANGED
@@ -6,7 +6,7 @@ export declare const getRuntimeConfig: (config: Route53RecoveryClusterClientConf
6
6
  defaultsMode: import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").ResolvedDefaultsMode>;
7
7
  base64Decoder: import("@aws-sdk/types").Decoder;
8
8
  base64Encoder: import("@aws-sdk/types").Encoder;
9
- bodyLengthChecker: (body: any) => number | undefined;
9
+ bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
10
10
  credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
11
11
  defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
12
12
  maxAttempts: number | import("@aws-sdk/types").Provider<number>;