@aws-sdk/client-route53-recovery-control-config 3.296.0 → 3.297.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 (34) hide show
  1. package/dist-types/Route53RecoveryControlConfig.d.ts +24 -0
  2. package/dist-types/Route53RecoveryControlConfigClient.d.ts +24 -4
  3. package/dist-types/commands/CreateClusterCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateControlPanelCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateRoutingControlCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateSafetyRuleCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteClusterCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteControlPanelCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteRoutingControlCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteSafetyRuleCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeClusterCommand.d.ts +16 -0
  12. package/dist-types/commands/DescribeControlPanelCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeRoutingControlCommand.d.ts +16 -0
  14. package/dist-types/commands/DescribeSafetyRuleCommand.d.ts +16 -0
  15. package/dist-types/commands/ListAssociatedRoute53HealthChecksCommand.d.ts +16 -0
  16. package/dist-types/commands/ListClustersCommand.d.ts +16 -0
  17. package/dist-types/commands/ListControlPanelsCommand.d.ts +16 -0
  18. package/dist-types/commands/ListRoutingControlsCommand.d.ts +16 -0
  19. package/dist-types/commands/ListSafetyRulesCommand.d.ts +16 -0
  20. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  21. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  22. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  23. package/dist-types/commands/UpdateControlPanelCommand.d.ts +16 -0
  24. package/dist-types/commands/UpdateRoutingControlCommand.d.ts +16 -0
  25. package/dist-types/commands/UpdateSafetyRuleCommand.d.ts +16 -0
  26. package/dist-types/models/Route53RecoveryControlConfigServiceException.d.ts +2 -0
  27. package/dist-types/models/models_0.d.ts +147 -0
  28. package/dist-types/pagination/Interfaces.d.ts +3 -0
  29. package/dist-types/pagination/ListAssociatedRoute53HealthChecksPaginator.d.ts +3 -0
  30. package/dist-types/pagination/ListClustersPaginator.d.ts +3 -0
  31. package/dist-types/pagination/ListControlPanelsPaginator.d.ts +3 -0
  32. package/dist-types/pagination/ListRoutingControlsPaginator.d.ts +3 -0
  33. package/dist-types/pagination/ListSafetyRulesPaginator.d.ts +3 -0
  34. package/package.json +3 -3
@@ -24,142 +24,166 @@ import { UpdateRoutingControlCommandInput, UpdateRoutingControlCommandOutput } f
24
24
  import { UpdateSafetyRuleCommandInput, UpdateSafetyRuleCommandOutput } from "./commands/UpdateSafetyRuleCommand";
25
25
  import { Route53RecoveryControlConfigClient } from "./Route53RecoveryControlConfigClient";
26
26
  /**
27
+ * @public
27
28
  * <p>Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller</p>
28
29
  */
29
30
  export declare class Route53RecoveryControlConfig extends Route53RecoveryControlConfigClient {
30
31
  /**
32
+ * @public
31
33
  * <p>Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane.</p>
32
34
  */
33
35
  createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise<CreateClusterCommandOutput>;
34
36
  createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void;
35
37
  createCluster(args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void): void;
36
38
  /**
39
+ * @public
37
40
  * <p>Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region.</p>
38
41
  */
39
42
  createControlPanel(args: CreateControlPanelCommandInput, options?: __HttpHandlerOptions): Promise<CreateControlPanelCommandOutput>;
40
43
  createControlPanel(args: CreateControlPanelCommandInput, cb: (err: any, data?: CreateControlPanelCommandOutput) => void): void;
41
44
  createControlPanel(args: CreateControlPanelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateControlPanelCommandOutput) => void): void;
42
45
  /**
46
+ * @public
43
47
  * <p>Creates a new routing control.</p> <p>A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing.</p> <p>To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.</p>
44
48
  */
45
49
  createRoutingControl(args: CreateRoutingControlCommandInput, options?: __HttpHandlerOptions): Promise<CreateRoutingControlCommandOutput>;
46
50
  createRoutingControl(args: CreateRoutingControlCommandInput, cb: (err: any, data?: CreateRoutingControlCommandOutput) => void): void;
