aws-sdk-arczonalshift 1.34.0 → 1.35.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-arczonalshift/client.rb +365 -186
- data/lib/aws-sdk-arczonalshift/client_api.rb +107 -50
- data/lib/aws-sdk-arczonalshift/types.rb +555 -294
- data/lib/aws-sdk-arczonalshift/waiters.rb +15 -0
- data/lib/aws-sdk-arczonalshift.rb +3 -2
- data/sig/client.rbs +73 -39
- data/sig/types.rbs +73 -39
- metadata +2 -1
@@ -27,8 +27,8 @@ module Aws::ARCZonalShift
|
|
27
27
|
# for a managed resource and information about the autoshift.
|
28
28
|
#
|
29
29
|
# For more information, see [How zonal autoshift and practice runs
|
30
|
-
# work][1] in the Amazon
|
31
|
-
#
|
30
|
+
# work][1] in the Amazon Application Recovery Controller Developer
|
31
|
+
# Guide.
|
32
32
|
#
|
33
33
|
#
|
34
34
|
#
|
@@ -51,8 +51,8 @@ module Aws::ARCZonalShift
|
|
51
51
|
# shifts > autoshifts > practice run zonal shifts.
|
52
52
|
#
|
53
53
|
# For more information, see [How zonal autoshift and practice runs
|
54
|
-
# work][1] in the Amazon
|
55
|
-
#
|
54
|
+
# work][1] in the Amazon Application Recovery Controller Developer
|
55
|
+
# Guide.
|
56
56
|
#
|
57
57
|
#
|
58
58
|
#
|
@@ -96,6 +96,8 @@ module Aws::ARCZonalShift
|
|
96
96
|
# Web Services ends the autoshift, and traffic for the resource is no
|
97
97
|
# longer directed to the other Availability Zones in the Region.
|
98
98
|
#
|
99
|
+
# You can stop an autoshift for a resource by disabling zonal autoshift.
|
100
|
+
#
|
99
101
|
# @!attribute [rw] away_from
|
100
102
|
# The Availability Zone (for example, `use1-az1`) that traffic is
|
101
103
|
# shifted away from for a resource when Amazon Web Services starts an
|
@@ -129,6 +131,82 @@ module Aws::ARCZonalShift
|
|
129
131
|
include Aws::Structure
|
130
132
|
end
|
131
133
|
|
134
|
+
# @!attribute [rw] zonal_shift_id
|
135
|
+
# The identifier of a practice run zonal shift in Amazon Application
|
136
|
+
# Recovery Controller that you want to cancel.
|
137
|
+
# @return [String]
|
138
|
+
#
|
139
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CancelPracticeRunRequest AWS API Documentation
|
140
|
+
#
|
141
|
+
class CancelPracticeRunRequest < Struct.new(
|
142
|
+
:zonal_shift_id)
|
143
|
+
SENSITIVE = []
|
144
|
+
include Aws::Structure
|
145
|
+
end
|
146
|
+
|
147
|
+
# @!attribute [rw] zonal_shift_id
|
148
|
+
# The identifier of the practice run zonal shift in Amazon Application
|
149
|
+
# Recovery Controller that was canceled.
|
150
|
+
# @return [String]
|
151
|
+
#
|
152
|
+
# @!attribute [rw] resource_identifier
|
153
|
+
# The identifier for the resource that you canceled a practice run
|
154
|
+
# zonal shift for. The identifier is the Amazon Resource Name (ARN)
|
155
|
+
# for the resource.
|
156
|
+
# @return [String]
|
157
|
+
#
|
158
|
+
# @!attribute [rw] away_from
|
159
|
+
# The Availability Zone (for example, `use1-az1`) that traffic was
|
160
|
+
# moved away from for a resource that you specified for the practice
|
161
|
+
# run.
|
162
|
+
# @return [String]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] expiry_time
|
165
|
+
# The expiry time (expiration time) for an on-demand practice run
|
166
|
+
# zonal shift is 30 minutes from the time when you start the practice
|
167
|
+
# run, unless you cancel it before that time. However, be aware that
|
168
|
+
# the `expiryTime` field for practice run zonal shifts always has a
|
169
|
+
# value of 1 minute.
|
170
|
+
# @return [Time]
|
171
|
+
#
|
172
|
+
# @!attribute [rw] start_time
|
173
|
+
# The time (UTC) when the zonal shift starts.
|
174
|
+
# @return [Time]
|
175
|
+
#
|
176
|
+
# @!attribute [rw] status
|
177
|
+
# A status for the practice run that you canceled (expected status is
|
178
|
+
# **CANCELED**).
|
179
|
+
#
|
180
|
+
# The `Status` for a practice run zonal shift can have one of the
|
181
|
+
# following values:
|
182
|
+
# @return [String]
|
183
|
+
#
|
184
|
+
# @!attribute [rw] comment
|
185
|
+
# The initial comment that you entered about the practice run. Be
|
186
|
+
# aware that this comment can be overwritten by Amazon Web Services if
|
187
|
+
# the automatic check for balanced capacity fails. For more
|
188
|
+
# information, see [ Capacity checks for practice runs][1] in the
|
189
|
+
# Amazon Application Recovery Controller Developer Guide.
|
190
|
+
#
|
191
|
+
#
|
192
|
+
#
|
193
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.capacity-check.html
|
194
|
+
# @return [String]
|
195
|
+
#
|
196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CancelPracticeRunResponse AWS API Documentation
|
197
|
+
#
|
198
|
+
class CancelPracticeRunResponse < Struct.new(
|
199
|
+
:zonal_shift_id,
|
200
|
+
:resource_identifier,
|
201
|
+
:away_from,
|
202
|
+
:expiry_time,
|
203
|
+
:start_time,
|
204
|
+
:status,
|
205
|
+
:comment)
|
206
|
+
SENSITIVE = []
|
207
|
+
include Aws::Structure
|
208
|
+
end
|
209
|
+
|
132
210
|
# @!attribute [rw] zonal_shift_id
|
133
211
|
# The internally-generated identifier of a zonal shift.
|
134
212
|
# @return [String]
|
@@ -176,45 +254,56 @@ module Aws::ARCZonalShift
|
|
176
254
|
# Control condition alarms do not apply for autoshifts.
|
177
255
|
#
|
178
256
|
# For more information, see [ Considerations when you configure zonal
|
179
|
-
# autoshift][1] in the Amazon
|
180
|
-
#
|
257
|
+
# autoshift][1] in the Amazon Application Recovery Controller Developer
|
258
|
+
# Guide.
|
181
259
|
#
|
182
260
|
#
|
183
261
|
#
|
184
262
|
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html
|
185
263
|
#
|
186
|
-
# @!attribute [rw] alarm_identifier
|
187
|
-
# The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that
|
188
|
-
# you specify as a control condition for a practice run.
|
189
|
-
# @return [String]
|
190
|
-
#
|
191
264
|
# @!attribute [rw] type
|
192
265
|
# The type of alarm specified for a practice run. You can only specify
|
193
266
|
# Amazon CloudWatch alarms for practice runs, so the only valid value
|
194
267
|
# is `CLOUDWATCH`.
|
195
268
|
# @return [String]
|
196
269
|
#
|
270
|
+
# @!attribute [rw] alarm_identifier
|
271
|
+
# The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that
|
272
|
+
# you specify as a control condition for a practice run.
|
273
|
+
# @return [String]
|
274
|
+
#
|
197
275
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ControlCondition AWS API Documentation
|
198
276
|
#
|
199
277
|
class ControlCondition < Struct.new(
|
200
|
-
:
|
201
|
-
:
|
278
|
+
:type,
|
279
|
+
:alarm_identifier)
|
202
280
|
SENSITIVE = []
|
203
281
|
include Aws::Structure
|
204
282
|
end
|
205
283
|
|
206
|
-
# @!attribute [rw]
|
207
|
-
#
|
208
|
-
#
|
284
|
+
# @!attribute [rw] resource_identifier
|
285
|
+
# The identifier of the resource that Amazon Web Services shifts
|
286
|
+
# traffic for with a practice run zonal shift. The identifier is the
|
287
|
+
# Amazon Resource Name (ARN) for the resource.
|
209
288
|
#
|
210
|
-
#
|
211
|
-
#
|
212
|
-
# Separate multiple blocked dates with spaces.
|
289
|
+
# Amazon Application Recovery Controller currently supports enabling
|
290
|
+
# the following resources for zonal shift and zonal autoshift:
|
213
291
|
#
|
214
|
-
#
|
215
|
-
#
|
216
|
-
#
|
217
|
-
#
|
292
|
+
# * [Amazon EC2 Auto Scaling groups][1]
|
293
|
+
#
|
294
|
+
# * [Amazon Elastic Kubernetes Service][2]
|
295
|
+
#
|
296
|
+
# * [Application Load Balancer][3]
|
297
|
+
#
|
298
|
+
# * [Network Load Balancer][4]
|
299
|
+
#
|
300
|
+
#
|
301
|
+
#
|
302
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html
|
303
|
+
# [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html
|
304
|
+
# [3]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html
|
305
|
+
# [4]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html
|
306
|
+
# @return [String]
|
218
307
|
#
|
219
308
|
# @!attribute [rw] blocked_windows
|
220
309
|
# Optionally, you can block ARC from starting practice runs for
|
@@ -232,6 +321,19 @@ module Aws::ARCZonalShift
|
|
232
321
|
# WED-20:30-21:30 FRI-20:30-21:30`.
|
233
322
|
# @return [Array<String>]
|
234
323
|
#
|
324
|
+
# @!attribute [rw] blocked_dates
|
325
|
+
# Optionally, you can block ARC from starting practice runs for a
|
326
|
+
# resource on specific calendar dates.
|
327
|
+
#
|
328
|
+
# The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you
|
329
|
+
# specify dates, that dates and times for practice runs are in UTC.
|
330
|
+
# Separate multiple blocked dates with spaces.
|
331
|
+
#
|
332
|
+
# For example, if you have an application update scheduled to launch
|
333
|
+
# on May 1, 2024, and you don't want practice runs to shift traffic
|
334
|
+
# away at that time, you could set a blocked date for `2024-05-01`.
|
335
|
+
# @return [Array<String>]
|
336
|
+
#
|
235
337
|
# @!attribute [rw] blocking_alarms
|
236
338
|
# An Amazon CloudWatch alarm that you can specify for zonal autoshift
|
237
339
|
# practice runs. This alarm blocks ARC from starting practice run
|
@@ -252,24 +354,14 @@ module Aws::ARCZonalShift
|
|
252
354
|
# to the Availability Zone.
|
253
355
|
# @return [Array<Types::ControlCondition>]
|
254
356
|
#
|
255
|
-
# @!attribute [rw] resource_identifier
|
256
|
-
# The identifier of the resource that Amazon Web Services shifts
|
257
|
-
# traffic for with a practice run zonal shift. The identifier is the
|
258
|
-
# Amazon Resource Name (ARN) for the resource.
|
259
|
-
#
|
260
|
-
# At this time, supported resources are Network Load Balancers and
|
261
|
-
# Application Load Balancers with cross-zone load balancing turned
|
262
|
-
# off.
|
263
|
-
# @return [String]
|
264
|
-
#
|
265
357
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CreatePracticeRunConfigurationRequest AWS API Documentation
|
266
358
|
#
|
267
359
|
class CreatePracticeRunConfigurationRequest < Struct.new(
|
268
|
-
:
|
360
|
+
:resource_identifier,
|
269
361
|
:blocked_windows,
|
362
|
+
:blocked_dates,
|
270
363
|
:blocking_alarms,
|
271
|
-
:outcome_alarms
|
272
|
-
:resource_identifier)
|
364
|
+
:outcome_alarms)
|
273
365
|
SENSITIVE = []
|
274
366
|
include Aws::Structure
|
275
367
|
end
|
@@ -283,12 +375,6 @@ module Aws::ARCZonalShift
|
|
283
375
|
# The name of the resource that you configured the practice run for.
|
284
376
|
# @return [String]
|
285
377
|
#
|
286
|
-
# @!attribute [rw] practice_run_configuration
|
287
|
-
# A practice run configuration for a resource. Configurations include
|
288
|
-
# the outcome alarm that you specify for practice runs, and,
|
289
|
-
# optionally, a blocking alarm and blocking dates and windows.
|
290
|
-
# @return [Types::PracticeRunConfiguration]
|
291
|
-
#
|
292
378
|
# @!attribute [rw] zonal_autoshift_status
|
293
379
|
# The status for zonal autoshift for a resource. When you specify
|
294
380
|
# `ENABLED` for the autoshift status, Amazon Web Services shifts
|
@@ -301,13 +387,19 @@ module Aws::ARCZonalShift
|
|
301
387
|
# runs for the resource.
|
302
388
|
# @return [String]
|
303
389
|
#
|
390
|
+
# @!attribute [rw] practice_run_configuration
|
391
|
+
# A practice run configuration for a resource. Configurations include
|
392
|
+
# the outcome alarm that you specify for practice runs, and,
|
393
|
+
# optionally, a blocking alarm and blocking dates and windows.
|
394
|
+
# @return [Types::PracticeRunConfiguration]
|
395
|
+
#
|
304
396
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CreatePracticeRunConfigurationResponse AWS API Documentation
|
305
397
|
#
|
306
398
|
class CreatePracticeRunConfigurationResponse < Struct.new(
|
307
399
|
:arn,
|
308
400
|
:name,
|
309
|
-
:
|
310
|
-
:
|
401
|
+
:zonal_autoshift_status,
|
402
|
+
:practice_run_configuration)
|
311
403
|
SENSITIVE = []
|
312
404
|
include Aws::Structure
|
313
405
|
end
|
@@ -376,9 +468,23 @@ module Aws::ARCZonalShift
|
|
376
468
|
# traffic for. The identifier is the Amazon Resource Name (ARN) for
|
377
469
|
# the resource.
|
378
470
|
#
|
379
|
-
#
|
380
|
-
#
|
381
|
-
#
|
471
|
+
# Amazon Application Recovery Controller currently supports enabling
|
472
|
+
# the following resources for zonal shift and zonal autoshift:
|
473
|
+
#
|
474
|
+
# * [Amazon EC2 Auto Scaling groups][1]
|
475
|
+
#
|
476
|
+
# * [Amazon Elastic Kubernetes Service][2]
|
477
|
+
#
|
478
|
+
# * [Application Load Balancer][3]
|
479
|
+
#
|
480
|
+
# * [Network Load Balancer][4]
|
481
|
+
#
|
482
|
+
#
|
483
|
+
#
|
484
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html
|
485
|
+
# [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html
|
486
|
+
# [3]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html
|
487
|
+
# [4]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html
|
382
488
|
# @return [String]
|
383
489
|
#
|
384
490
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/GetManagedResourceRequest AWS API Documentation
|
@@ -389,6 +495,14 @@ module Aws::ARCZonalShift
|
|
389
495
|
include Aws::Structure
|
390
496
|
end
|
391
497
|
|
498
|
+
# @!attribute [rw] arn
|
499
|
+
# The Amazon Resource Name (ARN) for the resource.
|
500
|
+
# @return [String]
|
501
|
+
#
|
502
|
+
# @!attribute [rw] name
|
503
|
+
# The name of the resource.
|
504
|
+
# @return [String]
|
505
|
+
#
|
392
506
|
# @!attribute [rw] applied_weights
|
393
507
|
# A collection of key-value pairs that indicate whether resources are
|
394
508
|
# active in Availability Zones or not. The key name is the
|
@@ -396,18 +510,14 @@ module Aws::ARCZonalShift
|
|
396
510
|
# 0.
|
397
511
|
# @return [Hash<String,Float>]
|
398
512
|
#
|
399
|
-
# @!attribute [rw]
|
400
|
-
# The
|
401
|
-
# @return [
|
513
|
+
# @!attribute [rw] zonal_shifts
|
514
|
+
# The zonal shifts that are currently active for a resource.
|
515
|
+
# @return [Array<Types::ZonalShiftInResource>]
|
402
516
|
#
|
403
517
|
# @!attribute [rw] autoshifts
|
404
518
|
# An array of the autoshifts that are active for the resource.
|
405
519
|
# @return [Array<Types::AutoshiftInResource>]
|
406
520
|
#
|
407
|
-
# @!attribute [rw] name
|
408
|
-
# The name of the resource.
|
409
|
-
# @return [String]
|
410
|
-
#
|
411
521
|
# @!attribute [rw] practice_run_configuration
|
412
522
|
# The practice run configuration for zonal autoshift that's
|
413
523
|
# associated with the resource.
|
@@ -421,20 +531,16 @@ module Aws::ARCZonalShift
|
|
421
531
|
# Zone that could potentially affect customers.
|
422
532
|
# @return [String]
|
423
533
|
#
|
424
|
-
# @!attribute [rw] zonal_shifts
|
425
|
-
# The zonal shifts that are currently active for a resource.
|
426
|
-
# @return [Array<Types::ZonalShiftInResource>]
|
427
|
-
#
|
428
534
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/GetManagedResourceResponse AWS API Documentation
|
429
535
|
#
|
430
536
|
class GetManagedResourceResponse < Struct.new(
|
431
|
-
:applied_weights,
|
432
537
|
:arn,
|
433
|
-
:autoshifts,
|
434
538
|
:name,
|
539
|
+
:applied_weights,
|
540
|
+
:zonal_shifts,
|
541
|
+
:autoshifts,
|
435
542
|
:practice_run_configuration,
|
436
|
-
:zonal_autoshift_status
|
437
|
-
:zonal_shifts)
|
543
|
+
:zonal_autoshift_status)
|
438
544
|
SENSITIVE = []
|
439
545
|
include Aws::Structure
|
440
546
|
end
|
@@ -452,10 +558,6 @@ module Aws::ARCZonalShift
|
|
452
558
|
include Aws::Structure
|
453
559
|
end
|
454
560
|
|
455
|
-
# @!attribute [rw] max_results
|
456
|
-
# The number of objects that you want to return with this call.
|
457
|
-
# @return [Integer]
|
458
|
-
#
|
459
561
|
# @!attribute [rw] next_token
|
460
562
|
# Specifies that you want to receive the next page of results. Valid
|
461
563
|
# only if you received a `nextToken` response in the previous request.
|
@@ -468,12 +570,16 @@ module Aws::ARCZonalShift
|
|
468
570
|
# The status of the autoshift.
|
469
571
|
# @return [String]
|
470
572
|
#
|
573
|
+
# @!attribute [rw] max_results
|
574
|
+
# The number of objects that you want to return with this call.
|
575
|
+
# @return [Integer]
|
576
|
+
#
|
471
577
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListAutoshiftsRequest AWS API Documentation
|
472
578
|
#
|
473
579
|
class ListAutoshiftsRequest < Struct.new(
|
474
|
-
:max_results,
|
475
580
|
:next_token,
|
476
|
-
:status
|
581
|
+
:status,
|
582
|
+
:max_results)
|
477
583
|
SENSITIVE = []
|
478
584
|
include Aws::Structure
|
479
585
|
end
|
@@ -499,10 +605,6 @@ module Aws::ARCZonalShift
|
|
499
605
|
include Aws::Structure
|
500
606
|
end
|
501
607
|
|
502
|
-
# @!attribute [rw] max_results
|
503
|
-
# The number of objects that you want to return with this call.
|
504
|
-
# @return [Integer]
|
505
|
-
#
|
506
608
|
# @!attribute [rw] next_token
|
507
609
|
# Specifies that you want to receive the next page of results. Valid
|
508
610
|
# only if you received a `nextToken` response in the previous request.
|
@@ -511,11 +613,15 @@ module Aws::ARCZonalShift
|
|
511
613
|
# response to request the next page of results.
|
512
614
|
# @return [String]
|
513
615
|
#
|
616
|
+
# @!attribute [rw] max_results
|
617
|
+
# The number of objects that you want to return with this call.
|
618
|
+
# @return [Integer]
|
619
|
+
#
|
514
620
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListManagedResourcesRequest AWS API Documentation
|
515
621
|
#
|
516
622
|
class ListManagedResourcesRequest < Struct.new(
|
517
|
-
:
|
518
|
-
:
|
623
|
+
:next_token,
|
624
|
+
:max_results)
|
519
625
|
SENSITIVE = []
|
520
626
|
include Aws::Structure
|
521
627
|
end
|
@@ -541,10 +647,6 @@ module Aws::ARCZonalShift
|
|
541
647
|
include Aws::Structure
|
542
648
|
end
|
543
649
|
|
544
|
-
# @!attribute [rw] max_results
|
545
|
-
# The number of objects that you want to return with this call.
|
546
|
-
# @return [Integer]
|
547
|
-
#
|
548
650
|
# @!attribute [rw] next_token
|
549
651
|
# Specifies that you want to receive the next page of results. Valid
|
550
652
|
# only if you received a `nextToken` response in the previous request.
|
@@ -553,18 +655,12 @@ module Aws::ARCZonalShift
|
|
553
655
|
# response to request the next page of results.
|
554
656
|
# @return [String]
|
555
657
|
#
|
556
|
-
# @!attribute [rw] resource_identifier
|
557
|
-
# The identifier for the resource that you want to list zonal shifts
|
558
|
-
# for. The identifier is the Amazon Resource Name (ARN) for the
|
559
|
-
# resource.
|
560
|
-
# @return [String]
|
561
|
-
#
|
562
658
|
# @!attribute [rw] status
|
563
659
|
# A status for a zonal shift.
|
564
660
|
#
|
565
661
|
# The `Status` for a zonal shift can have one of the following values:
|
566
662
|
#
|
567
|
-
# * **ACTIVE**: The zonal shift has been started and active.
|
663
|
+
# * **ACTIVE**: The zonal shift has been started and is active.
|
568
664
|
#
|
569
665
|
# * **EXPIRED**: The zonal shift has expired (the expiry time was
|
570
666
|
# exceeded).
|
@@ -572,13 +668,23 @@ module Aws::ARCZonalShift
|
|
572
668
|
# * **CANCELED**: The zonal shift was canceled.
|
573
669
|
# @return [String]
|
574
670
|
#
|
671
|
+
# @!attribute [rw] max_results
|
672
|
+
# The number of objects that you want to return with this call.
|
673
|
+
# @return [Integer]
|
674
|
+
#
|
675
|
+
# @!attribute [rw] resource_identifier
|
676
|
+
# The identifier for the resource that you want to list zonal shifts
|
677
|
+
# for. The identifier is the Amazon Resource Name (ARN) for the
|
678
|
+
# resource.
|
679
|
+
# @return [String]
|
680
|
+
#
|
575
681
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListZonalShiftsRequest AWS API Documentation
|
576
682
|
#
|
577
683
|
class ListZonalShiftsRequest < Struct.new(
|
578
|
-
:max_results,
|
579
684
|
:next_token,
|
580
|
-
:
|
581
|
-
:
|
685
|
+
:status,
|
686
|
+
:max_results,
|
687
|
+
:resource_identifier)
|
582
688
|
SENSITIVE = []
|
583
689
|
include Aws::Structure
|
584
690
|
end
|
@@ -607,17 +713,29 @@ module Aws::ARCZonalShift
|
|
607
713
|
# A complex structure for a managed resource in an Amazon Web Services
|
608
714
|
# account with information about zonal shifts and autoshifts.
|
609
715
|
#
|
610
|
-
#
|
611
|
-
#
|
612
|
-
#
|
613
|
-
#
|
614
|
-
# also configure zonal autoshift for a managed resource.
|
716
|
+
# You can start a zonal shift in ARC for a managed resource to
|
717
|
+
# temporarily move traffic for the resource away from an Availability
|
718
|
+
# Zone in an Amazon Web Services Region. You can also configure zonal
|
719
|
+
# autoshift for a managed resource.
|
615
720
|
#
|
616
|
-
# <note markdown="1"> At this time, managed resources are
|
617
|
-
#
|
721
|
+
# <note markdown="1"> At this time, managed resources are Amazon EC2 Auto Scaling groups,
|
722
|
+
# Amazon Elastic Kubernetes Service, Network Load Balancers, and
|
723
|
+
# Application Load Balancer.
|
618
724
|
#
|
619
725
|
# </note>
|
620
726
|
#
|
727
|
+
# @!attribute [rw] arn
|
728
|
+
# The Amazon Resource Name (ARN) for the managed resource.
|
729
|
+
# @return [String]
|
730
|
+
#
|
731
|
+
# @!attribute [rw] name
|
732
|
+
# The name of the managed resource.
|
733
|
+
# @return [String]
|
734
|
+
#
|
735
|
+
# @!attribute [rw] availability_zones
|
736
|
+
# The Availability Zones that a resource is deployed in.
|
737
|
+
# @return [Array<String>]
|
738
|
+
#
|
621
739
|
# @!attribute [rw] applied_weights
|
622
740
|
# A collection of key-value pairs that indicate whether resources are
|
623
741
|
# active in Availability Zones or not. The key name is the
|
@@ -625,20 +743,18 @@ module Aws::ARCZonalShift
|
|
625
743
|
# 0.
|
626
744
|
# @return [Hash<String,Float>]
|
627
745
|
#
|
628
|
-
# @!attribute [rw]
|
629
|
-
#
|
630
|
-
# @return [
|
746
|
+
# @!attribute [rw] zonal_shifts
|
747
|
+
# An array of the zonal shifts for a resource.
|
748
|
+
# @return [Array<Types::ZonalShiftInResource>]
|
631
749
|
#
|
632
750
|
# @!attribute [rw] autoshifts
|
633
751
|
# An array of the autoshifts that have been completed for a resource.
|
634
752
|
# @return [Array<Types::AutoshiftInResource>]
|
635
753
|
#
|
636
|
-
# @!attribute [rw]
|
637
|
-
# The
|
638
|
-
#
|
639
|
-
#
|
640
|
-
# @!attribute [rw] name
|
641
|
-
# The name of the managed resource.
|
754
|
+
# @!attribute [rw] zonal_autoshift_status
|
755
|
+
# The status of autoshift for a resource. When you configure zonal
|
756
|
+
# autoshift for a resource, you can set the value of the status to
|
757
|
+
# `ENABLED` or `DISABLED`.
|
642
758
|
# @return [String]
|
643
759
|
#
|
644
760
|
# @!attribute [rw] practice_run_status
|
@@ -653,27 +769,17 @@ module Aws::ARCZonalShift
|
|
653
769
|
# `ENABLED` or `DISABLED`.
|
654
770
|
# @return [String]
|
655
771
|
#
|
656
|
-
# @!attribute [rw] zonal_autoshift_status
|
657
|
-
# The status of autoshift for a resource. When you configure zonal
|
658
|
-
# autoshift for a resource, you can set the value of the status to
|
659
|
-
# `ENABLED` or `DISABLED`.
|
660
|
-
# @return [String]
|
661
|
-
#
|
662
|
-
# @!attribute [rw] zonal_shifts
|
663
|
-
# An array of the zonal shifts for a resource.
|
664
|
-
# @return [Array<Types::ZonalShiftInResource>]
|
665
|
-
#
|
666
772
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ManagedResourceSummary AWS API Documentation
|
667
773
|
#
|
668
774
|
class ManagedResourceSummary < Struct.new(
|
669
|
-
:applied_weights,
|
670
775
|
:arn,
|
671
|
-
:autoshifts,
|
672
|
-
:availability_zones,
|
673
776
|
:name,
|
674
|
-
:
|
777
|
+
:availability_zones,
|
778
|
+
:applied_weights,
|
779
|
+
:zonal_shifts,
|
780
|
+
:autoshifts,
|
675
781
|
:zonal_autoshift_status,
|
676
|
-
:
|
782
|
+
:practice_run_status)
|
677
783
|
SENSITIVE = []
|
678
784
|
include Aws::Structure
|
679
785
|
end
|
@@ -694,13 +800,16 @@ module Aws::ARCZonalShift
|
|
694
800
|
# for the resource. A practice run configuration is required when zonal
|
695
801
|
# autoshift is enabled.
|
696
802
|
#
|
697
|
-
# @!attribute [rw]
|
698
|
-
#
|
699
|
-
#
|
803
|
+
# @!attribute [rw] blocking_alarms
|
804
|
+
# The *blocking alarm* for practice runs is an optional alarm that you
|
805
|
+
# can specify that blocks practice runs when the alarm is in an
|
806
|
+
# `ALARM` state.
|
807
|
+
# @return [Array<Types::ControlCondition>]
|
700
808
|
#
|
701
|
-
#
|
702
|
-
#
|
703
|
-
#
|
809
|
+
# @!attribute [rw] outcome_alarms
|
810
|
+
# The *outcome alarm* for practice runs is an alarm that you specify
|
811
|
+
# that ends a practice run when the alarm is in an `ALARM` state.
|
812
|
+
# @return [Array<Types::ControlCondition>]
|
704
813
|
#
|
705
814
|
# @!attribute [rw] blocked_windows
|
706
815
|
# An array of one or more windows of days and times that you can block
|
@@ -711,24 +820,21 @@ module Aws::ARCZonalShift
|
|
711
820
|
# `MON:18:30-MON:19:30 TUE:18:30-TUE:19:30`.
|
712
821
|
# @return [Array<String>]
|
713
822
|
#
|
714
|
-
# @!attribute [rw]
|
715
|
-
#
|
716
|
-
#
|
717
|
-
# `ALARM` state.
|
718
|
-
# @return [Array<Types::ControlCondition>]
|
823
|
+
# @!attribute [rw] blocked_dates
|
824
|
+
# An array of one or more dates that you can specify when Amazon Web
|
825
|
+
# Services does not start practice runs for a resource.
|
719
826
|
#
|
720
|
-
#
|
721
|
-
#
|
722
|
-
#
|
723
|
-
# @return [Array<Types::ControlCondition>]
|
827
|
+
# Specify blocked dates, in UTC, in the format `YYYY-MM-DD`, separated
|
828
|
+
# by spaces.
|
829
|
+
# @return [Array<String>]
|
724
830
|
#
|
725
831
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/PracticeRunConfiguration AWS API Documentation
|
726
832
|
#
|
727
833
|
class PracticeRunConfiguration < Struct.new(
|
728
|
-
:blocked_dates,
|
729
|
-
:blocked_windows,
|
730
834
|
:blocking_alarms,
|
731
|
-
:outcome_alarms
|
835
|
+
:outcome_alarms,
|
836
|
+
:blocked_windows,
|
837
|
+
:blocked_dates)
|
732
838
|
SENSITIVE = []
|
733
839
|
include Aws::Structure
|
734
840
|
end
|
@@ -746,6 +852,121 @@ module Aws::ARCZonalShift
|
|
746
852
|
include Aws::Structure
|
747
853
|
end
|
748
854
|
|
855
|
+
# @!attribute [rw] resource_identifier
|
856
|
+
# The identifier for the resource that you want to start a practice
|
857
|
+
# run zonal shift for. The identifier is the Amazon Resource Name
|
858
|
+
# (ARN) for the resource.
|
859
|
+
# @return [String]
|
860
|
+
#
|
861
|
+
# @!attribute [rw] away_from
|
862
|
+
# The Availability Zone (for example, `use1-az1`) that traffic is
|
863
|
+
# shifted away from for the resource that you specify for the practice
|
864
|
+
# run.
|
865
|
+
# @return [String]
|
866
|
+
#
|
867
|
+
# @!attribute [rw] comment
|
868
|
+
# The initial comment that you enter about the practice run. Be aware
|
869
|
+
# that this comment can be overwritten by Amazon Web Services if the
|
870
|
+
# automatic check for balanced capacity fails. For more information,
|
871
|
+
# see [ Capacity checks for practice runs][1] in the Amazon
|
872
|
+
# Application Recovery Controller Developer Guide.
|
873
|
+
#
|
874
|
+
#
|
875
|
+
#
|
876
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.capacity-check.html
|
877
|
+
# @return [String]
|
878
|
+
#
|
879
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/StartPracticeRunRequest AWS API Documentation
|
880
|
+
#
|
881
|
+
class StartPracticeRunRequest < Struct.new(
|
882
|
+
:resource_identifier,
|
883
|
+
:away_from,
|
884
|
+
:comment)
|
885
|
+
SENSITIVE = []
|
886
|
+
include Aws::Structure
|
887
|
+
end
|
888
|
+
|
889
|
+
# @!attribute [rw] zonal_shift_id
|
890
|
+
# The identifier of a practice run zonal shift.
|
891
|
+
# @return [String]
|
892
|
+
#
|
893
|
+
# @!attribute [rw] resource_identifier
|
894
|
+
# The identifier for the resource that you want to shift traffic for.
|
895
|
+
# The identifier is the Amazon Resource Name (ARN) for the resource.
|
896
|
+
# @return [String]
|
897
|
+
#
|
898
|
+
# @!attribute [rw] away_from
|
899
|
+
# The Availability Zone (for example, `use1-az1`) that traffic is
|
900
|
+
# shifted away from for the resource that you specify for the practice
|
901
|
+
# run.
|
902
|
+
# @return [String]
|
903
|
+
#
|
904
|
+
# @!attribute [rw] expiry_time
|
905
|
+
# The expiry time (expiration time) for an on-demand practice run
|
906
|
+
# zonal shift is 30 minutes from the time when you start the practice
|
907
|
+
# run, unless you cancel it before that time. However, be aware that
|
908
|
+
# the `expiryTime` field for practice run zonal shifts always has a
|
909
|
+
# value of 1 minute.
|
910
|
+
# @return [Time]
|
911
|
+
#
|
912
|
+
# @!attribute [rw] start_time
|
913
|
+
# The time (UTC) when the zonal shift starts.
|
914
|
+
# @return [Time]
|
915
|
+
#
|
916
|
+
# @!attribute [rw] status
|
917
|
+
# A status for the practice run (expected status is **ACTIVE**).
|
918
|
+
# @return [String]
|
919
|
+
#
|
920
|
+
# @!attribute [rw] comment
|
921
|
+
# The initial comment that you enter about the practice run. Be aware
|
922
|
+
# that this comment can be overwritten by Amazon Web Services if the
|
923
|
+
# automatic check for balanced capacity fails. For more information,
|
924
|
+
# see [ Capacity checks for practice runs][1] in the Amazon
|
925
|
+
# Application Recovery Controller Developer Guide.
|
926
|
+
#
|
927
|
+
#
|
928
|
+
#
|
929
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.capacity-check.html
|
930
|
+
# @return [String]
|
931
|
+
#
|
932
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/StartPracticeRunResponse AWS API Documentation
|
933
|
+
#
|
934
|
+
class StartPracticeRunResponse < Struct.new(
|
935
|
+
:zonal_shift_id,
|
936
|
+
:resource_identifier,
|
937
|
+
:away_from,
|
938
|
+
:expiry_time,
|
939
|
+
:start_time,
|
940
|
+
:status,
|
941
|
+
:comment)
|
942
|
+
SENSITIVE = []
|
943
|
+
include Aws::Structure
|
944
|
+
end
|
945
|
+
|
946
|
+
# @!attribute [rw] resource_identifier
|
947
|
+
# The identifier for the resource that Amazon Web Services shifts
|
948
|
+
# traffic for. The identifier is the Amazon Resource Name (ARN) for
|
949
|
+
# the resource.
|
950
|
+
#
|
951
|
+
# Amazon Application Recovery Controller currently supports enabling
|
952
|
+
# the following resources for zonal shift and zonal autoshift:
|
953
|
+
#
|
954
|
+
# * [Amazon EC2 Auto Scaling groups][1]
|
955
|
+
#
|
956
|
+
# * [Amazon Elastic Kubernetes Service][2]
|
957
|
+
#
|
958
|
+
# * [Application Load Balancer][3]
|
959
|
+
#
|
960
|
+
# * [Network Load Balancer][4]
|
961
|
+
#
|
962
|
+
#
|
963
|
+
#
|
964
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html
|
965
|
+
# [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html
|
966
|
+
# [3]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html
|
967
|
+
# [4]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html
|
968
|
+
# @return [String]
|
969
|
+
#
|
749
970
|
# @!attribute [rw] away_from
|
750
971
|
# The Availability Zone (for example, `use1-az1`) that traffic is
|
751
972
|
# moved away from for a resource when you start a zonal shift. Until
|
@@ -754,12 +975,6 @@ module Aws::ARCZonalShift
|
|
754
975
|
# Services Region.
|
755
976
|
# @return [String]
|
756
977
|
#
|
757
|
-
# @!attribute [rw] comment
|
758
|
-
# A comment that you enter about the zonal shift. Only the latest
|
759
|
-
# comment is retained; no comment history is maintained. A new comment
|
760
|
-
# overwrites any existing comment string.
|
761
|
-
# @return [String]
|
762
|
-
#
|
763
978
|
# @!attribute [rw] expires_in
|
764
979
|
# The length of time that you want a zonal shift to be active, which
|
765
980
|
# ARC converts to an expiry time (expiration time). Zonal shifts are
|
@@ -782,23 +997,19 @@ module Aws::ARCZonalShift
|
|
782
997
|
# means the zonal shift expires in 120 minutes (2 hours).
|
783
998
|
# @return [String]
|
784
999
|
#
|
785
|
-
# @!attribute [rw]
|
786
|
-
#
|
787
|
-
#
|
788
|
-
#
|
789
|
-
#
|
790
|
-
# At this time, supported resources are Network Load Balancers and
|
791
|
-
# Application Load Balancers with cross-zone load balancing turned
|
792
|
-
# off.
|
1000
|
+
# @!attribute [rw] comment
|
1001
|
+
# A comment that you enter about the zonal shift. Only the latest
|
1002
|
+
# comment is retained; no comment history is maintained. A new comment
|
1003
|
+
# overwrites any existing comment string.
|
793
1004
|
# @return [String]
|
794
1005
|
#
|
795
1006
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/StartZonalShiftRequest AWS API Documentation
|
796
1007
|
#
|
797
1008
|
class StartZonalShiftRequest < Struct.new(
|
1009
|
+
:resource_identifier,
|
798
1010
|
:away_from,
|
799
|
-
:comment,
|
800
1011
|
:expires_in,
|
801
|
-
:
|
1012
|
+
:comment)
|
802
1013
|
SENSITIVE = []
|
803
1014
|
include Aws::Structure
|
804
1015
|
end
|
@@ -844,19 +1055,11 @@ module Aws::ARCZonalShift
|
|
844
1055
|
include Aws::Structure
|
845
1056
|
end
|
846
1057
|
|
847
|
-
# @!attribute [rw]
|
848
|
-
#
|
849
|
-
#
|
850
|
-
#
|
851
|
-
#
|
852
|
-
# The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you
|
853
|
-
# specify dates, that dates and times for practice runs are in UTC.
|
854
|
-
# Separate multiple blocked dates with spaces.
|
855
|
-
#
|
856
|
-
# For example, if you have an application update scheduled to launch
|
857
|
-
# on May 1, 2024, and you don't want practice runs to shift traffic
|
858
|
-
# away at that time, you could set a blocked date for `2024-05-01`.
|
859
|
-
# @return [Array<String>]
|
1058
|
+
# @!attribute [rw] resource_identifier
|
1059
|
+
# The identifier for the resource that you want to update the practice
|
1060
|
+
# run configuration for. The identifier is the Amazon Resource Name
|
1061
|
+
# (ARN) for the resource.
|
1062
|
+
# @return [String]
|
860
1063
|
#
|
861
1064
|
# @!attribute [rw] blocked_windows
|
862
1065
|
# Add, change, or remove windows of days and times for when you can,
|
@@ -874,6 +1077,20 @@ module Aws::ARCZonalShift
|
|
874
1077
|
# WED-20:30-21:30 FRI-20:30-21:30`.
|
875
1078
|
# @return [Array<String>]
|
876
1079
|
#
|
1080
|
+
# @!attribute [rw] blocked_dates
|
1081
|
+
# Add, change, or remove blocked dates for a practice run in zonal
|
1082
|
+
# autoshift.
|
1083
|
+
#
|
1084
|
+
# Optionally, you can block practice runs for specific calendar dates.
|
1085
|
+
# The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you
|
1086
|
+
# specify dates, that dates and times for practice runs are in UTC.
|
1087
|
+
# Separate multiple blocked dates with spaces.
|
1088
|
+
#
|
1089
|
+
# For example, if you have an application update scheduled to launch
|
1090
|
+
# on May 1, 2024, and you don't want practice runs to shift traffic
|
1091
|
+
# away at that time, you could set a blocked date for `2024-05-01`.
|
1092
|
+
# @return [Array<String>]
|
1093
|
+
#
|
877
1094
|
# @!attribute [rw] blocking_alarms
|
878
1095
|
# Add, change, or remove the Amazon CloudWatch alarm that you
|
879
1096
|
# optionally specify as the blocking alarm for practice runs.
|
@@ -884,20 +1101,14 @@ module Aws::ARCZonalShift
|
|
884
1101
|
# practice runs.
|
885
1102
|
# @return [Array<Types::ControlCondition>]
|
886
1103
|
#
|
887
|
-
# @!attribute [rw] resource_identifier
|
888
|
-
# The identifier for the resource that you want to update the practice
|
889
|
-
# run configuration for. The identifier is the Amazon Resource Name
|
890
|
-
# (ARN) for the resource.
|
891
|
-
# @return [String]
|
892
|
-
#
|
893
1104
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdatePracticeRunConfigurationRequest AWS API Documentation
|
894
1105
|
#
|
895
1106
|
class UpdatePracticeRunConfigurationRequest < Struct.new(
|
896
|
-
:
|
1107
|
+
:resource_identifier,
|
897
1108
|
:blocked_windows,
|
1109
|
+
:blocked_dates,
|
898
1110
|
:blocking_alarms,
|
899
|
-
:outcome_alarms
|
900
|
-
:resource_identifier)
|
1111
|
+
:outcome_alarms)
|
901
1112
|
SENSITIVE = []
|
902
1113
|
include Aws::Structure
|
903
1114
|
end
|
@@ -911,22 +1122,22 @@ module Aws::ARCZonalShift
|
|
911
1122
|
# The name of the resource that you updated the practice run for.
|
912
1123
|
# @return [String]
|
913
1124
|
#
|
914
|
-
# @!attribute [rw] practice_run_configuration
|
915
|
-
# The practice run configuration that was updated.
|
916
|
-
# @return [Types::PracticeRunConfiguration]
|
917
|
-
#
|
918
1125
|
# @!attribute [rw] zonal_autoshift_status
|
919
1126
|
# The zonal autoshift status for the resource that you updated the
|
920
1127
|
# practice run for.
|
921
1128
|
# @return [String]
|
922
1129
|
#
|
1130
|
+
# @!attribute [rw] practice_run_configuration
|
1131
|
+
# The practice run configuration that was updated.
|
1132
|
+
# @return [Types::PracticeRunConfiguration]
|
1133
|
+
#
|
923
1134
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdatePracticeRunConfigurationResponse AWS API Documentation
|
924
1135
|
#
|
925
1136
|
class UpdatePracticeRunConfigurationResponse < Struct.new(
|
926
1137
|
:arn,
|
927
1138
|
:name,
|
928
|
-
:
|
929
|
-
:
|
1139
|
+
:zonal_autoshift_status,
|
1140
|
+
:practice_run_configuration)
|
930
1141
|
SENSITIVE = []
|
931
1142
|
include Aws::Structure
|
932
1143
|
end
|
@@ -973,6 +1184,10 @@ module Aws::ARCZonalShift
|
|
973
1184
|
include Aws::Structure
|
974
1185
|
end
|
975
1186
|
|
1187
|
+
# @!attribute [rw] zonal_shift_id
|
1188
|
+
# The identifier of a zonal shift.
|
1189
|
+
# @return [String]
|
1190
|
+
#
|
976
1191
|
# @!attribute [rw] comment
|
977
1192
|
# A comment that you enter about the zonal shift. Only the latest
|
978
1193
|
# comment is retained; no comment history is maintained. A new comment
|
@@ -1001,16 +1216,12 @@ module Aws::ARCZonalShift
|
|
1001
1216
|
# means the zonal shift expires in 120 minutes (2 hours).
|
1002
1217
|
# @return [String]
|
1003
1218
|
#
|
1004
|
-
# @!attribute [rw] zonal_shift_id
|
1005
|
-
# The identifier of a zonal shift.
|
1006
|
-
# @return [String]
|
1007
|
-
#
|
1008
1219
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdateZonalShiftRequest AWS API Documentation
|
1009
1220
|
#
|
1010
1221
|
class UpdateZonalShiftRequest < Struct.new(
|
1222
|
+
:zonal_shift_id,
|
1011
1223
|
:comment,
|
1012
|
-
:expires_in
|
1013
|
-
:zonal_shift_id)
|
1224
|
+
:expires_in)
|
1014
1225
|
SENSITIVE = []
|
1015
1226
|
include Aws::Structure
|
1016
1227
|
end
|
@@ -1034,6 +1245,34 @@ module Aws::ARCZonalShift
|
|
1034
1245
|
include Aws::Structure
|
1035
1246
|
end
|
1036
1247
|
|
1248
|
+
# @!attribute [rw] zonal_shift_id
|
1249
|
+
# The identifier of a zonal shift.
|
1250
|
+
# @return [String]
|
1251
|
+
#
|
1252
|
+
# @!attribute [rw] resource_identifier
|
1253
|
+
# The identifier for the resource that Amazon Web Services shifts
|
1254
|
+
# traffic for. The identifier is the Amazon Resource Name (ARN) for
|
1255
|
+
# the resource.
|
1256
|
+
#
|
1257
|
+
# Amazon Application Recovery Controller currently supports enabling
|
1258
|
+
# the following resources for zonal shift and zonal autoshift:
|
1259
|
+
#
|
1260
|
+
# * [Amazon EC2 Auto Scaling groups][1]
|
1261
|
+
#
|
1262
|
+
# * [Amazon Elastic Kubernetes Service][2]
|
1263
|
+
#
|
1264
|
+
# * [Application Load Balancer][3]
|
1265
|
+
#
|
1266
|
+
# * [Network Load Balancer][4]
|
1267
|
+
#
|
1268
|
+
#
|
1269
|
+
#
|
1270
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html
|
1271
|
+
# [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html
|
1272
|
+
# [3]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html
|
1273
|
+
# [4]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html
|
1274
|
+
# @return [String]
|
1275
|
+
#
|
1037
1276
|
# @!attribute [rw] away_from
|
1038
1277
|
# The Availability Zone (for example, `use1-az1`) that traffic is
|
1039
1278
|
# moved away from for a resource when you start a zonal shift. Until
|
@@ -1042,12 +1281,6 @@ module Aws::ARCZonalShift
|
|
1042
1281
|
# Services Region.
|
1043
1282
|
# @return [String]
|
1044
1283
|
#
|
1045
|
-
# @!attribute [rw] comment
|
1046
|
-
# A comment that you enter about the zonal shift. Only the latest
|
1047
|
-
# comment is retained; no comment history is maintained. A new comment
|
1048
|
-
# overwrites any existing comment string.
|
1049
|
-
# @return [String]
|
1050
|
-
#
|
1051
1284
|
# @!attribute [rw] expiry_time
|
1052
1285
|
# The expiry time (expiration time) for a customer-initiated zonal
|
1053
1286
|
# shift. A zonal shift is temporary and must be set to expire when you
|
@@ -1063,16 +1296,6 @@ module Aws::ARCZonalShift
|
|
1063
1296
|
# in.
|
1064
1297
|
# @return [Time]
|
1065
1298
|
#
|
1066
|
-
# @!attribute [rw] resource_identifier
|
1067
|
-
# The identifier for the resource that Amazon Web Services shifts
|
1068
|
-
# traffic for. The identifier is the Amazon Resource Name (ARN) for
|
1069
|
-
# the resource.
|
1070
|
-
#
|
1071
|
-
# At this time, supported resources are Network Load Balancers and
|
1072
|
-
# Application Load Balancers with cross-zone load balancing turned
|
1073
|
-
# off.
|
1074
|
-
# @return [String]
|
1075
|
-
#
|
1076
1299
|
# @!attribute [rw] start_time
|
1077
1300
|
# The time (UTC) when the zonal shift starts.
|
1078
1301
|
# @return [Time]
|
@@ -1082,7 +1305,7 @@ module Aws::ARCZonalShift
|
|
1082
1305
|
#
|
1083
1306
|
# The `Status` for a zonal shift can have one of the following values:
|
1084
1307
|
#
|
1085
|
-
# * **ACTIVE:** The zonal shift has been started and active.
|
1308
|
+
# * **ACTIVE:** The zonal shift has been started and is active.
|
1086
1309
|
#
|
1087
1310
|
# * **EXPIRED:** The zonal shift has expired (the expiry time was
|
1088
1311
|
# exceeded).
|
@@ -1090,20 +1313,22 @@ module Aws::ARCZonalShift
|
|
1090
1313
|
# * **CANCELED:** The zonal shift was canceled.
|
1091
1314
|
# @return [String]
|
1092
1315
|
#
|
1093
|
-
# @!attribute [rw]
|
1094
|
-
#
|
1316
|
+
# @!attribute [rw] comment
|
1317
|
+
# A comment that you enter about the zonal shift. Only the latest
|
1318
|
+
# comment is retained; no comment history is maintained. A new comment
|
1319
|
+
# overwrites any existing comment string.
|
1095
1320
|
# @return [String]
|
1096
1321
|
#
|
1097
1322
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ZonalShift AWS API Documentation
|
1098
1323
|
#
|
1099
1324
|
class ZonalShift < Struct.new(
|
1325
|
+
:zonal_shift_id,
|
1326
|
+
:resource_identifier,
|
1100
1327
|
:away_from,
|
1101
|
-
:comment,
|
1102
1328
|
:expiry_time,
|
1103
|
-
:resource_identifier,
|
1104
1329
|
:start_time,
|
1105
1330
|
:status,
|
1106
|
-
:
|
1331
|
+
:comment)
|
1107
1332
|
SENSITIVE = []
|
1108
1333
|
include Aws::Structure
|
1109
1334
|
end
|
@@ -1128,14 +1353,41 @@ module Aws::ARCZonalShift
|
|
1128
1353
|
# shifts > autoshifts > practice run zonal shifts.
|
1129
1354
|
#
|
1130
1355
|
# For more information, see [How zonal autoshift and practice runs
|
1131
|
-
# work][1] in the Amazon
|
1132
|
-
#
|
1356
|
+
# work][1] in the Amazon Application Recovery Controller Developer
|
1357
|
+
# Guide.
|
1133
1358
|
#
|
1134
1359
|
#
|
1135
1360
|
#
|
1136
1361
|
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html
|
1137
1362
|
# @return [String]
|
1138
1363
|
#
|
1364
|
+
# @!attribute [rw] zonal_shift_id
|
1365
|
+
# The identifier of a zonal shift.
|
1366
|
+
# @return [String]
|
1367
|
+
#
|
1368
|
+
# @!attribute [rw] resource_identifier
|
1369
|
+
# The identifier for the resource to include in a zonal shift. The
|
1370
|
+
# identifier is the Amazon Resource Name (ARN) for the resource.
|
1371
|
+
#
|
1372
|
+
# Amazon Application Recovery Controller currently supports enabling
|
1373
|
+
# the following resources for zonal shift and zonal autoshift:
|
1374
|
+
#
|
1375
|
+
# * [Amazon EC2 Auto Scaling groups][1]
|
1376
|
+
#
|
1377
|
+
# * [Amazon Elastic Kubernetes Service][2]
|
1378
|
+
#
|
1379
|
+
# * [Application Load Balancer][3]
|
1380
|
+
#
|
1381
|
+
# * [Network Load Balancer][4]
|
1382
|
+
#
|
1383
|
+
#
|
1384
|
+
#
|
1385
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html
|
1386
|
+
# [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html
|
1387
|
+
# [3]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html
|
1388
|
+
# [4]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html
|
1389
|
+
# @return [String]
|
1390
|
+
#
|
1139
1391
|
# @!attribute [rw] away_from
|
1140
1392
|
# The Availability Zone (for example, `use1-az1`) that traffic is
|
1141
1393
|
# moved away from for a resource when you start a zonal shift. Until
|
@@ -1144,12 +1396,6 @@ module Aws::ARCZonalShift
|
|
1144
1396
|
# Services Region.
|
1145
1397
|
# @return [String]
|
1146
1398
|
#
|
1147
|
-
# @!attribute [rw] comment
|
1148
|
-
# A comment that you enter for a customer-initiated zonal shift. Only
|
1149
|
-
# the latest comment is retained; no comment history is maintained.
|
1150
|
-
# That is, a new comment overwrites any existing comment string.
|
1151
|
-
# @return [String]
|
1152
|
-
#
|
1153
1399
|
# @!attribute [rw] expiry_time
|
1154
1400
|
# The expiry time (expiration time) for a customer-initiated zonal
|
1155
1401
|
# shift. A zonal shift is temporary and must be set to expire when you
|
@@ -1165,6 +1411,20 @@ module Aws::ARCZonalShift
|
|
1165
1411
|
# in.
|
1166
1412
|
# @return [Time]
|
1167
1413
|
#
|
1414
|
+
# @!attribute [rw] start_time
|
1415
|
+
# The time (UTC) when the zonal shift starts.
|
1416
|
+
# @return [Time]
|
1417
|
+
#
|
1418
|
+
# @!attribute [rw] comment
|
1419
|
+
# A comment that you enter for a customer-initiated zonal shift. Only
|
1420
|
+
# the latest comment is retained; no comment history is maintained.
|
1421
|
+
# That is, a new comment overwrites any existing comment string.
|
1422
|
+
# @return [String]
|
1423
|
+
#
|
1424
|
+
# @!attribute [rw] shift_type
|
1425
|
+
# Defines the zonal shift type.
|
1426
|
+
# @return [String]
|
1427
|
+
#
|
1168
1428
|
# @!attribute [rw] practice_run_outcome
|
1169
1429
|
# The outcome, or end state, returned for a practice run. The
|
1170
1430
|
# following values can be returned:
|
@@ -1186,56 +1446,39 @@ module Aws::ARCZonalShift
|
|
1186
1446
|
# practice run, and the practice run was not interrupted before it
|
1187
1447
|
# completed.
|
1188
1448
|
#
|
1449
|
+
# * **CAPACITY\_CHECK\_FAILED:** The check for balanced capacity
|
1450
|
+
# across Availability Zones for your load balancing and Auto Scaling
|
1451
|
+
# group resources failed.
|
1452
|
+
#
|
1189
1453
|
# For more information about practice run outcomes, see [
|
1190
1454
|
# Considerations when you configure zonal autoshift][1] in the Amazon
|
1191
|
-
#
|
1455
|
+
# Application Recovery Controller Developer Guide.
|
1192
1456
|
#
|
1193
1457
|
#
|
1194
1458
|
#
|
1195
1459
|
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.configure.html
|
1196
1460
|
# @return [String]
|
1197
1461
|
#
|
1198
|
-
# @!attribute [rw] resource_identifier
|
1199
|
-
# The identifier for the resource to include in a zonal shift. The
|
1200
|
-
# identifier is the Amazon Resource Name (ARN) for the resource.
|
1201
|
-
#
|
1202
|
-
# At this time, you can only start a zonal shift for Network Load
|
1203
|
-
# Balancers and Application Load Balancers with cross-zone load
|
1204
|
-
# balancing turned off.
|
1205
|
-
# @return [String]
|
1206
|
-
#
|
1207
|
-
# @!attribute [rw] shift_type
|
1208
|
-
# Defines the zonal shift type.
|
1209
|
-
# @return [String]
|
1210
|
-
#
|
1211
|
-
# @!attribute [rw] start_time
|
1212
|
-
# The time (UTC) when the zonal shift starts.
|
1213
|
-
# @return [Time]
|
1214
|
-
#
|
1215
|
-
# @!attribute [rw] zonal_shift_id
|
1216
|
-
# The identifier of a zonal shift.
|
1217
|
-
# @return [String]
|
1218
|
-
#
|
1219
1462
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ZonalShiftInResource AWS API Documentation
|
1220
1463
|
#
|
1221
1464
|
class ZonalShiftInResource < Struct.new(
|
1222
1465
|
:applied_status,
|
1466
|
+
:zonal_shift_id,
|
1467
|
+
:resource_identifier,
|
1223
1468
|
:away_from,
|
1224
|
-
:comment,
|
1225
1469
|
:expiry_time,
|
1226
|
-
:practice_run_outcome,
|
1227
|
-
:resource_identifier,
|
1228
|
-
:shift_type,
|
1229
1470
|
:start_time,
|
1230
|
-
:
|
1471
|
+
:comment,
|
1472
|
+
:shift_type,
|
1473
|
+
:practice_run_outcome)
|
1231
1474
|
SENSITIVE = []
|
1232
1475
|
include Aws::Structure
|
1233
1476
|
end
|
1234
1477
|
|
1235
|
-
# Lists information about zonal shifts in Amazon
|
1236
|
-
#
|
1237
|
-
#
|
1238
|
-
#
|
1478
|
+
# Lists information about zonal shifts in Amazon Application Recovery
|
1479
|
+
# Controller, including zonal shifts that you start yourself and zonal
|
1480
|
+
# shifts that ARC starts on your behalf for practice runs with zonal
|
1481
|
+
# autoshift.
|
1239
1482
|
#
|
1240
1483
|
# Zonal shifts are temporary, including customer-initiated zonal shifts
|
1241
1484
|
# and the zonal autoshift practice run zonal shifts that ARC starts
|
@@ -1243,6 +1486,33 @@ module Aws::ARCZonalShift
|
|
1243
1486
|
# active for up to three days (72 hours). A practice run zonal shift has
|
1244
1487
|
# a 30 minute duration.
|
1245
1488
|
#
|
1489
|
+
# @!attribute [rw] zonal_shift_id
|
1490
|
+
# The identifier of a zonal shift.
|
1491
|
+
# @return [String]
|
1492
|
+
#
|
1493
|
+
# @!attribute [rw] resource_identifier
|
1494
|
+
# The identifier for the resource to include in a zonal shift. The
|
1495
|
+
# identifier is the Amazon Resource Name (ARN) for the resource.
|
1496
|
+
#
|
1497
|
+
# Amazon Application Recovery Controller currently supports enabling
|
1498
|
+
# the following resources for zonal shift and zonal autoshift:
|
1499
|
+
#
|
1500
|
+
# * [Amazon EC2 Auto Scaling groups][1]
|
1501
|
+
#
|
1502
|
+
# * [Amazon Elastic Kubernetes Service][2]
|
1503
|
+
#
|
1504
|
+
# * [Application Load Balancers][3]
|
1505
|
+
#
|
1506
|
+
# * [Network Load Balancers][4]
|
1507
|
+
#
|
1508
|
+
#
|
1509
|
+
#
|
1510
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html
|
1511
|
+
# [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html
|
1512
|
+
# [3]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html
|
1513
|
+
# [4]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html
|
1514
|
+
# @return [String]
|
1515
|
+
#
|
1246
1516
|
# @!attribute [rw] away_from
|
1247
1517
|
# The Availability Zone (for example, `use1-az1`) that traffic is
|
1248
1518
|
# moved away from for a resource when you start a zonal shift. Until
|
@@ -1251,12 +1521,6 @@ module Aws::ARCZonalShift
|
|
1251
1521
|
# Services Region.
|
1252
1522
|
# @return [String]
|
1253
1523
|
#
|
1254
|
-
# @!attribute [rw] comment
|
1255
|
-
# A comment that you enter about the zonal shift. Only the latest
|
1256
|
-
# comment is retained; no comment history is maintained. That is, a
|
1257
|
-
# new comment overwrites any existing comment string.
|
1258
|
-
# @return [String]
|
1259
|
-
#
|
1260
1524
|
# @!attribute [rw] expiry_time
|
1261
1525
|
# The expiry time (expiration time) for a customer-initiated zonal
|
1262
1526
|
# shift. A zonal shift is temporary and must be set to expire when you
|
@@ -1272,6 +1536,33 @@ module Aws::ARCZonalShift
|
|
1272
1536
|
# in.
|
1273
1537
|
# @return [Time]
|
1274
1538
|
#
|
1539
|
+
# @!attribute [rw] start_time
|
1540
|
+
# The time (UTC) when the zonal shift starts.
|
1541
|
+
# @return [Time]
|
1542
|
+
#
|
1543
|
+
# @!attribute [rw] status
|
1544
|
+
# A status for a zonal shift.
|
1545
|
+
#
|
1546
|
+
# The `Status` for a zonal shift can have one of the following values:
|
1547
|
+
#
|
1548
|
+
# * **ACTIVE:** The zonal shift has been started and is active.
|
1549
|
+
#
|
1550
|
+
# * **EXPIRED:** The zonal shift has expired (the expiry time was
|
1551
|
+
# exceeded).
|
1552
|
+
#
|
1553
|
+
# * **CANCELED:** The zonal shift was canceled.
|
1554
|
+
# @return [String]
|
1555
|
+
#
|
1556
|
+
# @!attribute [rw] comment
|
1557
|
+
# A comment that you enter about the zonal shift. Only the latest
|
1558
|
+
# comment is retained; no comment history is maintained. That is, a
|
1559
|
+
# new comment overwrites any existing comment string.
|
1560
|
+
# @return [String]
|
1561
|
+
#
|
1562
|
+
# @!attribute [rw] shift_type
|
1563
|
+
# Defines the zonal shift type.
|
1564
|
+
# @return [String]
|
1565
|
+
#
|
1275
1566
|
# @!attribute [rw] practice_run_outcome
|
1276
1567
|
# The outcome, or end state, of a practice run. The following values
|
1277
1568
|
# can be returned:
|
@@ -1292,61 +1583,31 @@ module Aws::ARCZonalShift
|
|
1292
1583
|
# practice run, and the practice run was not interrupted before it
|
1293
1584
|
# completed.
|
1294
1585
|
#
|
1586
|
+
# * **CAPACITY\_CHECK\_FAILED:** The check for balanced capacity
|
1587
|
+
# across Availability Zones for your load balancing and Auto Scaling
|
1588
|
+
# group resources failed.
|
1589
|
+
#
|
1295
1590
|
# For more information about practice run outcomes, see [
|
1296
1591
|
# Considerations when you configure zonal autoshift][1] in the Amazon
|
1297
|
-
#
|
1592
|
+
# Application Recovery Controller Developer Guide.
|
1298
1593
|
#
|
1299
1594
|
#
|
1300
1595
|
#
|
1301
1596
|
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.configure.html
|
1302
1597
|
# @return [String]
|
1303
1598
|
#
|
1304
|
-
# @!attribute [rw] resource_identifier
|
1305
|
-
# The identifier for the resource to include in a zonal shift. The
|
1306
|
-
# identifier is the Amazon Resource Name (ARN) for the resource.
|
1307
|
-
#
|
1308
|
-
# At this time, you can only start a zonal shift for Network Load
|
1309
|
-
# Balancers and Application Load Balancers with cross-zone load
|
1310
|
-
# balancing turned off.
|
1311
|
-
# @return [String]
|
1312
|
-
#
|
1313
|
-
# @!attribute [rw] shift_type
|
1314
|
-
# Defines the zonal shift type.
|
1315
|
-
# @return [String]
|
1316
|
-
#
|
1317
|
-
# @!attribute [rw] start_time
|
1318
|
-
# The time (UTC) when the zonal shift starts.
|
1319
|
-
# @return [Time]
|
1320
|
-
#
|
1321
|
-
# @!attribute [rw] status
|
1322
|
-
# A status for a zonal shift.
|
1323
|
-
#
|
1324
|
-
# The `Status` for a zonal shift can have one of the following values:
|
1325
|
-
#
|
1326
|
-
# * **ACTIVE:** The zonal shift has been started and active.
|
1327
|
-
#
|
1328
|
-
# * **EXPIRED:** The zonal shift has expired (the expiry time was
|
1329
|
-
# exceeded).
|
1330
|
-
#
|
1331
|
-
# * **CANCELED:** The zonal shift was canceled.
|
1332
|
-
# @return [String]
|
1333
|
-
#
|
1334
|
-
# @!attribute [rw] zonal_shift_id
|
1335
|
-
# The identifier of a zonal shift.
|
1336
|
-
# @return [String]
|
1337
|
-
#
|
1338
1599
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ZonalShiftSummary AWS API Documentation
|
1339
1600
|
#
|
1340
1601
|
class ZonalShiftSummary < Struct.new(
|
1602
|
+
:zonal_shift_id,
|
1603
|
+
:resource_identifier,
|
1341
1604
|
:away_from,
|
1342
|
-
:comment,
|
1343
1605
|
:expiry_time,
|
1344
|
-
:practice_run_outcome,
|
1345
|
-
:resource_identifier,
|
1346
|
-
:shift_type,
|
1347
1606
|
:start_time,
|
1348
1607
|
:status,
|
1349
|
-
:
|
1608
|
+
:comment,
|
1609
|
+
:shift_type,
|
1610
|
+
:practice_run_outcome)
|
1350
1611
|
SENSITIVE = []
|
1351
1612
|
include Aws::Structure
|
1352
1613
|
end
|