From 375efbf1f10fe7d91fcecc99fdc674fccc3d3d50 Mon Sep 17 00:00:00 2001 From: awstools Date: Tue, 17 Oct 2023 18:21:18 +0000 Subject: [PATCH] feat(client-route53-recovery-cluster): Adds Owner field to ListRoutingControls API. --- .../client-route53-recovery-cluster/README.md | 2 +- .../src/Route53RecoveryCluster.ts | 2 +- .../src/Route53RecoveryClusterClient.ts | 2 +- .../commands/GetRoutingControlStateCommand.ts | 4 +- .../commands/ListRoutingControlsCommand.ts | 5 +- .../UpdateRoutingControlStateCommand.ts | 4 +- .../UpdateRoutingControlStatesCommand.ts | 4 +- .../src/endpoint/ruleset.ts | 44 ++++++----- .../src/index.ts | 2 +- .../src/models/models_0.ts | 19 +++-- .../aws-models/route53-recovery-cluster.json | 76 +++++++++++-------- 11 files changed, 95 insertions(+), 69 deletions(-) diff --git a/clients/client-route53-recovery-cluster/README.md b/clients/client-route53-recovery-cluster/README.md index 8e96316f0f5a..a77f329311e3 100644 --- a/clients/client-route53-recovery-cluster/README.md +++ b/clients/client-route53-recovery-cluster/README.md @@ -12,7 +12,7 @@ recover applications by rerouting traffic across Availability Zones or Amazon Web Services Regions. Routing controls are simple on/off switches hosted on a highly available cluster in Route 53 ARC. A cluster provides a set of five redundant Regional endpoints against which you can run API calls to get or update the state of routing controls. To implement failover, you set -one routing control On and another one Off, to reroute traffic from one Availability Zone or Amazon Web Services Region +one routing control to ON and another one to OFF, to reroute traffic from one Availability Zone or Amazon Web Services Region to another.