47
51
  createRoutingControl(args: CreateRoutingControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRoutingControlCommandOutput) => void): void;
48
52
  /**
53
+ * @public
49
54
  * <p>Creates a safety rule in a control panel. Safety rules let you add safeguards around changing routing control states, and for enabling and disabling routing controls, to help prevent unexpected outcomes.</p> <p>There are two types of safety rules: assertion rules and gating rules.</p> <p>Assertion rule: An assertion rule enforces that, when you change a routing control state, that a certain criteria is met. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.</p> <p>Gating rule: A gating rule lets you configure a gating routing control as an overall "on/off" switch for a group of routing controls. Or, you can configure more complex gating scenarios, for example by configuring multiple gating routing controls.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.safety-rules.html">Safety rules</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
50
55
  */
51
56
  createSafetyRule(args: CreateSafetyRuleCommandInput, options?: __HttpHandlerOptions): Promise<CreateSafetyRuleCommandOutput>;
52
57
  createSafetyRule(args: CreateSafetyRuleCommandInput, cb: (err: any, data?: CreateSafetyRuleCommandOutput) => void): void;
53
58
  createSafetyRule(args: CreateSafetyRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSafetyRuleCommandOutput) => void): void;
54
59
  /**
60
+ * @public
55
61
  * <p>Delete a cluster.</p>
56
62
  */
57
63
  deleteCluster(args: DeleteClusterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteClusterCommandOutput>;
58
64
  deleteCluster(args: DeleteClusterCommandInput, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void;
59
65
  deleteCluster(args: DeleteClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void;
60
66
  /**
67
+ * @public
61
68
  * <p>Deletes a control panel.</p>
62
69
  */
63
70
  deleteControlPanel(args: DeleteControlPanelCommandInput, options?: __HttpHandlerOptions): Promise<DeleteControlPanelCommandOutput>;
64
71
  deleteControlPanel(args: DeleteControlPanelCommandInput, cb: (err: any, data?: DeleteControlPanelCommandOutput) => void): void;
65
72
  deleteControlPanel(args: DeleteControlPanelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteControlPanelCommandOutput) => void): void;
66
73
  /**
74
+ * @public
67
75
  * <p>Deletes a routing control.</p>
68
76
  */
69
77
  deleteRoutingControl(args: DeleteRoutingControlCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRoutingControlCommandOutput>;
70
78
  deleteRoutingControl(args: DeleteRoutingControlCommandInput, cb: (err: any, data?: DeleteRoutingControlCommandOutput) => void): void;
71
79
  deleteRoutingControl(args: DeleteRoutingControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRoutingControlCommandOutput) => void): void;
72
80
  /**
81
+ * @public
73
82
  * <p>Deletes a safety rule.</p>/&gt;
74
83
  */
75
84
  deleteSafetyRule(args: DeleteSafetyRuleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSafetyRuleCommandOutput>;
76
85
  deleteSafetyRule(args: DeleteSafetyRuleCommandInput, cb: (err: any, data?: DeleteSafetyRuleCommandOutput) => void): void;
77
86
  deleteSafetyRule(args: DeleteSafetyRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSafetyRuleCommandOutput) => void): void;
78
87
  /**
88
+ * @public
79
89
  * <p>Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).</p>
80
90
  */
81
91
  describeCluster(args: DescribeClusterCommandInput, options?: __HttpHandlerOptions): Promise<DescribeClusterCommandOutput>;
82
92
  describeCluster(args: DescribeClusterCommandInput, cb: (err: any, data?: DescribeClusterCommandOutput) => void): void;
83
93
  describeCluster(args: DescribeClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClusterCommandOutput) => void): void;
84
94
  /**
95
+ * @public
85
96
  * <p>Displays details about a control panel.</p>
86
97
  */
87
98
  describeControlPanel(args: DescribeControlPanelCommandInput, options?: __HttpHandlerOptions): Promise<DescribeControlPanelCommandOutput>;
88
99
  describeControlPanel(args: DescribeControlPanelCommandInput, cb: (err: any, data?: DescribeControlPanelCommandOutput) => void): void;
89
100
  describeControlPanel(args: DescribeControlPanelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeControlPanelCommandOutput) => void): void;
