@aws-sdk/client-route53-recovery-cluster 3.408.0 → 3.409.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.
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/Route53RecoveryCluster.d.ts +11 -11
- package/dist-types/Route53RecoveryClusterClient.d.ts +11 -11
- package/dist-types/commands/GetRoutingControlStateCommand.d.ts +6 -6
- package/dist-types/commands/ListRoutingControlsCommand.d.ts +6 -6
- package/dist-types/commands/UpdateRoutingControlStateCommand.d.ts +6 -6
- package/dist-types/commands/UpdateRoutingControlStatesCommand.d.ts +5 -5
- package/dist-types/index.d.ts +11 -11
- package/dist-types/models/models_0.d.ts +2 -2
- package/package.json +3 -3
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
|
-
const
|
|
5
|
-
const a = "
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
4
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
5
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }, { conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ endpoint: { url: "https://route53-recovery-cluster-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://route53-recovery-cluster-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ endpoint: { url: "https://route53-recovery-cluster.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://route53-recovery-cluster.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const
|
|
2
|
-
const a = "
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
1
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
2
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }, { conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ endpoint: { url: "https://route53-recovery-cluster-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://route53-recovery-cluster-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ endpoint: { url: "https://route53-recovery-cluster.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://route53-recovery-cluster.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -33,29 +33,29 @@ export interface Route53RecoveryCluster {
|
|
|
33
33
|
/**
|
|
34
34
|
* @public
|
|
35
35
|
* <p>Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.</p>
|
|
36
|
-
*
|
|
36
|
+
* <p>With Route 53 ARC, you can use routing control with extreme reliability to
|
|
37
37
|
* recover applications by rerouting traffic across
|
|
38
38
|
* Availability Zones or Amazon Web Services Regions. Routing controls are simple on/off switches hosted
|
|
39
39
|
* on a highly available cluster in Route 53 ARC. A cluster provides a set of five redundant Regional endpoints against which you
|
|
40
40
|
* can run API calls to get or update the state of routing controls. To implement failover, you set
|
|
41
41
|
* one routing control On and another one Off, to reroute traffic from one Availability Zone or Amazon Web Services Region
|
|
42
42
|
* to another. </p>
|
|
43
|
-
*
|
|
43
|
+
* <p>
|
|
44
44
|
* <i>Be aware that you must specify a Regional endpoint for a cluster when you work with API cluster operations
|
|
45
45
|
* to get or update routing control states in Route 53 ARC.</i> In addition, you must specify the US West (Oregon) Region
|
|
46
46
|
* for Route 53 ARC API calls. For example, use the parameter <code>--region us-west-2</code> with AWS CLI commands.
|
|
47
47
|
* For more information, see
|
|
48
48
|
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.api.html">
|
|
49
49
|
* Get and update routing control states using the API</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
50
|
-
*
|
|
50
|
+
* <p>This API guide includes information about the API operations for how to get and update routing control states
|
|
51
51
|
* in Route 53 ARC. To work with routing control in Route 53 ARC, you must first create the required components (clusters, control
|
|
52
52
|
* panels, and routing controls) using the recovery cluster configuration API.</p>
|
|
53
|
-
*
|
|
54
|
-
*
|
|
53
|
+
* <p>For more information about working with routing control in Route 53 ARC, see the following:</p>
|
|
54
|
+
* <ul>
|
|
55
55
|
* <li>
|
|
56
|
-
*
|
|
56
|
+
* <p>Create clusters, control panels, and routing controls by using API operations. For more information,
|
|
57
57
|
* 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>
|
|
58
|
-
*
|
|
58
|
+
* </li>
|
|
59
59
|
* <li>
|
|
60
60
|
* <p>Learn about the components in recovery control, including clusters,
|
|
61
61
|
* routing controls, and control panels, and how to work with Route 53 ARC in the Amazon Web Services console. For more
|
|
@@ -63,14 +63,14 @@ export interface Route53RecoveryCluster {
|
|
|
63
63
|
* Recovery control components</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
64
64
|
* </li>
|
|
65
65
|
* <li>
|
|
66
|
-
*
|
|
66
|
+
* <p>Route 53 ARC also provides readiness checks that continually audit resources to help make sure that your
|
|
67
67
|
* applications are scaled and ready to handle failover traffic. For more information about
|
|
68
68
|
* the related API operations, 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>
|
|
69
|
-
*
|
|
69
|
+
* </li>
|
|
70
70
|
* <li>
|
|
71
|
-
*
|
|
71
|
+
* <p>For more information about creating resilient applications and preparing for
|
|
72
72
|
* recovery readiness with Route 53 ARC, see the <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/">Amazon Route 53 Application Recovery Controller Developer Guide</a>.</p>
|
|
73
|
-
*
|
|
73
|
+
* </li>
|
|
74
74
|
* </ul>
|
|
75
75
|
*/
|
|
76
76
|
export declare class Route53RecoveryCluster extends Route53RecoveryClusterClient implements Route53RecoveryCluster {
|
|
@@ -155,29 +155,29 @@ export interface Route53RecoveryClusterClientResolvedConfig extends Route53Recov
|
|
|
155
155
|
/**
|
|
156
156
|
* @public
|
|
157
157
|
* <p>Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.</p>
|
|
158
|
-
*
|
|
158
|
+
* <p>With Route 53 ARC, you can use routing control with extreme reliability to
|
|
159
159
|
* recover applications by rerouting traffic across
|
|
160
160
|
* Availability Zones or Amazon Web Services Regions. Routing controls are simple on/off switches hosted
|
|
161
161
|
* on a highly available cluster in Route 53 ARC. A cluster provides a set of five redundant Regional endpoints against which you
|
|
162
162
|
* can run API calls to get or update the state of routing controls. To implement failover, you set
|
|
163
163
|
* one routing control On and another one Off, to reroute traffic from one Availability Zone or Amazon Web Services Region
|
|
164
164
|
* to another. </p>
|
|
165
|
-
*
|
|
165
|
+
* <p>
|
|
166
166
|
* <i>Be aware that you must specify a Regional endpoint for a cluster when you work with API cluster operations
|
|
167
167
|
* to get or update routing control states in Route 53 ARC.</i> In addition, you must specify the US West (Oregon) Region
|
|
168
168
|
* for Route 53 ARC API calls. For example, use the parameter <code>--region us-west-2</code> with AWS CLI commands.
|
|
169
169
|
* For more information, see
|
|
170
170
|
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.api.html">
|
|
171
171
|
* Get and update routing control states using the API</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
172
|
-
*
|
|
172
|
+
* <p>This API guide includes information about the API operations for how to get and update routing control states
|
|
173
173
|
* in Route 53 ARC. To work with routing control in Route 53 ARC, you must first create the required components (clusters, control
|
|
174
174
|
* panels, and routing controls) using the recovery cluster configuration API.</p>
|
|
175
|
-
*
|
|
176
|
-
*
|
|
175
|
+
* <p>For more information about working with routing control in Route 53 ARC, see the following:</p>
|
|
176
|
+
* <ul>
|
|
177
177
|
* <li>
|
|
178
|
-
*
|
|
178
|
+
* <p>Create clusters, control panels, and routing controls by using API operations. For more information,
|
|
179
179
|
* 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>
|
|
180
|
-
*
|
|
180
|
+
* </li>
|
|
181
181
|
* <li>
|
|
182
182
|
* <p>Learn about the components in recovery control, including clusters,
|
|
183
183
|
* routing controls, and control panels, and how to work with Route 53 ARC in the Amazon Web Services console. For more
|
|
@@ -185,14 +185,14 @@ export interface Route53RecoveryClusterClientResolvedConfig extends Route53Recov
|
|
|
185
185
|
* Recovery control components</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
186
186
|
* </li>
|
|
187
187
|
* <li>
|
|
188
|
-
*
|
|
188
|
+
* <p>Route 53 ARC also provides readiness checks that continually audit resources to help make sure that your
|
|
189
189
|
* applications are scaled and ready to handle failover traffic. For more information about
|
|
190
190
|
* the related API operations, 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>
|
|
191
|
-
*
|
|
191
|
+
* </li>
|
|
192
192
|
* <li>
|
|
193
|
-
*
|
|
193
|
+
* <p>For more information about creating resilient applications and preparing for
|
|
194
194
|
* recovery readiness with Route 53 ARC, see the <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/">Amazon Route 53 Application Recovery Controller Developer Guide</a>.</p>
|
|
195
|
-
*
|
|
195
|
+
* </li>
|
|
196
196
|
* </ul>
|
|
197
197
|
*/
|
|
198
198
|
export declare class Route53RecoveryClusterClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, Route53RecoveryClusterClientResolvedConfig> {
|
|
@@ -26,21 +26,21 @@ export interface GetRoutingControlStateCommandOutput extends GetRoutingControlSt
|
|
|
26
26
|
* <p>Get the state for a routing control. A routing control is a simple on/off switch that you
|
|
27
27
|
* can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When
|
|
28
28
|
* the state is Off, traffic does not flow. </p>
|
|
29
|
-
*
|
|
29
|
+
* <p>Before you can create a routing control, you must first create a cluster, and then host the control
|
|
30
30
|
* in a control panel on the cluster. For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html">
|
|
31
31
|
* Create routing control structures</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.
|
|
32
32
|
* You access one of the endpoints for the cluster to get or update the routing control state to
|
|
33
33
|
* redirect traffic for your application. </p>
|
|
34
|
-
*
|
|
34
|
+
* <p>
|
|
35
35
|
* <i>You must specify Regional endpoints when you work with API cluster operations
|
|
36
36
|
* to get or update routing control states in Route 53 ARC.</i>
|
|
37
37
|
* </p>
|
|
38
|
-
*
|
|
38
|
+
* <p>To see a code example for getting a routing control state, including accessing Regional cluster endpoints
|
|
39
39
|
* in sequence, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html">API examples</a>
|
|
40
40
|
* in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
41
|
-
*
|
|
41
|
+
* <p>Learn more about working with routing controls in the following topics in the
|
|
42
42
|
* Amazon Route 53 Application Recovery Controller Developer Guide:</p>
|
|
43
|
-
*
|
|
43
|
+
* <ul>
|
|
44
44
|
* <li>
|
|
45
45
|
* <p>
|
|
46
46
|
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html">
|
|
@@ -67,7 +67,7 @@ export interface GetRoutingControlStateCommandOutput extends GetRoutingControlSt
|
|
|
67
67
|
* const response = await client.send(command);
|
|
68
68
|
* // { // GetRoutingControlStateResponse
|
|
69
69
|
* // RoutingControlArn: "STRING_VALUE", // required
|
|
70
|
-
* // RoutingControlState: "
|
|
70
|
+
* // RoutingControlState: "On" || "Off", // required
|
|
71
71
|
* // RoutingControlName: "STRING_VALUE",
|
|
72
72
|
* // };
|
|
73
73
|
*
|
|
@@ -27,21 +27,21 @@ export interface ListRoutingControlsCommandOutput extends ListRoutingControlsRes
|
|
|
27
27
|
* state for each routing control, along with the control panel name and control panel ARN for the routing controls.
|
|
28
28
|
* If you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists
|
|
29
29
|
* all the routing controls in the cluster.</p>
|
|
30
|
-
*
|
|
30
|
+
* <p>A routing control is a simple on/off switch in Route 53 ARC that you
|
|
31
31
|
* can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When
|
|
32
32
|
* the state is Off, traffic does not flow.</p>
|
|
33
|
-
*
|
|
33
|
+
* <p>Before you can create a routing control, you must first create a cluster, and then host the control
|
|
34
34
|
* in a control panel on the cluster. For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html">
|
|
35
35
|
* Create routing control structures</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.
|
|
36
36
|
* You access one of the endpoints for the cluster to get or update the routing control state to
|
|
37
37
|
* redirect traffic for your application. </p>
|
|
38
|
-
*
|
|
38
|
+
* <p>
|
|
39
39
|
* <i>You must specify Regional endpoints when you work with API cluster operations
|
|
40
40
|
* to use this API operation to list routing controls in Route 53 ARC.</i>
|
|
41
41
|
* </p>
|
|
42
|
-
*
|
|
42
|
+
* <p>Learn more about working with routing controls in the following topics in the
|
|
43
43
|
* Amazon Route 53 Application Recovery Controller Developer Guide:</p>
|
|
44
|
-
*
|
|
44
|
+
* <ul>
|
|
45
45
|
* <li>
|
|
46
46
|
* <p>
|
|
47
47
|
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html">
|
|
@@ -75,7 +75,7 @@ export interface ListRoutingControlsCommandOutput extends ListRoutingControlsRes
|
|
|
75
75
|
* // ControlPanelName: "STRING_VALUE",
|
|
76
76
|
* // RoutingControlArn: "STRING_VALUE",
|
|
77
77
|
* // RoutingControlName: "STRING_VALUE",
|
|
78
|
-
* // RoutingControlState: "
|
|
78
|
+
* // RoutingControlState: "On" || "Off",
|
|
79
79
|
* // },
|
|
80
80
|
* // ],
|
|
81
81
|
* // NextToken: "STRING_VALUE",
|
|
@@ -26,25 +26,25 @@ export interface UpdateRoutingControlStateCommandOutput extends UpdateRoutingCon
|
|
|
26
26
|
* <p>Set the state of the routing control to reroute traffic. You can set the value to be On or
|
|
27
27
|
* Off. When the state is On, traffic flows to a cell. When the state is Off, traffic does not
|
|
28
28
|
* flow.</p>
|
|
29
|
-
*
|
|
29
|
+
* <p>With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing
|
|
30
30
|
* control state updates that help prevent unexpected outcomes, like fail open traffic routing. However,
|
|
31
31
|
* there are scenarios when you might want to bypass the routing control safeguards that are enforced with
|
|
32
32
|
* safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery,
|
|
33
33
|
* and one or more safety rules might be unexpectedly preventing you from updating a routing control state to
|
|
34
34
|
* reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change
|
|
35
35
|
* a routing control state and fail over your application.</p>
|
|
36
|
-
*
|
|
36
|
+
* <p>The <code>SafetyRulesToOverride</code> property enables you override one or more safety rules and
|
|
37
37
|
* update routing control states. For more information, see
|
|
38
38
|
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html">
|
|
39
39
|
* Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
40
|
-
*
|
|
40
|
+
* <p>
|
|
41
41
|
* <i>You must specify Regional endpoints when you work with API cluster operations
|
|
42
42
|
* to get or update routing control states in Route 53 ARC.</i>
|
|
43
43
|
* </p>
|
|
44
|
-
*
|
|
44
|
+
* <p>To see a code example for getting a routing control state, including accessing Regional cluster endpoints
|
|
45
45
|
* in sequence, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html">API examples</a>
|
|
46
46
|
* in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
47
|
-
*
|
|
47
|
+
* <ul>
|
|
48
48
|
* <li>
|
|
49
49
|
* <p>
|
|
50
50
|
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html">
|
|
@@ -65,7 +65,7 @@ export interface UpdateRoutingControlStateCommandOutput extends UpdateRoutingCon
|
|
|
65
65
|
* const client = new Route53RecoveryClusterClient(config);
|
|
66
66
|
* const input = { // UpdateRoutingControlStateRequest
|
|
67
67
|
* RoutingControlArn: "STRING_VALUE", // required
|
|
68
|
-
* RoutingControlState: "
|
|
68
|
+
* RoutingControlState: "On" || "Off", // required
|
|
69
69
|
* SafetyRulesToOverride: [ // Arns
|
|
70
70
|
* "STRING_VALUE",
|
|
71
71
|
* ],
|
|
@@ -26,14 +26,14 @@ export interface UpdateRoutingControlStatesCommandOutput extends UpdateRoutingCo
|
|
|
26
26
|
* <p>Set multiple routing control states. You can set the value for each state to be On or Off.
|
|
27
27
|
* When the state is On, traffic flows to a cell. When it's Off, traffic does not
|
|
28
28
|
* flow.</p>
|
|
29
|
-
*
|
|
29
|
+
* <p>With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing
|
|
30
30
|
* control state updates that help prevent unexpected outcomes, like fail open traffic routing. However,
|
|
31
31
|
* there are scenarios when you might want to bypass the routing control safeguards that are enforced with
|
|
32
32
|
* safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery,
|
|
33
33
|
* and one or more safety rules might be unexpectedly preventing you from updating a routing control state to
|
|
34
34
|
* reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change
|
|
35
35
|
* a routing control state and fail over your application.</p>
|
|
36
|
-
*
|
|
36
|
+
* <p>The <code>SafetyRulesToOverride</code> property enables you override one or more safety rules and
|
|
37
37
|
* update routing control states. For more information, see
|
|
38
38
|
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html">
|
|
39
39
|
* Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
@@ -41,10 +41,10 @@ export interface UpdateRoutingControlStatesCommandOutput extends UpdateRoutingCo
|
|
|
41
41
|
* <i>You must specify Regional endpoints when you work with API cluster operations
|
|
42
42
|
* to get or update routing control states in Route 53 ARC.</i>
|
|
43
43
|
* </p>
|
|
44
|
-
*
|
|
44
|
+
* <p>To see a code example for getting a routing control state, including accessing Regional cluster endpoints
|
|
45
45
|
* in sequence, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html">API examples</a>
|
|
46
46
|
* in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
47
|
-
*
|
|
47
|
+
* <ul>
|
|
48
48
|
* <li>
|
|
49
49
|
* <p>
|
|
50
50
|
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html">
|
|
@@ -67,7 +67,7 @@ export interface UpdateRoutingControlStatesCommandOutput extends UpdateRoutingCo
|
|
|
67
67
|
* UpdateRoutingControlStateEntries: [ // UpdateRoutingControlStateEntries // required
|
|
68
68
|
* { // UpdateRoutingControlStateEntry
|
|
69
69
|
* RoutingControlArn: "STRING_VALUE", // required
|
|
70
|
-
* RoutingControlState: "
|
|
70
|
+
* RoutingControlState: "On" || "Off", // required
|
|
71
71
|
* },
|
|
72
72
|
* ],
|
|
73
73
|
* SafetyRulesToOverride: [ // Arns
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,28 +1,28 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* <p>Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.</p>
|
|
3
|
-
*
|
|
3
|
+
* <p>With Route 53 ARC, you can use routing control with extreme reliability to
|
|
4
4
|
* recover applications by rerouting traffic across
|
|
5
5
|
* Availability Zones or Amazon Web Services Regions. Routing controls are simple on/off switches hosted
|
|
6
6
|
* on a highly available cluster in Route 53 ARC. A cluster provides a set of five redundant Regional endpoints against which you
|
|
7
7
|
* can run API calls to get or update the state of routing controls. To implement failover, you set
|
|
8
8
|
* one routing control On and another one Off, to reroute traffic from one Availability Zone or Amazon Web Services Region
|
|
9
9
|
* to another. </p>
|
|
10
|
-
*
|
|
10
|
+
* <p>
|
|
11
11
|
* <i>Be aware that you must specify a Regional endpoint for a cluster when you work with API cluster operations
|
|
12
12
|
* to get or update routing control states in Route 53 ARC.</i> In addition, you must specify the US West (Oregon) Region
|
|
13
13
|
* for Route 53 ARC API calls. For example, use the parameter <code>--region us-west-2</code> with AWS CLI commands.
|
|
14
14
|
* For more information, see
|
|
15
15
|
* <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.api.html">
|
|
16
16
|
* Get and update routing control states using the API</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>This API guide includes information about the API operations for how to get and update routing control states
|
|
18
18
|
* in Route 53 ARC. To work with routing control in Route 53 ARC, you must first create the required components (clusters, control
|
|
19
19
|
* panels, and routing controls) using the recovery cluster configuration API.</p>
|
|
20
|
-
*
|
|
21
|
-
*
|
|
20
|
+
* <p>For more information about working with routing control in Route 53 ARC, see the following:</p>
|
|
21
|
+
* <ul>
|
|
22
22
|
* <li>
|
|
23
|
-
*
|
|
23
|
+
* <p>Create clusters, control panels, and routing controls by using API operations. For more information,
|
|
24
24
|
* 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>
|
|
25
|
-
*
|
|
25
|
+
* </li>
|
|
26
26
|
* <li>
|
|
27
27
|
* <p>Learn about the components in recovery control, including clusters,
|
|
28
28
|
* routing controls, and control panels, and how to work with Route 53 ARC in the Amazon Web Services console. For more
|
|
@@ -30,14 +30,14 @@
|
|
|
30
30
|
* Recovery control components</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
31
31
|
* </li>
|
|
32
32
|
* <li>
|
|
33
|
-
*
|
|
33
|
+
* <p>Route 53 ARC also provides readiness checks that continually audit resources to help make sure that your
|
|
34
34
|
* applications are scaled and ready to handle failover traffic. For more information about
|
|
35
35
|
* the related API operations, 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>
|
|
36
|
-
*
|
|
36
|
+
* </li>
|
|
37
37
|
* <li>
|
|
38
|
-
*
|
|
38
|
+
* <p>For more information about creating resilient applications and preparing for
|
|
39
39
|
* recovery readiness with Route 53 ARC, see the <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/">Amazon Route 53 Application Recovery Controller Developer Guide</a>.</p>
|
|
40
|
-
*
|
|
40
|
+
* </li>
|
|
41
41
|
* </ul>
|
|
42
42
|
*
|
|
43
43
|
* @packageDocumentation
|
|
@@ -316,7 +316,7 @@ export interface UpdateRoutingControlStateRequest {
|
|
|
316
316
|
* <p>The Amazon Resource Names (ARNs) for the safety rules that you want to override when you're updating the state of
|
|
317
317
|
* a routing control. You can override one safety rule or multiple safety rules by including one or more ARNs, separated
|
|
318
318
|
* by commas.</p>
|
|
319
|
-
*
|
|
319
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html">
|
|
320
320
|
* Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
321
321
|
*/
|
|
322
322
|
SafetyRulesToOverride?: string[];
|
|
@@ -356,7 +356,7 @@ export interface UpdateRoutingControlStatesRequest {
|
|
|
356
356
|
* <p>The Amazon Resource Names (ARNs) for the safety rules that you want to override when you're updating routing
|
|
357
357
|
* control states. You can override one safety rule or multiple safety rules by including one or more ARNs, separated
|
|
358
358
|
* by commas.</p>
|
|
359
|
-
*
|
|
359
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html">
|
|
360
360
|
* Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
|
|
361
361
|
*/
|
|
362
362
|
SafetyRulesToOverride?: string[];
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-route53-recovery-cluster",
|
|
3
3
|
"description": "AWS SDK for JavaScript Route53 Recovery Cluster Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.409.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,8 +21,8 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.409.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.409.0",
|
|
26
26
|
"@aws-sdk/middleware-host-header": "3.408.0",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.408.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.408.0",
|