Be aware that you must specify a Regional endpoint for a cluster when you work with API cluster operations diff --git a/clients/client-route53-recovery-cluster/src/Route53RecoveryCluster.ts b/clients/client-route53-recovery-cluster/src/Route53RecoveryCluster.ts index ef32be1f8856..bc2772501bec 100644 --- a/clients/client-route53-recovery-cluster/src/Route53RecoveryCluster.ts +++ b/clients/client-route53-recovery-cluster/src/Route53RecoveryCluster.ts @@ -109,7 +109,7 @@ export interface Route53RecoveryCluster { * Availability Zones or Amazon Web Services Regions. Routing controls are simple on/off switches hosted * on a highly available cluster in Route 53 ARC. A cluster provides a set of five redundant Regional endpoints against which you * can run API calls to get or update the state of routing controls. To implement failover, you set - * one routing control On and another one Off, to reroute traffic from one Availability Zone or Amazon Web Services Region + * one routing control to ON and another one to OFF, to reroute traffic from one Availability Zone or Amazon Web Services Region * to another.

*

* Be aware that you must specify a Regional endpoint for a cluster when you work with API cluster operations diff --git a/clients/client-route53-recovery-cluster/src/Route53RecoveryClusterClient.ts b/clients/client-route53-recovery-cluster/src/Route53RecoveryClusterClient.ts index 071c62b96fdb..f85f38e2f0d2 100644 --- a/clients/client-route53-recovery-cluster/src/Route53RecoveryClusterClient.ts +++ b/clients/client-route53-recovery-cluster/src/Route53RecoveryClusterClient.ts @@ -273,7 +273,7 @@ export interface Route53RecoveryClusterClientResolvedConfig extends Route53Recov * Availability Zones or Amazon Web Services Regions. Routing controls are simple on/off switches hosted * on a highly available cluster in Route 53 ARC. A cluster provides a set of five redundant Regional endpoints against which you * can run API calls to get or update the state of routing controls. To implement failover, you set - * one routing control On and another one Off, to reroute traffic from one Availability Zone or Amazon Web Services Region + * one routing control to ON and another one to OFF, to reroute traffic from one Availability Zone or Amazon Web Services Region * to another.

*

* Be aware that you must specify a Regional endpoint for a cluster when you work with API cluster operations diff --git a/clients/client-route53-recovery-cluster/src/commands/GetRoutingControlStateCommand.ts b/clients/client-route53-recovery-cluster/src/commands/GetRoutingControlStateCommand.ts index 2117b6a8216f..3cb9ee4a8904 100644 --- a/clients/client-route53-recovery-cluster/src/commands/GetRoutingControlStateCommand.ts +++ b/clients/client-route53-recovery-cluster/src/commands/GetRoutingControlStateCommand.ts @@ -42,8 +42,8 @@ export interface GetRoutingControlStateCommandOutput extends GetRoutingControlSt /** * @public *

Get the state for a routing control. A routing control is a simple on/off switch that you - * can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When - * the state is Off, traffic does not flow.

+ * can use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When + * the state is set to OFF, traffic does not flow.

*

Before you can create a routing control, you must first create a cluster, and then host the control * in a control panel on the cluster. For more information, see * Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. diff --git a/clients/client-route53-recovery-cluster/src/commands/ListRoutingControlsCommand.ts b/clients/client-route53-recovery-cluster/src/commands/ListRoutingControlsCommand.ts index 472a73e277ac..92bd5761737c 100644 --- a/clients/client-route53-recovery-cluster/src/commands/ListRoutingControlsCommand.ts +++ b/clients/client-route53-recovery-cluster/src/commands/ListRoutingControlsCommand.ts @@ -46,8 +46,8 @@ export interface ListRoutingControlsCommandOutput extends ListRoutingControlsRes * If you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists * all the routing controls in the cluster.

*

A routing control is a simple on/off switch in Route 53 ARC that you - * can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When - * the state is Off, traffic does not flow.

+ * can use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When + * the state is set to OFF, traffic does not flow.

*

Before you can create a routing control, you must first create a cluster, and then host the control * in a control panel on the cluster. For more information, see * Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. @@ -94,6 +94,7 @@ export interface ListRoutingControlsCommandOutput extends ListRoutingControlsRes * // RoutingControlArn: "STRING_VALUE", * // RoutingControlName: "STRING_VALUE", * // RoutingControlState: "On" || "Off", + * // Owner: "STRING_VALUE", * // }, * // ], * // NextToken: "STRING_VALUE", diff --git a/clients/client-route53-recovery-cluster/src/commands/UpdateRoutingControlStateCommand.ts b/clients/client-route53-recovery-cluster/src/commands/UpdateRoutingControlStateCommand.ts index b35bb120063c..abc7581a65bd 100644 --- a/clients/client-route53-recovery-cluster/src/commands/UpdateRoutingControlStateCommand.ts +++ b/clients/client-route53-recovery-cluster/src/commands/UpdateRoutingControlStateCommand.ts @@ -41,8 +41,8 @@ export interface UpdateRoutingControlStateCommandOutput extends UpdateRoutingCon /** * @public - *

Set the state of the routing control to reroute traffic. You can set the value to be On or - * Off. When the state is On, traffic flows to a cell. When the state is Off, traffic does not + *

Set the state of the routing control to reroute traffic. You can set the value to ON or + * OFF. When the state is ON, traffic flows to a cell. When the state is OFF, traffic does not * flow.

*

With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing * control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, diff --git a/clients/client-route53-recovery-cluster/src/commands/UpdateRoutingControlStatesCommand.ts b/clients/client-route53-recovery-cluster/src/commands/UpdateRoutingControlStatesCommand.ts index c8f8b0ef2981..147bbdbc175f 100644 --- a/clients/client-route53-recovery-cluster/src/commands/UpdateRoutingControlStatesCommand.ts +++ b/clients/client-route53-recovery-cluster/src/commands/UpdateRoutingControlStatesCommand.ts @@ -41,8 +41,8 @@ export interface UpdateRoutingControlStatesCommandOutput extends UpdateRoutingCo /** * @public - *

Set multiple routing control states. You can set the value for each state to be On or Off. - * When the state is On, traffic flows to a cell. When it's Off, traffic does not + *

Set multiple routing control states. You can set the value for each state to be ON or OFF. + * When the state is ON, traffic flows to a cell. When it's OFF, traffic does not * flow.

*

With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing * control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, diff --git a/clients/client-route53-recovery-cluster/src/endpoint/ruleset.ts b/clients/client-route53-recovery-cluster/src/endpoint/ruleset.ts index d1b6f13731a7..59bf0a825136 100644 --- a/clients/client-route53-recovery-cluster/src/endpoint/ruleset.ts +++ b/clients/client-route53-recovery-cluster/src/endpoint/ruleset.ts @@ -6,25 +6,27 @@ import { RuleSetObject } from "@smithy/types"; or see "smithy.rules#endpointRuleSet" in codegen/sdk-codegen/aws-models/route53-recovery-cluster.json */ -const q="required", -r="fn", -s="argv", -t="ref"; -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"}]; -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}]}; +const s="required", +t="fn", +u="argv", +v="ref"; +const a=true, +b="isSet", +c="booleanEquals", +d="error", +e="endpoint", +f="tree", +g="PartitionResult", +h={[s]:false,"type":"String"}, +i={[s]:true,"default":false,"type":"Boolean"}, +j={[v]:"Endpoint"}, +k={[t]:c,[u]:[{[v]:"UseFIPS"},true]}, +l={[t]:c,[u]:[{[v]:"UseDualStack"},true]}, +m={}, +n={[t]:"getAttr",[u]:[{[v]:g},"supportsFIPS"]}, +o={[t]:c,[u]:[true,{[t]:"getAttr",[u]:[{[v]:g},"supportsDualStack"]}]}, +p=[k], +q=[l], +r=[{[v]:"Region"}]; +const _data={version:"1.0",parameters:{Region:h,UseDualStack:i,UseFIPS:i,Endpoint:h},rules:[{conditions:[{[t]:b,[u]:[j]}],rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:d},{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:d},{endpoint:{url:j,properties:m,headers:m},type:e}],type:f},{conditions:[{[t]:b,[u]:r}],rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:g}],rules:[{conditions:[k,l],rules:[{conditions:[{[t]:c,[u]:[a,n]},o],rules:[{endpoint:{url:"https://route53-recovery-cluster-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:d}],type:f},{conditions:p,rules:[{conditions:[{[t]:c,[u]:[n,a]}],rules:[{endpoint:{url:"https://route53-recovery-cluster-fips.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"FIPS is enabled but this partition does not support FIPS",type:d}],type:f},{conditions:q,rules:[{conditions:[o],rules:[{endpoint:{url:"https://route53-recovery-cluster.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"DualStack is enabled but this partition does not support DualStack",type:d}],type:f},{endpoint:{url:"https://route53-recovery-cluster.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f}],type:f},{error:"Invalid Configuration: Missing Region",type:d}]}; export const ruleSet: RuleSetObject = _data; diff --git a/clients/client-route53-recovery-cluster/src/index.ts b/clients/client-route53-recovery-cluster/src/index.ts index c33c6ed8f94b..4ac4fcf9a028 100644 --- a/clients/client-route53-recovery-cluster/src/index.ts +++ b/clients/client-route53-recovery-cluster/src/index.ts @@ -7,7 +7,7 @@ * Availability Zones or Amazon Web Services Regions. Routing controls are simple on/off switches hosted * on a highly available cluster in Route 53 ARC. A cluster provides a set of five redundant Regional endpoints against which you * can run API calls to get or update the state of routing controls. To implement failover, you set - * one routing control On and another one Off, to reroute traffic from one Availability Zone or Amazon Web Services Region + * one routing control to ON and another one to OFF, to reroute traffic from one Availability Zone or Amazon Web Services Region * to another.

*

* Be aware that you must specify a Regional endpoint for a cluster when you work with API cluster operations diff --git a/clients/client-route53-recovery-cluster/src/models/models_0.ts b/clients/client-route53-recovery-cluster/src/models/models_0.ts index 95c80526674f..5ba823b2d676 100644 --- a/clients/client-route53-recovery-cluster/src/models/models_0.ts +++ b/clients/client-route53-recovery-cluster/src/models/models_0.ts @@ -307,8 +307,8 @@ export interface ListRoutingControlsRequest { /** * @public *

A routing control, which is a simple on/off switch that you - * can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When - * the state is Off, traffic does not flow.

+ * can use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When + * the state is set to OFF, traffic does not flow.

*/ export interface RoutingControl { /** @@ -319,7 +319,8 @@ export interface RoutingControl { /** * @public - *

The name of the control panel where the routing control is located.

+ *

The name of the control panel where the routing control is located. Only ASCII characters are supported for control + * panel names.

*/ ControlPanelName?: string; @@ -337,10 +338,16 @@ export interface RoutingControl { /** * @public - *

The current state of the routing control. When a routing control state is On, traffic flows to a cell. When - * the state is Off, traffic does not flow.

+ *

The current state of the routing control. When a routing control state is set to ON, traffic flows to a cell. When + * the state is set to OFF, traffic does not flow.

*/ RoutingControlState?: RoutingControlState; + + /** + * @public + *

The Amazon Web Services account ID of the routing control owner.

+ */ + Owner?: string; } /** @@ -420,7 +427,7 @@ export interface UpdateRoutingControlStateRequest { /** * @public - *

The state of the routing control. You can set the value to be On or Off.

+ *

The state of the routing control. You can set the value to ON or OFF.

*/ RoutingControlState: RoutingControlState | undefined; diff --git a/codegen/sdk-codegen/aws-models/route53-recovery-cluster.json b/codegen/sdk-codegen/aws-models/route53-recovery-cluster.json index 4beebf29d267..2a788c22569e 100644 --- a/codegen/sdk-codegen/aws-models/route53-recovery-cluster.json +++ b/codegen/sdk-codegen/aws-models/route53-recovery-cluster.json @@ -147,7 +147,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get the state for a routing control. A routing control is a simple on/off switch that you\n\t\t\t\tcan use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When\n\t\t\t\tthe state is Off, traffic does not flow.

\n

Before you can create a routing control, you must first create a cluster, and then host the control\n\t\t\t\tin a control panel on the cluster. For more information, see \n\t\t\t\t\tCreate routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. \n\t\t\t\tYou access one of the endpoints for the cluster to get or update the routing control state to\n\t\t\t\tredirect traffic for your application.

\n

\n You must specify Regional endpoints when you work with API cluster operations \n\t\t\t\tto get or update routing control states in Route 53 ARC.\n

\n

To see a code example for getting a routing control state, including accessing Regional cluster endpoints\n\t\t\t\tin sequence, see API examples\n\t\t\t\tin the Amazon Route 53 Application Recovery Controller Developer Guide.

\n

Learn more about working with routing controls in the following topics in the \n\t\t\t\tAmazon Route 53 Application Recovery Controller Developer Guide:

\n " + "smithy.api#documentation": "

Get the state for a routing control. A routing control is a simple on/off switch that you\n\t\t\t\tcan use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When\n\t\t\t\tthe state is set to OFF, traffic does not flow.

\n

Before you can create a routing control, you must first create a cluster, and then host the control\n\t\t\t\tin a control panel on the cluster. For more information, see \n\t\t\t\t\tCreate routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. \n\t\t\t\tYou access one of the endpoints for the cluster to get or update the routing control state to\n\t\t\t\tredirect traffic for your application.

\n

\n You must specify Regional endpoints when you work with API cluster operations \n\t\t\t\tto get or update routing control states in Route 53 ARC.\n

\n

To see a code example for getting a routing control state, including accessing Regional cluster endpoints\n\t\t\t\tin sequence, see API examples\n\t\t\t\tin the Amazon Route 53 Application Recovery Controller Developer Guide.

\n

Learn more about working with routing controls in the following topics in the \n\t\t\t\tAmazon Route 53 Application Recovery Controller Developer Guide:

\n " } }, "com.amazonaws.route53recoverycluster#GetRoutingControlStateRequest": { @@ -245,7 +245,7 @@ } ], "traits": { - "smithy.api#documentation": "

List routing control names and Amazon Resource Names (ARNs), as well as the routing control \n\t\t\tstate for each routing control, along with the control panel name and control panel ARN for the routing controls.\n\t\t\tIf you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists\n\t\t\tall the routing controls in the cluster.

\n

A routing control is a simple on/off switch in Route 53 ARC that you\n\t\t\tcan use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When\n\t\t\tthe state is Off, traffic does not flow.

\n

Before you can create a routing control, you must first create a cluster, and then host the control\n\t\t\tin a control panel on the cluster. For more information, see \n\t\t\t\tCreate routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. \n\t\t\tYou access one of the endpoints for the cluster to get or update the routing control state to\n\t\t\tredirect traffic for your application.

\n

\n You must specify Regional endpoints when you work with API cluster operations \n\t\t\tto use this API operation to list routing controls in Route 53 ARC.\n

\n

Learn more about working with routing controls in the following topics in the \n\t\t\tAmazon Route 53 Application Recovery Controller Developer Guide:

\n ", + "smithy.api#documentation": "

List routing control names and Amazon Resource Names (ARNs), as well as the routing control \n\t\t\tstate for each routing control, along with the control panel name and control panel ARN for the routing controls.\n\t\t\tIf you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists\n\t\t\tall the routing controls in the cluster.

\n

A routing control is a simple on/off switch in Route 53 ARC that you\n\t\t\tcan use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When\n\t\t\tthe state is set to OFF, traffic does not flow.

\n

Before you can create a routing control, you must first create a cluster, and then host the control\n\t\t\tin a control panel on the cluster. For more information, see \n\t\t\t\tCreate routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. \n\t\t\tYou access one of the endpoints for the cluster to get or update the routing control state to\n\t\t\tredirect traffic for your application.

\n

\n You must specify Regional endpoints when you work with API cluster operations \n\t\t\tto use this API operation to list routing controls in Route 53 ARC.\n

\n

Learn more about working with routing controls in the following topics in the \n\t\t\tAmazon Route 53 Application Recovery Controller Developer Guide:

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -311,6 +311,16 @@ } } }, + "com.amazonaws.route53recoverycluster#Owner": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 1024 + }, + "smithy.api#pattern": "^\\S+$" + } + }, "com.amazonaws.route53recoverycluster#PageToken": { "type": "string", "traits": { @@ -370,7 +380,7 @@ "ControlPanelName": { "target": "com.amazonaws.route53recoverycluster#ControlPanelName", "traits": { - "smithy.api#documentation": "

The name of the control panel where the routing control is located.

" + "smithy.api#documentation": "

The name of the control panel where the routing control is located. Only ASCII characters are supported for control\n\t\tpanel names.

" } }, "RoutingControlArn": { @@ -388,12 +398,18 @@ "RoutingControlState": { "target": "com.amazonaws.route53recoverycluster#RoutingControlState", "traits": { - "smithy.api#documentation": "

The current state of the routing control. When a routing control state is On, traffic flows to a cell. When\n\t\t\tthe state is Off, traffic does not flow.

" + "smithy.api#documentation": "

The current state of the routing control. When a routing control state is set to ON, traffic flows to a cell. When\n\t\t\tthe state is set to OFF, traffic does not flow.

" + } + }, + "Owner": { + "target": "com.amazonaws.route53recoverycluster#Owner", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the routing control owner.

" } } }, "traits": { - "smithy.api#documentation": "

A routing control, which is a simple on/off switch that you\n\t\t\tcan use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When\n\t\t\tthe state is Off, traffic does not flow.

" + "smithy.api#documentation": "

A routing control, which is a simple on/off switch that you\n\t\t\tcan use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When\n\t\t\tthe state is set to OFF, traffic does not flow.

" } }, "com.amazonaws.route53recoverycluster#RoutingControlName": { @@ -526,7 +542,7 @@ "name": "route53-recovery-cluster" }, "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "

Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.

\n

With Route 53 ARC, you can use routing control with extreme reliability to\n\t\t\trecover applications by rerouting traffic across\n\t\t\tAvailability Zones or Amazon Web Services Regions. Routing controls are simple on/off switches hosted\n\t\t\ton a highly available cluster in Route 53 ARC. A cluster provides a set of five redundant Regional endpoints against which you\n\t\t\tcan run API calls to get or update the state of routing controls. To implement failover, you set \n\t\t\tone routing control On and another one Off, to reroute traffic from one Availability Zone or Amazon Web Services Region \n\t\t\tto another.

\n

\n Be aware that you must specify a Regional endpoint for a cluster when you work with API cluster operations \n\t\t\t\tto get or update routing control states in Route 53 ARC. In addition, you must specify the US West (Oregon) Region \n\t\t\t\tfor Route 53 ARC API calls. For example, use the parameter --region us-west-2 with AWS CLI commands.\n\t\t\t\tFor more information, see\n\t\t\t\t\n\t\t\t\t\tGet and update routing control states using the API in the Amazon Route 53 Application Recovery Controller Developer Guide.

\n

This API guide includes information about the API operations for how to get and update routing control states\n\t\t\tin Route 53 ARC. To work with routing control in Route 53 ARC, you must first create the required components (clusters, control \n\t\t\tpanels, and routing controls) using the recovery cluster configuration API.

\n

For more information about working with routing control in Route 53 ARC, see the following:

\n ", + "smithy.api#documentation": "

Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.

\n

With Route 53 ARC, you can use routing control with extreme reliability to\n\t\t\trecover applications by rerouting traffic across\n\t\t\tAvailability Zones or Amazon Web Services Regions. Routing controls are simple on/off switches hosted\n\t\t\ton a highly available cluster in Route 53 ARC. A cluster provides a set of five redundant Regional endpoints against which you\n\t\t\tcan run API calls to get or update the state of routing controls. To implement failover, you set \n\t\t\tone routing control to ON and another one to OFF, to reroute traffic from one Availability Zone or Amazon Web Services Region \n\t\t\tto another.

\n

\n Be aware that you must specify a Regional endpoint for a cluster when you work with API cluster operations \n\t\t\t\tto get or update routing control states in Route 53 ARC. In addition, you must specify the US West (Oregon) Region \n\t\t\t\tfor Route 53 ARC API calls. For example, use the parameter --region us-west-2 with AWS CLI commands.\n\t\t\t\tFor more information, see\n\t\t\t\t\n\t\t\t\t\tGet and update routing control states using the API in the Amazon Route 53 Application Recovery Controller Developer Guide.

\n

This API guide includes information about the API operations for how to get and update routing control states\n\t\t\tin Route 53 ARC. To work with routing control in Route 53 ARC, you must first create the required components (clusters, control \n\t\t\tpanels, and routing controls) using the recovery cluster configuration API.

\n

For more information about working with routing control in Route 53 ARC, see the following:

\n ", "smithy.api#title": "Route53 Recovery Cluster", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -570,7 +586,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -613,7 +628,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -626,7 +642,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -640,7 +655,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -663,7 +677,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -698,7 +711,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -709,14 +721,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -730,14 +744,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -746,11 +758,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -761,14 +773,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -782,7 +796,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -802,7 +815,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -813,14 +825,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -831,9 +845,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1190,7 +1206,7 @@ } ], "traits": { - "smithy.api#documentation": "

Set the state of the routing control to reroute traffic. You can set the value to be On or\n\t\t\tOff. When the state is On, traffic flows to a cell. When the state is Off, traffic does not\n\t\t\tflow.

\n

With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing \n\t\t\t\tcontrol state updates that help prevent unexpected outcomes, like fail open traffic routing. However, \n\t\t\t\tthere are scenarios when you might want to bypass the routing control safeguards that are enforced with \n\t\t\t\tsafety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, \n\t\t\t\tand one or more safety rules might be unexpectedly preventing you from updating a routing control state to \n\t\t\t\treroute traffic. In a \"break glass\" scenario like this, you can override one or more safety rules to change \n\t\t\t\ta routing control state and fail over your application.

\n

The SafetyRulesToOverride property enables you override one or more safety rules and \n\t\t\t\tupdate routing control states. For more information, see \n\t\t\t\t\n\t\t\t\t\tOverride safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

\n

\n You must specify Regional endpoints when you work with API cluster operations \n\t\t\t\tto get or update routing control states in Route 53 ARC.\n

\n

To see a code example for getting a routing control state, including accessing Regional cluster endpoints\n\t\t\t\tin sequence, see API examples\n\t\t\t\tin the Amazon Route 53 Application Recovery Controller Developer Guide.

\n " + "smithy.api#documentation": "

Set the state of the routing control to reroute traffic. You can set the value to ON or\n\t\t\tOFF. When the state is ON, traffic flows to a cell. When the state is OFF, traffic does not\n\t\t\tflow.

\n

With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing \n\t\t\t\tcontrol state updates that help prevent unexpected outcomes, like fail open traffic routing. However, \n\t\t\t\tthere are scenarios when you might want to bypass the routing control safeguards that are enforced with \n\t\t\t\tsafety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, \n\t\t\t\tand one or more safety rules might be unexpectedly preventing you from updating a routing control state to \n\t\t\t\treroute traffic. In a \"break glass\" scenario like this, you can override one or more safety rules to change \n\t\t\t\ta routing control state and fail over your application.

\n

The SafetyRulesToOverride property enables you override one or more safety rules and \n\t\t\t\tupdate routing control states. For more information, see \n\t\t\t\t\n\t\t\t\t\tOverride safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

\n

\n You must specify Regional endpoints when you work with API cluster operations \n\t\t\t\tto get or update routing control states in Route 53 ARC.\n

\n

To see a code example for getting a routing control state, including accessing Regional cluster endpoints\n\t\t\t\tin sequence, see API examples\n\t\t\t\tin the Amazon Route 53 Application Recovery Controller Developer Guide.

\n " } }, "com.amazonaws.route53recoverycluster#UpdateRoutingControlStateEntries": { @@ -1234,7 +1250,7 @@ "RoutingControlState": { "target": "com.amazonaws.route53recoverycluster#RoutingControlState", "traits": { - "smithy.api#documentation": "

The state of the routing control. You can set the value to be On or Off.

", + "smithy.api#documentation": "

The state of the routing control. You can set the value to ON or OFF.

", "smithy.api#required": {} } }, @@ -1291,7 +1307,7 @@ } ], "traits": { - "smithy.api#documentation": "

Set multiple routing control states. You can set the value for each state to be On or Off.\n\t\t\tWhen the state is On, traffic flows to a cell. When it's Off, traffic does not\n\t\t\tflow.

\n

With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing \n\t\t\t\tcontrol state updates that help prevent unexpected outcomes, like fail open traffic routing. However, \n\t\t\t\tthere are scenarios when you might want to bypass the routing control safeguards that are enforced with \n\t\t\t\tsafety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, \n\t\t\t\tand one or more safety rules might be unexpectedly preventing you from updating a routing control state to \n\t\t\t\treroute traffic. In a \"break glass\" scenario like this, you can override one or more safety rules to change \n\t\t\t\ta routing control state and fail over your application.

\n

The SafetyRulesToOverride property enables you override one or more safety rules and \n\t\t\t\tupdate routing control states. For more information, see \n\t\t\t\t\n\t\t\t\t\tOverride safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

\n

\n You must specify Regional endpoints when you work with API cluster operations \n\t\t\t\tto get or update routing control states in Route 53 ARC.\n

\n

To see a code example for getting a routing control state, including accessing Regional cluster endpoints\n\t\t\t\tin sequence, see API examples\n\t\t\t\tin the Amazon Route 53 Application Recovery Controller Developer Guide.

\n " + "smithy.api#documentation": "

Set multiple routing control states. You can set the value for each state to be ON or OFF.\n\t\t\tWhen the state is ON, traffic flows to a cell. When it's OFF, traffic does not\n\t\t\tflow.

\n

With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing \n\t\t\t\tcontrol state updates that help prevent unexpected outcomes, like fail open traffic routing. However, \n\t\t\t\tthere are scenarios when you might want to bypass the routing control safeguards that are enforced with \n\t\t\t\tsafety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, \n\t\t\t\tand one or more safety rules might be unexpectedly preventing you from updating a routing control state to \n\t\t\t\treroute traffic. In a \"break glass\" scenario like this, you can override one or more safety rules to change \n\t\t\t\ta routing control state and fail over your application.

\n

The SafetyRulesToOverride property enables you override one or more safety rules and \n\t\t\t\tupdate routing control states. For more information, see \n\t\t\t\t\n\t\t\t\t\tOverride safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

\n

\n You must specify Regional endpoints when you work with API cluster operations \n\t\t\t\tto get or update routing control states in Route 53 ARC.\n

\n

To see a code example for getting a routing control state, including accessing Regional cluster endpoints\n\t\t\t\tin sequence, see API examples\n\t\t\t\tin the Amazon Route 53 Application Recovery Controller Developer Guide.

\n " } }, "com.amazonaws.route53recoverycluster#UpdateRoutingControlStatesRequest": { @@ -1408,4 +1424,4 @@ } } } -} \ No newline at end of file +}