90
101
  /**
102
+ * @public
91
103
  * <p>Displays details about a routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.</p> <p>To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.</p>
92
104
  */
93
105
  describeRoutingControl(args: DescribeRoutingControlCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRoutingControlCommandOutput>;
94
106
  describeRoutingControl(args: DescribeRoutingControlCommandInput, cb: (err: any, data?: DescribeRoutingControlCommandOutput) => void): void;
95
107
  describeRoutingControl(args: DescribeRoutingControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRoutingControlCommandOutput) => void): void;
96
108
  /**
109
+ * @public
97
110
  * <p>Returns information about a safety rule.</p>
98
111
  */
99
112
  describeSafetyRule(args: DescribeSafetyRuleCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSafetyRuleCommandOutput>;
100
113
  describeSafetyRule(args: DescribeSafetyRuleCommandInput, cb: (err: any, data?: DescribeSafetyRuleCommandOutput) => void): void;
101
114
  describeSafetyRule(args: DescribeSafetyRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSafetyRuleCommandOutput) => void): void;
102
115
  /**
116
+ * @public
103
117
  * <p>Returns an array of all Amazon Route 53 health checks associated with a specific routing control.</p>
104
118
  */
105
119
  listAssociatedRoute53HealthChecks(args: ListAssociatedRoute53HealthChecksCommandInput, options?: __HttpHandlerOptions): Promise<ListAssociatedRoute53HealthChecksCommandOutput>;
106
120
  listAssociatedRoute53HealthChecks(args: ListAssociatedRoute53HealthChecksCommandInput, cb: (err: any, data?: ListAssociatedRoute53HealthChecksCommandOutput) => void): void;
107
121
  listAssociatedRoute53HealthChecks(args: ListAssociatedRoute53HealthChecksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociatedRoute53HealthChecksCommandOutput) => void): void;
108
122
  /**
123
+ * @public
109
124
  * <p>Returns an array of all the clusters in an account.</p>
110
125
  */
111
126
  listClusters(args: ListClustersCommandInput, options?: __HttpHandlerOptions): Promise<ListClustersCommandOutput>;
112
127
  listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void;
113
128
  listClusters(args: ListClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClustersCommandOutput) => void): void;
114
129
  /**
130
+ * @public
115
131
  * <p>Returns an array of control panels in an account or in a cluster.</p>
116
132
  */
117
133
  listControlPanels(args: ListControlPanelsCommandInput, options?: __HttpHandlerOptions): Promise<ListControlPanelsCommandOutput>;
118
134
  listControlPanels(args: ListControlPanelsCommandInput, cb: (err: any, data?: ListControlPanelsCommandOutput) => void): void;
119
135
  listControlPanels(args: ListControlPanelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListControlPanelsCommandOutput) => void): void;
120
136
  /**
137
+ * @public
121
138
  * <p>Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.</p>
122
139
  */
123
140
  listRoutingControls(args: ListRoutingControlsCommandInput, options?: __HttpHandlerOptions): Promise<ListRoutingControlsCommandOutput>;
124
141
  listRoutingControls(args: ListRoutingControlsCommandInput, cb: (err: any, data?: ListRoutingControlsCommandOutput) => void): void;
125
142
  listRoutingControls(args: ListRoutingControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRoutingControlsCommandOutput) => void): void;
126
143
  /**
144
+ * @public
127
145
  * <p>List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.</p>
128
146
  */
129
147
  listSafetyRules(args: ListSafetyRulesCommandInput, options?: __HttpHandlerOptions): Promise<ListSafetyRulesCommandOutput>;
130
148
  listSafetyRules(args: ListSafetyRulesCommandInput, cb: (err: any, data?: ListSafetyRulesCommandOutput) => void): void;
131
149
  listSafetyRules(args: ListSafetyRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSafetyRulesCommandOutput) => void): void;
132
150
  /**
151
+ * @public
133
152
  * <p>Lists the tags for a resource.</p>
134
153
  */
135
154
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
136
155
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
137
156
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
138
157
  /**
158
+ * @public
139
159
  * <p>Adds a tag to a resource.</p>
140
160
  */
141
161
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
142
162
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
143
163
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
144
164
  /**
165
+ * @public
145
166
  * <p>Removes a tag from a resource.</p>
146
167
  */
147
168
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
148
169
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
149
170
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
150
171
  /**
172
+ * @public
151
173
  * <p>Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.</p>
152
174
  */
153
175
  updateControlPanel(args: UpdateControlPanelCommandInput, options?: __HttpHandlerOptions): Promise<UpdateControlPanelCommandOutput>;
154
176
  updateControlPanel(args: UpdateControlPanelCommandInput, cb: (err: any, data?: UpdateControlPanelCommandOutput) => void): void;
155
177
  updateControlPanel(args: UpdateControlPanelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateControlPanelCommandOutput) => void): void;
156
178
  /**
179
+ * @public
157
180
  * <p>Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.</p>
158
181
  */
159
182
  updateRoutingControl(args: UpdateRoutingControlCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRoutingControlCommandOutput>;
160
183
  updateRoutingControl(args: UpdateRoutingControlCommandInput, cb: (err: any, data?: UpdateRoutingControlCommandOutput) => void): void;
161
184
  updateRoutingControl(args: UpdateRoutingControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoutingControlCommandOutput) => void): void;
162
185
  /**
186
+ * @public
163
187
  * <p>Update a safety rule (an assertion rule or gating rule). You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new one.</p>
164
188
  */
165
189
  updateSafetyRule(args: UpdateSafetyRuleCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSafetyRuleCommandOutput>;
@@ -31,15 +31,24 @@ import { UpdateControlPanelCommandInput, UpdateControlPanelCommandOutput } from
31
31
  import { UpdateRoutingControlCommandInput, UpdateRoutingControlCommandOutput } from "./commands/UpdateRoutingControlCommand";
32
32
  import { UpdateSafetyRuleCommandInput, UpdateSafetyRuleCommandOutput } from "./commands/UpdateSafetyRuleCommand";
33
33
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
34
+ /**
35
+ * @public
36
+ */
34
37
  export type ServiceInputTypes = CreateClusterCommandInput | CreateControlPanelCommandInput | CreateRoutingControlCommandInput | CreateSafetyRuleCommandInput | DeleteClusterCommandInput | DeleteControlPanelCommandInput | DeleteRoutingControlCommandInput | DeleteSafetyRuleCommandInput | DescribeClusterCommandInput | DescribeControlPanelCommandInput | DescribeRoutingControlCommandInput | DescribeSafetyRuleCommandInput | ListAssociatedRoute53HealthChecksCommandInput | ListClustersCommandInput | ListControlPanelsCommandInput | ListRoutingControlsCommandInput | ListSafetyRulesCommandInput | ListTagsForResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateControlPanelCommandInput | UpdateRoutingControlCommandInput | UpdateSafetyRuleCommandInput;
38
+ /**
39
+ * @public
40
+ */
35
41
  export type ServiceOutputTypes = CreateClusterCommandOutput | CreateControlPanelCommandOutput | CreateRoutingControlCommandOutput | CreateSafetyRuleCommandOutput | DeleteClusterCommandOutput | DeleteControlPanelCommandOutput | DeleteRoutingControlCommandOutput | DeleteSafetyRuleCommandOutput | DescribeClusterCommandOutput | DescribeControlPanelCommandOutput | DescribeRoutingControlCommandOutput | DescribeSafetyRuleCommandOutput | ListAssociatedRoute53HealthChecksCommandOutput | ListClustersCommandOutput | ListControlPanelsCommandOutput | ListRoutingControlsCommandOutput | ListSafetyRulesCommandOutput | ListTagsForResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateControlPanelCommandOutput | UpdateRoutingControlCommandOutput | UpdateSafetyRuleCommandOutput;
42
+ /**
43
+ * @public
44
+ */
36
45
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
37
46
  /**
38
47
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
39
48
  */
40
49
  requestHandler?: __HttpHandler;
41
50
  /**
42
- * A constructor for a class implementing the {@link __Checksum} interface
51
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
43
52
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
44
53
  * @internal
45
54
  */
@@ -129,23 +138,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
129
138
  */
130
139
  logger?: __Logger;
131
140
  /**
132
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
141
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
133
142
  */
134
143
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
135
144
  }
145
+ /**
146
+ * @public
147
+ */
136
148
  type Route53RecoveryControlConfigClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
137
149
  /**
138
- * The configuration interface of Route53RecoveryControlConfigClient class constructor that set the region, credentials and other options.
150
+ * @public
151
+ *
152
+ * The configuration interface of Route53RecoveryControlConfigClient class constructor that set the region, credentials and other options.
139
153
  */
140
154
  export interface Route53RecoveryControlConfigClientConfig extends Route53RecoveryControlConfigClientConfigType {
141
155
  }
156
+ /**
157
+ * @public
158
+ */
142
159
  type Route53RecoveryControlConfigClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
143
160
  /**
144
- * The resolved configuration interface of Route53RecoveryControlConfigClient class. This is resolved and normalized from the {@link Route53RecoveryControlConfigClientConfig | constructor configuration interface}.
161
+ * @public
162
+ *
163
+ * The resolved configuration interface of Route53RecoveryControlConfigClient class. This is resolved and normalized from the {@link Route53RecoveryControlConfigClientConfig | constructor configuration interface}.
145
164
  */
146
165
  export interface Route53RecoveryControlConfigClientResolvedConfig extends Route53RecoveryControlConfigClientResolvedConfigType {
147
166
  }
148
167
  /**
168
+ * @public
149
169
  * <p>Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller</p>
150
170
  */
151
171
  export declare class Route53RecoveryControlConfigClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, Route53RecoveryControlConfigClientResolvedConfig> {
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateClusterRequest, CreateClusterResponse } from "../models/models_0";
5
5
  import { Route53RecoveryControlConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../Route53RecoveryControlConfigClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateClusterCommand}.
8
10
  */
9
11
  export interface CreateClusterCommandInput extends CreateClusterRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateClusterCommand}.
13
17
  */
14
18
  export interface CreateClusterCommandOutput extends CreateClusterResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateClusterCommandInput - {@link CreateClusterCommandInput}
34
+ * @returns {@link CreateClusterCommandOutput}
28
35
  * @see {@link CreateClusterCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateClusterCommandOutput} for command's `response` shape.
30
37
  * @see {@link Route53RecoveryControlConfigClientResolvedConfig | config} for Route53RecoveryControlConfigClient's `config` shape.
@@ -55,11 +62,20 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
55
62
  export declare class CreateClusterCommand extends $Command<CreateClusterCommandInput, CreateClusterCommandOutput, Route53RecoveryControlConfigClientResolvedConfig> {
56
63
  readonly input: CreateClusterCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: CreateClusterCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: Route53RecoveryControlConfigClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateClusterCommandInput, CreateClusterCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateControlPanelRequest, CreateControlPanelResponse } from "../models/models_0";
5
5
  import { Route53RecoveryControlConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../Route53RecoveryControlConfigClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateControlPanelCommand}.
8
10
  */
9
11
  export interface CreateControlPanelCommandInput extends CreateControlPanelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateControlPanelCommand}.
13
17
  */
14
18
  export interface CreateControlPanelCommandOutput extends CreateControlPanelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateControlPanelCommandOutput extends CreateControlPanelRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateControlPanelCommandInput - {@link CreateControlPanelCommandInput}
34
+ * @returns {@link CreateControlPanelCommandOutput}
28
35
  * @see {@link CreateControlPanelCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateControlPanelCommandOutput} for command's `response` shape.
30
37
  * @see {@link Route53RecoveryControlConfigClientResolvedConfig | config} for Route53RecoveryControlConfigClient's `config` shape.
@@ -55,11 +62,20 @@ export interface CreateControlPanelCommandOutput extends CreateControlPanelRespo
55
62
  export declare class CreateControlPanelCommand extends $Command<CreateControlPanelCommandInput, CreateControlPanelCommandOutput, Route53RecoveryControlConfigClientResolvedConfig> {
56
63
  readonly input: CreateControlPanelCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: CreateControlPanelCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: Route53RecoveryControlConfigClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateControlPanelCommandInput, CreateControlPanelCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateRoutingControlRequest, CreateRoutingControlResponse } from "../models/models_0";
5
5
  import { Route53RecoveryControlConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../Route53RecoveryControlConfigClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateRoutingControlCommand}.
8
10
  */
9
11
  export interface CreateRoutingControlCommandInput extends CreateRoutingControlRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateRoutingControlCommand}.
13
17
  */
14
18
  export interface CreateRoutingControlCommandOutput extends CreateRoutingControlResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new routing control.</p> <p>A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing.</p> <p>To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateRoutingControlCommandOutput extends CreateRoutingControlR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateRoutingControlCommandInput - {@link CreateRoutingControlCommandInput}
34
+ * @returns {@link CreateRoutingControlCommandOutput}
28
35
  * @see {@link CreateRoutingControlCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateRoutingControlCommandOutput} for command's `response` shape.
30
37
  * @see {@link Route53RecoveryControlConfigClientResolvedConfig | config} for Route53RecoveryControlConfigClient's `config` shape.
@@ -55,11 +62,20 @@ export interface CreateRoutingControlCommandOutput extends CreateRoutingControlR
55
62
  export declare class CreateRoutingControlCommand extends $Command<CreateRoutingControlCommandInput, CreateRoutingControlCommandOutput, Route53RecoveryControlConfigClientResolvedConfig> {
56
63
  readonly input: CreateRoutingControlCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: CreateRoutingControlCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: Route53RecoveryControlConfigClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateRoutingControlCommandInput, CreateRoutingControlCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateSafetyRuleRequest, CreateSafetyRuleResponse } from "../models/models_0";
5
5
  import { Route53RecoveryControlConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../Route53RecoveryControlConfigClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateSafetyRuleCommand}.
8
10
  */
9
11
  export interface CreateSafetyRuleCommandInput extends CreateSafetyRuleRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateSafetyRuleCommand}.
13
17
  */
14
18
  export interface CreateSafetyRuleCommandOutput extends CreateSafetyRuleResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a safety rule in a control panel. Safety rules let you add safeguards around changing routing control states, and for enabling and disabling routing controls, to help prevent unexpected outcomes.</p> <p>There are two types of safety rules: assertion rules and gating rules.</p> <p>Assertion rule: An assertion rule enforces that, when you change a routing control state, that a certain criteria is met. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.</p> <p>Gating rule: A gating rule lets you configure a gating routing control as an overall "on/off" switch for a group of routing controls. Or, you can configure more complex gating scenarios, for example by configuring multiple gating routing controls.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.safety-rules.html">Safety rules</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateSafetyRuleCommandOutput extends CreateSafetyRuleResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateSafetyRuleCommandInput - {@link CreateSafetyRuleCommandInput}
34
+ * @returns {@link CreateSafetyRuleCommandOutput}
28
35
  * @see {@link CreateSafetyRuleCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateSafetyRuleCommandOutput} for command's `response` shape.
30
37
  * @see {@link Route53RecoveryControlConfigClientResolvedConfig | config} for Route53RecoveryControlConfigClient's `config` shape.
@@ -40,11 +47,20 @@ export interface CreateSafetyRuleCommandOutput extends CreateSafetyRuleResponse,
40
47
  export declare class CreateSafetyRuleCommand extends $Command<CreateSafetyRuleCommandInput, CreateSafetyRuleCommandOutput, Route53RecoveryControlConfigClientResolvedConfig> {
41
48
  readonly input: CreateSafetyRuleCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: CreateSafetyRuleCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: Route53RecoveryControlConfigClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateSafetyRuleCommandInput, CreateSafetyRuleCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteClusterRequest, DeleteClusterResponse } from "../models/models_0";
5
5
  import { Route53RecoveryControlConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../Route53RecoveryControlConfigClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteClusterCommand}.
8
10
  */
9
11
  export interface DeleteClusterCommandInput extends DeleteClusterRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteClusterCommand}.
13
17
  */
14
18
  export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Delete a cluster.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteClusterCommandInput - {@link DeleteClusterCommandInput}
34
+ * @returns {@link DeleteClusterCommandOutput}
28
35
  * @see {@link DeleteClusterCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteClusterCommandOutput} for command's `response` shape.
30
37
  * @see {@link Route53RecoveryControlConfigClientResolvedConfig | config} for Route53RecoveryControlConfigClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
52
59
  export declare class DeleteClusterCommand extends $Command<DeleteClusterCommandInput, DeleteClusterCommandOutput, Route53RecoveryControlConfigClientResolvedConfig> {
53
60
  readonly input: DeleteClusterCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeleteClusterCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: Route53RecoveryControlConfigClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteClusterCommandInput, DeleteClusterCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteControlPanelRequest, DeleteControlPanelResponse } from "../models/models_0";
5
5
  import { Route53RecoveryControlConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../Route53RecoveryControlConfigClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteControlPanelCommand}.
8
10
  */
9
11
  export interface DeleteControlPanelCommandInput extends DeleteControlPanelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteControlPanelCommand}.
13
17
  */
14
18
  export interface DeleteControlPanelCommandOutput extends DeleteControlPanelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a control panel.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteControlPanelCommandOutput extends DeleteControlPanelRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteControlPanelCommandInput - {@link DeleteControlPanelCommandInput}
34
+ * @returns {@link DeleteControlPanelCommandOutput}
28
35
  * @see {@link DeleteControlPanelCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteControlPanelCommandOutput} for command's `response` shape.
30
37
  * @see {@link Route53RecoveryControlConfigClientResolvedConfig | config} for Route53RecoveryControlConfigClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeleteControlPanelCommandOutput extends DeleteControlPanelRespo
52
59
  export declare class DeleteControlPanelCommand extends $Command<DeleteControlPanelCommandInput, DeleteControlPanelCommandOutput, Route53RecoveryControlConfigClientResolvedConfig> {
53
60
  readonly input: DeleteControlPanelCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeleteControlPanelCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: Route53RecoveryControlConfigClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteControlPanelCommandInput, DeleteControlPanelCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteRoutingControlRequest, DeleteRoutingControlResponse } from "../models/models_0";
5
5
  import { Route53RecoveryControlConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../Route53RecoveryControlConfigClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteRoutingControlCommand}.
8
10
  */
9
11
  export interface DeleteRoutingControlCommandInput extends DeleteRoutingControlRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteRoutingControlCommand}.
13
17
  */
14
18
  export interface DeleteRoutingControlCommandOutput extends DeleteRoutingControlResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a routing control.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteRoutingControlCommandOutput extends DeleteRoutingControlR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteRoutingControlCommandInput - {@link DeleteRoutingControlCommandInput}
34
+ * @returns {@link DeleteRoutingControlCommandOutput}
28
35
  * @see {@link DeleteRoutingControlCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteRoutingControlCommandOutput} for command's `response` shape.
30
37
  * @see {@link Route53RecoveryControlConfigClientResolvedConfig | config} for Route53RecoveryControlConfigClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeleteRoutingControlCommandOutput extends DeleteRoutingControlR
52
59
  export declare class DeleteRoutingControlCommand extends $Command<DeleteRoutingControlCommandInput, DeleteRoutingControlCommandOutput, Route53RecoveryControlConfigClientResolvedConfig> {
53
60
  readonly input: DeleteRoutingControlCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeleteRoutingControlCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: Route53RecoveryControlConfigClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteRoutingControlCommandInput, DeleteRoutingControlCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }