aws-sdk-arczonalshift 1.10.0 → 1.11.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 +444 -34
- data/lib/aws-sdk-arczonalshift/client_api.rb +193 -0
- data/lib/aws-sdk-arczonalshift/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-arczonalshift/endpoints.rb +70 -0
- data/lib/aws-sdk-arczonalshift/plugins/endpoints.rb +10 -0
- data/lib/aws-sdk-arczonalshift/types.rb +738 -77
- data/lib/aws-sdk-arczonalshift.rb +1 -1
- metadata +2 -2
@@ -23,6 +23,114 @@ module Aws::ARCZonalShift
|
|
23
23
|
include Aws::Structure
|
24
24
|
end
|
25
25
|
|
26
|
+
# A complex structure that lists an autoshift that is currently active
|
27
|
+
# for a managed resource and information about the autoshift.
|
28
|
+
#
|
29
|
+
# For more information, see [How zonal autoshift and practice runs
|
30
|
+
# work][1] in the Amazon Route 53 Application Recovery Controller
|
31
|
+
# Developer Guide.
|
32
|
+
#
|
33
|
+
#
|
34
|
+
#
|
35
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html
|
36
|
+
#
|
37
|
+
# @!attribute [rw] applied_status
|
38
|
+
# The `appliedStatus` field specifies which application traffic shift
|
39
|
+
# is in effect for a resource when there is more than one traffic
|
40
|
+
# shift active. There can be more than one application traffic shift
|
41
|
+
# in progress at the same time - that is, practice run zonal shifts,
|
42
|
+
# customer-started zonal shifts, or an autoshift. The `appliedStatus`
|
43
|
+
# field for an autoshift for a resource can have one of two values:
|
44
|
+
# `APPLIED` or `NOT_APPLIED`. The zonal shift or autoshift that is
|
45
|
+
# currently in effect for the resource has an applied status set to
|
46
|
+
# `APPLIED`.
|
47
|
+
#
|
48
|
+
# The overall principle for precedence is that zonal shifts that you
|
49
|
+
# start as a customer take precedence autoshifts, which take
|
50
|
+
# precedence over practice runs. That is, customer-started zonal
|
51
|
+
# shifts > autoshifts > practice run zonal shifts.
|
52
|
+
#
|
53
|
+
# For more information, see [How zonal autoshift and practice runs
|
54
|
+
# work][1] in the Amazon Route 53 Application Recovery Controller
|
55
|
+
# Developer Guide.
|
56
|
+
#
|
57
|
+
#
|
58
|
+
#
|
59
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html
|
60
|
+
# @return [String]
|
61
|
+
#
|
62
|
+
# @!attribute [rw] away_from
|
63
|
+
# The Availability Zone that traffic is shifted away from for a
|
64
|
+
# resource, when Amazon Web Services starts an autoshift. Until the
|
65
|
+
# autoshift ends, traffic for the resource is instead directed to
|
66
|
+
# other Availability Zones in the Amazon Web Services Region. An
|
67
|
+
# autoshift can end for a resource, for example, when Amazon Web
|
68
|
+
# Services ends the autoshift for the Availability Zone or when you
|
69
|
+
# disable zonal autoshift for the resource.
|
70
|
+
# @return [String]
|
71
|
+
#
|
72
|
+
# @!attribute [rw] start_time
|
73
|
+
# The time (UTC) when the autoshift started.
|
74
|
+
# @return [Time]
|
75
|
+
#
|
76
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/AutoshiftInResource AWS API Documentation
|
77
|
+
#
|
78
|
+
class AutoshiftInResource < Struct.new(
|
79
|
+
:applied_status,
|
80
|
+
:away_from,
|
81
|
+
:start_time)
|
82
|
+
SENSITIVE = []
|
83
|
+
include Aws::Structure
|
84
|
+
end
|
85
|
+
|
86
|
+
# Information about an autoshift. Amazon Web Services starts an
|
87
|
+
# autoshift to temporarily move traffic for a resource away from an
|
88
|
+
# Availability Zone in an Amazon Web Services Region when Amazon Web
|
89
|
+
# Services determines that there's an issue in the Availability Zone
|
90
|
+
# that could potentially affect customers. You can configure zonal
|
91
|
+
# autoshift in Route 53 ARC for managed resources in your Amazon Web
|
92
|
+
# Services account in a Region. Supported Amazon Web Services resources
|
93
|
+
# are automatically registered with Route 53 ARC.
|
94
|
+
#
|
95
|
+
# Autoshifts are temporary. When the Availability Zone recovers, Amazon
|
96
|
+
# Web Services ends the autoshift, and traffic for the resource is no
|
97
|
+
# longer directed to the other Availability Zones in the Region.
|
98
|
+
#
|
99
|
+
# You can stop an autoshift for a resource by disabling zonal autoshift.
|
100
|
+
#
|
101
|
+
# @!attribute [rw] away_from
|
102
|
+
# The Availability Zone that traffic is shifted away from for a
|
103
|
+
# resource when Amazon Web Services starts an autoshift. Until the
|
104
|
+
# autoshift ends, traffic for the resource is instead directed to
|
105
|
+
# other Availability Zones in the Amazon Web Services Region. An
|
106
|
+
# autoshift can end for a resource, for example, when Amazon Web
|
107
|
+
# Services ends the autoshift for the Availability Zone or when you
|
108
|
+
# disable zonal autoshift for the resource.
|
109
|
+
# @return [String]
|
110
|
+
#
|
111
|
+
# @!attribute [rw] end_time
|
112
|
+
# The time (in UTC) when the autoshift ended.
|
113
|
+
# @return [Time]
|
114
|
+
#
|
115
|
+
# @!attribute [rw] start_time
|
116
|
+
# The time (in UTC) when the autoshift started.
|
117
|
+
# @return [Time]
|
118
|
+
#
|
119
|
+
# @!attribute [rw] status
|
120
|
+
# The status for an autoshift.
|
121
|
+
# @return [String]
|
122
|
+
#
|
123
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/AutoshiftSummary AWS API Documentation
|
124
|
+
#
|
125
|
+
class AutoshiftSummary < Struct.new(
|
126
|
+
:away_from,
|
127
|
+
:end_time,
|
128
|
+
:start_time,
|
129
|
+
:status)
|
130
|
+
SENSITIVE = []
|
131
|
+
include Aws::Structure
|
132
|
+
end
|
133
|
+
|
26
134
|
# @!attribute [rw] zonal_shift_id
|
27
135
|
# The internally-generated identifier of a zonal shift.
|
28
136
|
# @return [String]
|
@@ -59,13 +167,196 @@ module Aws::ARCZonalShift
|
|
59
167
|
include Aws::Structure
|
60
168
|
end
|
61
169
|
|
170
|
+
# A control condition is an alarm that you specify for a practice run.
|
171
|
+
# When you configure practice runs with zonal autoshift for a resource,
|
172
|
+
# you specify Amazon CloudWatch alarms, which you create in CloudWatch
|
173
|
+
# to use with the practice run. The alarms that you specify are an
|
174
|
+
# *outcome alarm*, to monitor application health during practice runs
|
175
|
+
# and, optionally, a *blocking alarm*, to block practice runs from
|
176
|
+
# starting.
|
177
|
+
#
|
178
|
+
# Control condition alarms do not apply for autoshifts.
|
179
|
+
#
|
180
|
+
# For more information, see [ Considerations when you configure zonal
|
181
|
+
# autoshift][1] in the Amazon Route 53 Application Recovery Controller
|
182
|
+
# Developer Guide.
|
183
|
+
#
|
184
|
+
#
|
185
|
+
#
|
186
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html
|
187
|
+
#
|
188
|
+
# @!attribute [rw] alarm_identifier
|
189
|
+
# The Amazon Resource Name (ARN) for the Amazon CloudWatch alarm that
|
190
|
+
# you specify as a control condition for a practice run.
|
191
|
+
# @return [String]
|
192
|
+
#
|
193
|
+
# @!attribute [rw] type
|
194
|
+
# The type of alarm specified for a practice run. The only valid value
|
195
|
+
# is `CLOUDWATCH`.
|
196
|
+
# @return [String]
|
197
|
+
#
|
198
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ControlCondition AWS API Documentation
|
199
|
+
#
|
200
|
+
class ControlCondition < Struct.new(
|
201
|
+
:alarm_identifier,
|
202
|
+
:type)
|
203
|
+
SENSITIVE = []
|
204
|
+
include Aws::Structure
|
205
|
+
end
|
206
|
+
|
207
|
+
# @!attribute [rw] blocked_dates
|
208
|
+
# Optionally, you can block Route 53 ARC from starting practice runs
|
209
|
+
# for a resource on specific calendar dates.
|
210
|
+
#
|
211
|
+
# The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you
|
212
|
+
# specify dates, that dates and times for practice runs are in UTC.
|
213
|
+
# Separate multiple blocked dates with spaces.
|
214
|
+
#
|
215
|
+
# For example, if you have an application update scheduled to launch
|
216
|
+
# on May 1, 2024, and you don't want practice runs to shift traffic
|
217
|
+
# away at that time, you could set a blocked date for `2024-05-01`.
|
218
|
+
# @return [Array<String>]
|
219
|
+
#
|
220
|
+
# @!attribute [rw] blocked_windows
|
221
|
+
# Optionally, you can block Route 53 ARC from starting practice runs
|
222
|
+
# for specific windows of days and times.
|
223
|
+
#
|
224
|
+
# The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in
|
225
|
+
# mind, when you specify dates, that dates and times for practice runs
|
226
|
+
# are in UTC. Also, be aware of potential time adjustments that might
|
227
|
+
# be required for daylight saving time differences. Separate multiple
|
228
|
+
# blocked windows with spaces.
|
229
|
+
#
|
230
|
+
# For example, say you run business report summaries three days a
|
231
|
+
# week. For this scenario, you might set the following recurring days
|
232
|
+
# and times as blocked windows, for example: `MON-20:30-21:30
|
233
|
+
# WED-20:30-21:30 FRI-20:30-21:30`.
|
234
|
+
# @return [Array<String>]
|
235
|
+
#
|
236
|
+
# @!attribute [rw] blocking_alarms
|
237
|
+
# An Amazon CloudWatch alarm that you can specify for zonal autoshift
|
238
|
+
# practice runs. This alarm blocks Route 53 ARC from starting practice
|
239
|
+
# run zonal shifts, and ends a practice run that's in progress, when
|
240
|
+
# the alarm is in an `ALARM` state.
|
241
|
+
# @return [Array<Types::ControlCondition>]
|
242
|
+
#
|
243
|
+
# @!attribute [rw] outcome_alarms
|
244
|
+
# The *outcome alarm* for practice runs is a required Amazon
|
245
|
+
# CloudWatch alarm that you specify that ends a practice run when the
|
246
|
+
# alarm is in an `ALARM` state.
|
247
|
+
#
|
248
|
+
# Configure the alarm to monitor the health of your application when
|
249
|
+
# traffic is shifted away from an Availability Zone during each weekly
|
250
|
+
# practice run. You should configure the alarm to go into an `ALARM`
|
251
|
+
# state if your application is impacted by the zonal shift, and you
|
252
|
+
# want to stop the zonal shift, to let traffic for the resource return
|
253
|
+
# to the Availability Zone.
|
254
|
+
# @return [Array<Types::ControlCondition>]
|
255
|
+
#
|
62
256
|
# @!attribute [rw] resource_identifier
|
63
|
-
# The identifier
|
257
|
+
# The identifier of the resource to shift away traffic for when a
|
258
|
+
# practice run starts a zonal shift. The identifier is the Amazon
|
259
|
+
# Resource Name (ARN) for the resource.
|
260
|
+
#
|
261
|
+
# At this time, supported resources are Network Load Balancers and
|
262
|
+
# Application Load Balancers with cross-zone load balancing turned
|
263
|
+
# off.
|
264
|
+
# @return [String]
|
265
|
+
#
|
266
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CreatePracticeRunConfigurationRequest AWS API Documentation
|
267
|
+
#
|
268
|
+
class CreatePracticeRunConfigurationRequest < Struct.new(
|
269
|
+
:blocked_dates,
|
270
|
+
:blocked_windows,
|
271
|
+
:blocking_alarms,
|
272
|
+
:outcome_alarms,
|
273
|
+
:resource_identifier)
|
274
|
+
SENSITIVE = []
|
275
|
+
include Aws::Structure
|
276
|
+
end
|
277
|
+
|
278
|
+
# @!attribute [rw] arn
|
279
|
+
# The Amazon Resource Name (ARN) of the resource that you configured
|
280
|
+
# the practice run for.
|
281
|
+
# @return [String]
|
282
|
+
#
|
283
|
+
# @!attribute [rw] name
|
284
|
+
# The name of the resource that you configured the practice run for.
|
285
|
+
# @return [String]
|
286
|
+
#
|
287
|
+
# @!attribute [rw] practice_run_configuration
|
288
|
+
# A practice run configuration for a resource. Configurations include
|
289
|
+
# the outcome alarm that you specify for practice runs, and,
|
290
|
+
# optionally, a blocking alarm and blocking dates and windows.
|
291
|
+
# @return [Types::PracticeRunConfiguration]
|
292
|
+
#
|
293
|
+
# @!attribute [rw] zonal_autoshift_status
|
294
|
+
# The status for zonal autoshift for a resource. When you specify the
|
295
|
+
# autoshift status as `ENABLED`, Amazon Web Services shifts traffic
|
296
|
+
# away from shifts away application resource traffic from an
|
297
|
+
# Availability Zone, on your behalf, when Amazon Web Services
|
298
|
+
# determines that there's an issue in the Availability Zone that
|
299
|
+
# could potentially affect customers.
|
300
|
+
#
|
301
|
+
# When you enable zonal autoshift, you must also configure practice
|
302
|
+
# runs for the resource.
|
303
|
+
# @return [String]
|
304
|
+
#
|
305
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CreatePracticeRunConfigurationResponse AWS API Documentation
|
306
|
+
#
|
307
|
+
class CreatePracticeRunConfigurationResponse < Struct.new(
|
308
|
+
:arn,
|
309
|
+
:name,
|
310
|
+
:practice_run_configuration,
|
311
|
+
:zonal_autoshift_status)
|
312
|
+
SENSITIVE = []
|
313
|
+
include Aws::Structure
|
314
|
+
end
|
315
|
+
|
316
|
+
# @!attribute [rw] resource_identifier
|
317
|
+
# The identifier for the resource that you want to delete the practice
|
318
|
+
# run configuration for. The identifier is the Amazon Resource Name
|
319
|
+
# (ARN) for the resource.
|
320
|
+
# @return [String]
|
321
|
+
#
|
322
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/DeletePracticeRunConfigurationRequest AWS API Documentation
|
323
|
+
#
|
324
|
+
class DeletePracticeRunConfigurationRequest < Struct.new(
|
325
|
+
:resource_identifier)
|
326
|
+
SENSITIVE = []
|
327
|
+
include Aws::Structure
|
328
|
+
end
|
329
|
+
|
330
|
+
# @!attribute [rw] arn
|
331
|
+
# The Amazon Resource Name (ARN) of the resource that you deleted the
|
332
|
+
# practice run for.
|
333
|
+
# @return [String]
|
334
|
+
#
|
335
|
+
# @!attribute [rw] name
|
336
|
+
# The name of the resource that you deleted the practice run for.
|
337
|
+
# @return [String]
|
338
|
+
#
|
339
|
+
# @!attribute [rw] zonal_autoshift_status
|
340
|
+
# The status of zonal autoshift for the resource.
|
341
|
+
# @return [String]
|
342
|
+
#
|
343
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/DeletePracticeRunConfigurationResponse AWS API Documentation
|
344
|
+
#
|
345
|
+
class DeletePracticeRunConfigurationResponse < Struct.new(
|
346
|
+
:arn,
|
347
|
+
:name,
|
348
|
+
:zonal_autoshift_status)
|
349
|
+
SENSITIVE = []
|
350
|
+
include Aws::Structure
|
351
|
+
end
|
352
|
+
|
353
|
+
# @!attribute [rw] resource_identifier
|
354
|
+
# The identifier for the resource to shift away traffic for. The
|
64
355
|
# identifier is the Amazon Resource Name (ARN) for the resource.
|
65
356
|
#
|
66
|
-
# At this time,
|
67
|
-
#
|
68
|
-
#
|
357
|
+
# At this time, supported resources are Network Load Balancers and
|
358
|
+
# Application Load Balancers with cross-zone load balancing turned
|
359
|
+
# off.
|
69
360
|
# @return [String]
|
70
361
|
#
|
71
362
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/GetManagedResourceRequest AWS API Documentation
|
@@ -87,10 +378,27 @@ module Aws::ARCZonalShift
|
|
87
378
|
# The Amazon Resource Name (ARN) for the resource.
|
88
379
|
# @return [String]
|
89
380
|
#
|
381
|
+
# @!attribute [rw] autoshifts
|
382
|
+
# An array of the autoshifts that are active for the resource.
|
383
|
+
# @return [Array<Types::AutoshiftInResource>]
|
384
|
+
#
|
90
385
|
# @!attribute [rw] name
|
91
386
|
# The name of the resource.
|
92
387
|
# @return [String]
|
93
388
|
#
|
389
|
+
# @!attribute [rw] practice_run_configuration
|
390
|
+
# The practice run configuration for zonal autoshift that's
|
391
|
+
# associated with the resource.
|
392
|
+
# @return [Types::PracticeRunConfiguration]
|
393
|
+
#
|
394
|
+
# @!attribute [rw] zonal_autoshift_status
|
395
|
+
# The status for zonal autoshift for a resource. When the autoshift
|
396
|
+
# status is `ENABLED`, Amazon Web Services shifts traffic for a
|
397
|
+
# resource away from an Availability Zone, on your behalf, when Amazon
|
398
|
+
# Web Services determines that there's an issue in the Availability
|
399
|
+
# Zone that could potentially affect customers.
|
400
|
+
# @return [String]
|
401
|
+
#
|
94
402
|
# @!attribute [rw] zonal_shifts
|
95
403
|
# The zonal shifts that are currently active for a resource.
|
96
404
|
# @return [Array<Types::ZonalShiftInResource>]
|
@@ -100,7 +408,10 @@ module Aws::ARCZonalShift
|
|
100
408
|
class GetManagedResourceResponse < Struct.new(
|
101
409
|
:applied_weights,
|
102
410
|
:arn,
|
411
|
+
:autoshifts,
|
103
412
|
:name,
|
413
|
+
:practice_run_configuration,
|
414
|
+
:zonal_autoshift_status,
|
104
415
|
:zonal_shifts)
|
105
416
|
SENSITIVE = []
|
106
417
|
include Aws::Structure
|
@@ -119,6 +430,53 @@ module Aws::ARCZonalShift
|
|
119
430
|
include Aws::Structure
|
120
431
|
end
|
121
432
|
|
433
|
+
# @!attribute [rw] max_results
|
434
|
+
# The number of objects that you want to return with this call.
|
435
|
+
# @return [Integer]
|
436
|
+
#
|
437
|
+
# @!attribute [rw] next_token
|
438
|
+
# Specifies that you want to receive the next page of results. Valid
|
439
|
+
# only if you received a `NextToken` response in the previous request.
|
440
|
+
# If you did, it indicates that more output is available. Set this
|
441
|
+
# parameter to the value provided by the previous call's `NextToken`
|
442
|
+
# response to request the next page of results.
|
443
|
+
# @return [String]
|
444
|
+
#
|
445
|
+
# @!attribute [rw] status
|
446
|
+
# The status of the autoshift.
|
447
|
+
# @return [String]
|
448
|
+
#
|
449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListAutoshiftsRequest AWS API Documentation
|
450
|
+
#
|
451
|
+
class ListAutoshiftsRequest < Struct.new(
|
452
|
+
:max_results,
|
453
|
+
:next_token,
|
454
|
+
:status)
|
455
|
+
SENSITIVE = []
|
456
|
+
include Aws::Structure
|
457
|
+
end
|
458
|
+
|
459
|
+
# @!attribute [rw] items
|
460
|
+
# The items in the response list.
|
461
|
+
# @return [Array<Types::AutoshiftSummary>]
|
462
|
+
#
|
463
|
+
# @!attribute [rw] next_token
|
464
|
+
# Specifies that you want to receive the next page of results. Valid
|
465
|
+
# only if you received a `NextToken` response in the previous request.
|
466
|
+
# If you did, it indicates that more output is available. Set this
|
467
|
+
# parameter to the value provided by the previous call's `NextToken`
|
468
|
+
# response to request the next page of results.
|
469
|
+
# @return [String]
|
470
|
+
#
|
471
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListAutoshiftsResponse AWS API Documentation
|
472
|
+
#
|
473
|
+
class ListAutoshiftsResponse < Struct.new(
|
474
|
+
:items,
|
475
|
+
:next_token)
|
476
|
+
SENSITIVE = []
|
477
|
+
include Aws::Structure
|
478
|
+
end
|
479
|
+
|
122
480
|
# @!attribute [rw] max_results
|
123
481
|
# The number of objects that you want to return with this call.
|
124
482
|
# @return [Integer]
|
@@ -173,12 +531,18 @@ module Aws::ARCZonalShift
|
|
173
531
|
# response to request the next page of results.
|
174
532
|
# @return [String]
|
175
533
|
#
|
534
|
+
# @!attribute [rw] resource_identifier
|
535
|
+
# The identifier for the resource that you want to list zonal shifts
|
536
|
+
# for. The identifier is the Amazon Resource Name (ARN) for the
|
537
|
+
# resource.
|
538
|
+
# @return [String]
|
539
|
+
#
|
176
540
|
# @!attribute [rw] status
|
177
541
|
# A status for a zonal shift.
|
178
542
|
#
|
179
543
|
# The `Status` for a zonal shift can have one of the following values:
|
180
544
|
#
|
181
|
-
# * **ACTIVE**: The zonal shift
|
545
|
+
# * **ACTIVE**: The zonal shift has been started and active.
|
182
546
|
#
|
183
547
|
# * **EXPIRED**: The zonal shift has expired (the expiry time was
|
184
548
|
# exceeded).
|
@@ -191,6 +555,7 @@ module Aws::ARCZonalShift
|
|
191
555
|
class ListZonalShiftsRequest < Struct.new(
|
192
556
|
:max_results,
|
193
557
|
:next_token,
|
558
|
+
:resource_identifier,
|
194
559
|
:status)
|
195
560
|
SENSITIVE = []
|
196
561
|
include Aws::Structure
|
@@ -217,24 +582,35 @@ module Aws::ARCZonalShift
|
|
217
582
|
include Aws::Structure
|
218
583
|
end
|
219
584
|
|
220
|
-
# A complex structure for a managed resource in an
|
585
|
+
# A complex structure for a managed resource in an Amazon Web Services
|
586
|
+
# account with information about zonal shifts and autoshifts.
|
221
587
|
#
|
222
|
-
# A managed resource is a
|
223
|
-
#
|
224
|
-
#
|
225
|
-
# resource
|
226
|
-
#
|
588
|
+
# A managed resource is a load balancer that has been registered with
|
589
|
+
# Route 53 ARC by Elastic Load Balancing. You can start a zonal shift in
|
590
|
+
# Route 53 ARC for a managed resource to temporarily move traffic for
|
591
|
+
# the resource away from an Availability Zone in an Amazon Web Services
|
592
|
+
# Region. You can also configure zonal autoshift for a managed resource.
|
227
593
|
#
|
228
|
-
# <note markdown="1"> At this time,
|
229
|
-
#
|
230
|
-
# balancing turned off.
|
594
|
+
# <note markdown="1"> At this time, managed resources are Network Load Balancers and
|
595
|
+
# Application Load Balancers with cross-zone load balancing turned off.
|
231
596
|
#
|
232
597
|
# </note>
|
233
598
|
#
|
599
|
+
# @!attribute [rw] applied_weights
|
600
|
+
# A collection of key-value pairs that indicate whether resources are
|
601
|
+
# active in Availability Zones or not. The key name is the
|
602
|
+
# Availability Zone where the resource is deployed. The value is 1 or
|
603
|
+
# 0.
|
604
|
+
# @return [Hash<String,Float>]
|
605
|
+
#
|
234
606
|
# @!attribute [rw] arn
|
235
607
|
# The Amazon Resource Name (ARN) for the managed resource.
|
236
608
|
# @return [String]
|
237
609
|
#
|
610
|
+
# @!attribute [rw] autoshifts
|
611
|
+
# An array of the autoshifts that have been completed for a resource.
|
612
|
+
# @return [Array<Types::AutoshiftInResource>]
|
613
|
+
#
|
238
614
|
# @!attribute [rw] availability_zones
|
239
615
|
# The Availability Zones that a resource is deployed in.
|
240
616
|
# @return [Array<String>]
|
@@ -243,12 +619,87 @@ module Aws::ARCZonalShift
|
|
243
619
|
# The name of the managed resource.
|
244
620
|
# @return [String]
|
245
621
|
#
|
622
|
+
# @!attribute [rw] practice_run_status
|
623
|
+
# This status tracks whether a practice run configuration exists for a
|
624
|
+
# resource. When you configure a practice run for a resource so that a
|
625
|
+
# practice run configuration exists, Route 53 ARC sets this value to
|
626
|
+
# `ENABLED`. If a you have not configured a practice run for the
|
627
|
+
# resource, or delete a practice run configuration, Route 53 ARC sets
|
628
|
+
# the value to `DISABLED`.
|
629
|
+
#
|
630
|
+
# Route 53 ARC updates this status; you can't set a practice run
|
631
|
+
# status to `ENABLED` or `DISABLED`.
|
632
|
+
# @return [String]
|
633
|
+
#
|
634
|
+
# @!attribute [rw] zonal_autoshift_status
|
635
|
+
# The status of autoshift for a resource. When you configure zonal
|
636
|
+
# autoshift for a resource, you can set the value of the status to
|
637
|
+
# `ENABLED` or `DISABLED`.
|
638
|
+
# @return [String]
|
639
|
+
#
|
640
|
+
# @!attribute [rw] zonal_shifts
|
641
|
+
# An array of the zonal shifts for a resource.
|
642
|
+
# @return [Array<Types::ZonalShiftInResource>]
|
643
|
+
#
|
246
644
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ManagedResourceSummary AWS API Documentation
|
247
645
|
#
|
248
646
|
class ManagedResourceSummary < Struct.new(
|
647
|
+
:applied_weights,
|
249
648
|
:arn,
|
649
|
+
:autoshifts,
|
250
650
|
:availability_zones,
|
251
|
-
:name
|
651
|
+
:name,
|
652
|
+
:practice_run_status,
|
653
|
+
:zonal_autoshift_status,
|
654
|
+
:zonal_shifts)
|
655
|
+
SENSITIVE = []
|
656
|
+
include Aws::Structure
|
657
|
+
end
|
658
|
+
|
659
|
+
# A practice run configuration for a resource includes the Amazon
|
660
|
+
# CloudWatch alarms that you've specified for a practice run, as well
|
661
|
+
# as any blocked dates or blocked windows for the practice run.
|
662
|
+
#
|
663
|
+
# You can update or delete a practice run configuration. Before you
|
664
|
+
# delete a practice run configuration, you must disable zonal autoshift
|
665
|
+
# for the resource. A practice run configuration is required when zonal
|
666
|
+
# autoshift is enabled.
|
667
|
+
#
|
668
|
+
# @!attribute [rw] blocked_dates
|
669
|
+
# An array of one or more dates that you can specify when Amazon Web
|
670
|
+
# Services does not start practice runs for a resource.
|
671
|
+
#
|
672
|
+
# Specify blocked dates, in UTC, in the format `YYYY-MM-DD`, separated
|
673
|
+
# by spaces.
|
674
|
+
# @return [Array<String>]
|
675
|
+
#
|
676
|
+
# @!attribute [rw] blocked_windows
|
677
|
+
# An array of one or more windows of days and times that you can block
|
678
|
+
# Route 53 ARC from starting practice runs for a resource.
|
679
|
+
#
|
680
|
+
# Specify the blocked windows in UTC, using the format
|
681
|
+
# `DAY:HH:MM-DAY:HH:MM`, separated by spaces. For example,
|
682
|
+
# `MON:18:30-MON:19:30 TUE:18:30-TUE:19:30`.
|
683
|
+
# @return [Array<String>]
|
684
|
+
#
|
685
|
+
# @!attribute [rw] blocking_alarms
|
686
|
+
# The *blocking alarm* for practice runs is an optional alarm that you
|
687
|
+
# can specify that blocks practice runs when the alarm is in an
|
688
|
+
# `ALARM` state.
|
689
|
+
# @return [Array<Types::ControlCondition>]
|
690
|
+
#
|
691
|
+
# @!attribute [rw] outcome_alarms
|
692
|
+
# The *outcome alarm* for practice runs is an alarm that you specify
|
693
|
+
# that ends a practice run when the alarm is in an `ALARM` state.
|
694
|
+
# @return [Array<Types::ControlCondition>]
|
695
|
+
#
|
696
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/PracticeRunConfiguration AWS API Documentation
|
697
|
+
#
|
698
|
+
class PracticeRunConfiguration < Struct.new(
|
699
|
+
:blocked_dates,
|
700
|
+
:blocked_windows,
|
701
|
+
:blocking_alarms,
|
702
|
+
:outcome_alarms)
|
252
703
|
SENSITIVE = []
|
253
704
|
include Aws::Structure
|
254
705
|
end
|
@@ -270,7 +721,7 @@ module Aws::ARCZonalShift
|
|
270
721
|
# The Availability Zone that traffic is moved away from for a resource
|
271
722
|
# when you start a zonal shift. Until the zonal shift expires or you
|
272
723
|
# cancel it, traffic for the resource is instead moved to other
|
273
|
-
# Availability Zones in the
|
724
|
+
# Availability Zones in the Amazon Web Services Region.
|
274
725
|
# @return [String]
|
275
726
|
#
|
276
727
|
# @!attribute [rw] comment
|
@@ -293,16 +744,21 @@ module Aws::ARCZonalShift
|
|
293
744
|
# To set a length of time for a zonal shift to be active, specify a
|
294
745
|
# whole number, and then one of the following, with no space:
|
295
746
|
#
|
296
|
-
#
|
747
|
+
# * **A lowercase letter m:** To specify that the value is in minutes.
|
748
|
+
#
|
749
|
+
# * **A lowercase letter h:** To specify that the value is in hours.
|
750
|
+
#
|
751
|
+
# For example: `20h` means the zonal shift expires in 20 hours. `120m`
|
752
|
+
# means the zonal shift expires in 120 minutes (2 hours).
|
297
753
|
# @return [String]
|
298
754
|
#
|
299
755
|
# @!attribute [rw] resource_identifier
|
300
|
-
# The identifier for the resource to
|
756
|
+
# The identifier for the resource to shift away traffic for. The
|
301
757
|
# identifier is the Amazon Resource Name (ARN) for the resource.
|
302
758
|
#
|
303
|
-
# At this time,
|
304
|
-
#
|
305
|
-
#
|
759
|
+
# At this time, supported resources are Network Load Balancers and
|
760
|
+
# Application Load Balancers with cross-zone load balancing turned
|
761
|
+
# off.
|
306
762
|
# @return [String]
|
307
763
|
#
|
308
764
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/StartZonalShiftRequest AWS API Documentation
|
@@ -329,6 +785,134 @@ module Aws::ARCZonalShift
|
|
329
785
|
include Aws::Structure
|
330
786
|
end
|
331
787
|
|
788
|
+
# @!attribute [rw] blocked_dates
|
789
|
+
# Add, change, or remove blocked dates for a practice run in zonal
|
790
|
+
# autoshift.
|
791
|
+
#
|
792
|
+
# Optionally, you can block practice runs for specific calendar dates.
|
793
|
+
# The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you
|
794
|
+
# specify dates, that dates and times for practice runs are in UTC.
|
795
|
+
# Separate multiple blocked dates with spaces.
|
796
|
+
#
|
797
|
+
# For example, if you have an application update scheduled to launch
|
798
|
+
# on May 1, 2024, and you don't want practice runs to shift traffic
|
799
|
+
# away at that time, you could set a blocked date for `2024-05-01`.
|
800
|
+
# @return [Array<String>]
|
801
|
+
#
|
802
|
+
# @!attribute [rw] blocked_windows
|
803
|
+
# Add, change, or remove windows of days and times for when you can,
|
804
|
+
# optionally, block Route 53 ARC from starting a practice run for a
|
805
|
+
# resource.
|
806
|
+
#
|
807
|
+
# The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in
|
808
|
+
# mind, when you specify dates, that dates and times for practice runs
|
809
|
+
# are in UTC. Also, be aware of potential time adjustments that might
|
810
|
+
# be required for daylight saving time differences. Separate multiple
|
811
|
+
# blocked windows with spaces.
|
812
|
+
#
|
813
|
+
# For example, say you run business report summaries three days a
|
814
|
+
# week. For this scenario, you might set the following recurring days
|
815
|
+
# and times as blocked windows, for example: `MON-20:30-21:30
|
816
|
+
# WED-20:30-21:30 FRI-20:30-21:30`.
|
817
|
+
# @return [Array<String>]
|
818
|
+
#
|
819
|
+
# @!attribute [rw] blocking_alarms
|
820
|
+
# Add, change, or remove the Amazon CloudWatch alarm that you
|
821
|
+
# optionally specify as the blocking alarm for practice runs.
|
822
|
+
# @return [Array<Types::ControlCondition>]
|
823
|
+
#
|
824
|
+
# @!attribute [rw] outcome_alarms
|
825
|
+
# Specify a new the Amazon CloudWatch alarm as the outcome alarm for
|
826
|
+
# practice runs.
|
827
|
+
# @return [Array<Types::ControlCondition>]
|
828
|
+
#
|
829
|
+
# @!attribute [rw] resource_identifier
|
830
|
+
# The identifier for the resource that you want to update the practice
|
831
|
+
# run configuration for. The identifier is the Amazon Resource Name
|
832
|
+
# (ARN) for the resource.
|
833
|
+
# @return [String]
|
834
|
+
#
|
835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdatePracticeRunConfigurationRequest AWS API Documentation
|
836
|
+
#
|
837
|
+
class UpdatePracticeRunConfigurationRequest < Struct.new(
|
838
|
+
:blocked_dates,
|
839
|
+
:blocked_windows,
|
840
|
+
:blocking_alarms,
|
841
|
+
:outcome_alarms,
|
842
|
+
:resource_identifier)
|
843
|
+
SENSITIVE = []
|
844
|
+
include Aws::Structure
|
845
|
+
end
|
846
|
+
|
847
|
+
# @!attribute [rw] arn
|
848
|
+
# The Amazon Resource Name (ARN) of the resource that you updated the
|
849
|
+
# practice run for.
|
850
|
+
# @return [String]
|
851
|
+
#
|
852
|
+
# @!attribute [rw] name
|
853
|
+
# The name of the resource that you updated the practice run for.
|
854
|
+
# @return [String]
|
855
|
+
#
|
856
|
+
# @!attribute [rw] practice_run_configuration
|
857
|
+
# The practice run configuration that was updated.
|
858
|
+
# @return [Types::PracticeRunConfiguration]
|
859
|
+
#
|
860
|
+
# @!attribute [rw] zonal_autoshift_status
|
861
|
+
# The zonal autoshift status for the resource that you updated the
|
862
|
+
# practice run for.
|
863
|
+
# @return [String]
|
864
|
+
#
|
865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdatePracticeRunConfigurationResponse AWS API Documentation
|
866
|
+
#
|
867
|
+
class UpdatePracticeRunConfigurationResponse < Struct.new(
|
868
|
+
:arn,
|
869
|
+
:name,
|
870
|
+
:practice_run_configuration,
|
871
|
+
:zonal_autoshift_status)
|
872
|
+
SENSITIVE = []
|
873
|
+
include Aws::Structure
|
874
|
+
end
|
875
|
+
|
876
|
+
# @!attribute [rw] resource_identifier
|
877
|
+
# The identifier for the resource that you want to update the zonal
|
878
|
+
# autoshift configuration for. The identifier is the Amazon Resource
|
879
|
+
# Name (ARN) for the resource.
|
880
|
+
# @return [String]
|
881
|
+
#
|
882
|
+
# @!attribute [rw] zonal_autoshift_status
|
883
|
+
# The zonal autoshift status for the resource that you want to update
|
884
|
+
# the zonal autoshift configuration for.
|
885
|
+
# @return [String]
|
886
|
+
#
|
887
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdateZonalAutoshiftConfigurationRequest AWS API Documentation
|
888
|
+
#
|
889
|
+
class UpdateZonalAutoshiftConfigurationRequest < Struct.new(
|
890
|
+
:resource_identifier,
|
891
|
+
:zonal_autoshift_status)
|
892
|
+
SENSITIVE = []
|
893
|
+
include Aws::Structure
|
894
|
+
end
|
895
|
+
|
896
|
+
# @!attribute [rw] resource_identifier
|
897
|
+
# The identifier for the resource that you updated the zonal autoshift
|
898
|
+
# configuration for. The identifier is the Amazon Resource Name (ARN)
|
899
|
+
# for the resource.
|
900
|
+
# @return [String]
|
901
|
+
#
|
902
|
+
# @!attribute [rw] zonal_autoshift_status
|
903
|
+
# The zonal autoshift status for the resource that you updated the
|
904
|
+
# zonal autoshift configuration for.
|
905
|
+
# @return [String]
|
906
|
+
#
|
907
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdateZonalAutoshiftConfigurationResponse AWS API Documentation
|
908
|
+
#
|
909
|
+
class UpdateZonalAutoshiftConfigurationResponse < Struct.new(
|
910
|
+
:resource_identifier,
|
911
|
+
:zonal_autoshift_status)
|
912
|
+
SENSITIVE = []
|
913
|
+
include Aws::Structure
|
914
|
+
end
|
915
|
+
|
332
916
|
# @!attribute [rw] comment
|
333
917
|
# A comment that you enter about the zonal shift. Only the latest
|
334
918
|
# comment is retained; no comment history is maintained. A new comment
|
@@ -371,8 +955,8 @@ module Aws::ARCZonalShift
|
|
371
955
|
include Aws::Structure
|
372
956
|
end
|
373
957
|
|
374
|
-
# The input fails to satisfy the constraints specified by an
|
375
|
-
# service.
|
958
|
+
# The input fails to satisfy the constraints specified by an Amazon Web
|
959
|
+
# Services service.
|
376
960
|
#
|
377
961
|
# @!attribute [rw] message
|
378
962
|
# @return [String]
|
@@ -394,7 +978,7 @@ module Aws::ARCZonalShift
|
|
394
978
|
# The Availability Zone that traffic is moved away from for a resource
|
395
979
|
# when you start a zonal shift. Until the zonal shift expires or you
|
396
980
|
# cancel it, traffic for the resource is instead moved to other
|
397
|
-
# Availability Zones in the
|
981
|
+
# Availability Zones in the Amazon Web Services Region.
|
398
982
|
# @return [String]
|
399
983
|
#
|
400
984
|
# @!attribute [rw] comment
|
@@ -404,30 +988,31 @@ module Aws::ARCZonalShift
|
|
404
988
|
# @return [String]
|
405
989
|
#
|
406
990
|
# @!attribute [rw] expiry_time
|
407
|
-
# The expiry time (expiration time) for
|
408
|
-
# is temporary and must be set to expire when you
|
409
|
-
# shift. You can initially set a zonal shift to expire
|
410
|
-
# three days (72 hours). However, you can update a
|
411
|
-
# a new expiration at any time.
|
991
|
+
# The expiry time (expiration time) for a customer-started zonal
|
992
|
+
# shift. A zonal shift is temporary and must be set to expire when you
|
993
|
+
# start the zonal shift. You can initially set a zonal shift to expire
|
994
|
+
# in a maximum of three days (72 hours). However, you can update a
|
995
|
+
# zonal shift to set a new expiration at any time.
|
412
996
|
#
|
413
997
|
# When you start a zonal shift, you specify how long you want it to be
|
414
998
|
# active, which Route 53 ARC converts to an expiry time (expiration
|
415
|
-
# time). You can cancel a zonal shift
|
416
|
-
#
|
417
|
-
# zonal shift to specify another length of time to
|
999
|
+
# time). You can cancel a zonal shift when you're ready to restore
|
1000
|
+
# traffic to the Availability Zone, or just wait for it to expire. Or
|
1001
|
+
# you can update the zonal shift to specify another length of time to
|
1002
|
+
# expire in.
|
418
1003
|
# @return [Time]
|
419
1004
|
#
|
420
1005
|
# @!attribute [rw] resource_identifier
|
421
|
-
# The identifier for the resource to
|
1006
|
+
# The identifier for the resource to shift away traffic for. The
|
422
1007
|
# identifier is the Amazon Resource Name (ARN) for the resource.
|
423
1008
|
#
|
424
|
-
# At this time,
|
425
|
-
#
|
426
|
-
#
|
1009
|
+
# At this time, supported resources are Network Load Balancers and
|
1010
|
+
# Application Load Balancers with cross-zone load balancing turned
|
1011
|
+
# off.
|
427
1012
|
# @return [String]
|
428
1013
|
#
|
429
1014
|
# @!attribute [rw] start_time
|
430
|
-
# The time (UTC) when the zonal shift
|
1015
|
+
# The time (UTC) when the zonal shift starts.
|
431
1016
|
# @return [Time]
|
432
1017
|
#
|
433
1018
|
# @!attribute [rw] status
|
@@ -435,7 +1020,7 @@ module Aws::ARCZonalShift
|
|
435
1020
|
#
|
436
1021
|
# The `Status` for a zonal shift can have one of the following values:
|
437
1022
|
#
|
438
|
-
# * **ACTIVE:** The zonal shift
|
1023
|
+
# * **ACTIVE:** The zonal shift has been started and active.
|
439
1024
|
#
|
440
1025
|
# * **EXPIRED:** The zonal shift has expired (the expiry time was
|
441
1026
|
# exceeded).
|
@@ -465,15 +1050,35 @@ module Aws::ARCZonalShift
|
|
465
1050
|
# and their statuses for the resource.
|
466
1051
|
#
|
467
1052
|
# @!attribute [rw] applied_status
|
468
|
-
#
|
469
|
-
#
|
1053
|
+
# The `appliedStatus` field specifies which application traffic shift
|
1054
|
+
# is in effect for a resource when there is more than one traffic
|
1055
|
+
# shift active. There can be more than one application traffic shift
|
1056
|
+
# in progress at the same time - that is, practice run zonal shifts,
|
1057
|
+
# customer-started zonal shifts, or an autoshift. The `appliedStatus`
|
1058
|
+
# field for an autoshift for a resource can have one of two values:
|
1059
|
+
# `APPLIED` or `NOT_APPLIED`. The zonal shift or autoshift that is
|
1060
|
+
# currently in effect for the resource has an applied status set to
|
1061
|
+
# `APPLIED`.
|
1062
|
+
#
|
1063
|
+
# The overall principle for precedence is that zonal shifts that you
|
1064
|
+
# start as a customer take precedence autoshifts, which take
|
1065
|
+
# precedence over practice runs. That is, customer-started zonal
|
1066
|
+
# shifts > autoshifts > practice run zonal shifts.
|
1067
|
+
#
|
1068
|
+
# For more information, see [How zonal autoshift and practice runs
|
1069
|
+
# work][1] in the Amazon Route 53 Application Recovery Controller
|
1070
|
+
# Developer Guide.
|
1071
|
+
#
|
1072
|
+
#
|
1073
|
+
#
|
1074
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html
|
470
1075
|
# @return [String]
|
471
1076
|
#
|
472
1077
|
# @!attribute [rw] away_from
|
473
1078
|
# The Availability Zone that traffic is moved away from for a resource
|
474
1079
|
# when you start a zonal shift. Until the zonal shift expires or you
|
475
1080
|
# cancel it, traffic for the resource is instead moved to other
|
476
|
-
# Availability Zones in the
|
1081
|
+
# Availability Zones in the Amazon Web Services Region.
|
477
1082
|
# @return [String]
|
478
1083
|
#
|
479
1084
|
# @!attribute [rw] comment
|
@@ -483,19 +1088,50 @@ module Aws::ARCZonalShift
|
|
483
1088
|
# @return [String]
|
484
1089
|
#
|
485
1090
|
# @!attribute [rw] expiry_time
|
486
|
-
# The expiry time (expiration time) for
|
487
|
-
# is temporary and must be set to expire when you
|
488
|
-
# shift. You can initially set a zonal shift to expire
|
489
|
-
# three days (72 hours). However, you can update a
|
490
|
-
# a new expiration at any time.
|
1091
|
+
# The expiry time (expiration time) for a customer-started zonal
|
1092
|
+
# shift. A zonal shift is temporary and must be set to expire when you
|
1093
|
+
# start the zonal shift. You can initially set a zonal shift to expire
|
1094
|
+
# in a maximum of three days (72 hours). However, you can update a
|
1095
|
+
# zonal shift to set a new expiration at any time.
|
491
1096
|
#
|
492
1097
|
# When you start a zonal shift, you specify how long you want it to be
|
493
1098
|
# active, which Route 53 ARC converts to an expiry time (expiration
|
494
|
-
# time). You can cancel a zonal shift
|
495
|
-
#
|
496
|
-
# zonal shift to specify another length of time to
|
1099
|
+
# time). You can cancel a zonal shift when you're ready to restore
|
1100
|
+
# traffic to the Availability Zone, or just wait for it to expire. Or
|
1101
|
+
# you can update the zonal shift to specify another length of time to
|
1102
|
+
# expire in.
|
497
1103
|
# @return [Time]
|
498
1104
|
#
|
1105
|
+
# @!attribute [rw] practice_run_outcome
|
1106
|
+
# The outcome, or end state, returned for a practice run. The
|
1107
|
+
# following values can be returned:
|
1108
|
+
#
|
1109
|
+
# * **PENDING:** Outcome value when a practice run is in progress.
|
1110
|
+
#
|
1111
|
+
# * **SUCCEEDED:** Outcome value when the outcome alarm specified for
|
1112
|
+
# the practice run configuration does not go into an `ALARM` state
|
1113
|
+
# during the practice run, and the practice run was not interrupted
|
1114
|
+
# before it completed the expected 30 minute zonal shift.
|
1115
|
+
#
|
1116
|
+
# * **INTERRUPTED:** Outcome value when the practice run was stopped
|
1117
|
+
# before the expected 30 minute zonal shift duration, or there was
|
1118
|
+
# another problem with the practice run that created an inconclusive
|
1119
|
+
# outcome.
|
1120
|
+
#
|
1121
|
+
# * **FAILED:** Outcome value when the outcome alarm specified for the
|
1122
|
+
# practice run configuration goes into an `ALARM` state during the
|
1123
|
+
# practice run, and the practice run was not interrupted before it
|
1124
|
+
# completed.
|
1125
|
+
#
|
1126
|
+
# For more information about practice run outcomes, see [
|
1127
|
+
# Considerations when you configure zonal autoshift][1] in the Amazon
|
1128
|
+
# Route 53 Application Recovery Controller Developer Guide.
|
1129
|
+
#
|
1130
|
+
#
|
1131
|
+
#
|
1132
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.configure.html
|
1133
|
+
# @return [String]
|
1134
|
+
#
|
499
1135
|
# @!attribute [rw] resource_identifier
|
500
1136
|
# The identifier for the resource to include in a zonal shift. The
|
501
1137
|
# identifier is the Amazon Resource Name (ARN) for the resource.
|
@@ -506,7 +1142,7 @@ module Aws::ARCZonalShift
|
|
506
1142
|
# @return [String]
|
507
1143
|
#
|
508
1144
|
# @!attribute [rw] start_time
|
509
|
-
# The time (UTC) when the zonal shift
|
1145
|
+
# The time (UTC) when the zonal shift starts.
|
510
1146
|
# @return [Time]
|
511
1147
|
#
|
512
1148
|
# @!attribute [rw] zonal_shift_id
|
@@ -520,6 +1156,7 @@ module Aws::ARCZonalShift
|
|
520
1156
|
:away_from,
|
521
1157
|
:comment,
|
522
1158
|
:expiry_time,
|
1159
|
+
:practice_run_outcome,
|
523
1160
|
:resource_identifier,
|
524
1161
|
:start_time,
|
525
1162
|
:zonal_shift_id)
|
@@ -527,29 +1164,22 @@ module Aws::ARCZonalShift
|
|
527
1164
|
include Aws::Structure
|
528
1165
|
end
|
529
1166
|
|
530
|
-
#
|
531
|
-
#
|
532
|
-
#
|
533
|
-
#
|
534
|
-
# Availability Zone. You can start a zonal shift in Route 53 ARC only
|
535
|
-
# for managed resources in your account in an AWS Region. Supported AWS
|
536
|
-
# resources are automatically registered with Route 53 ARC.
|
1167
|
+
# Lists information about zonal shifts in Amazon Route 53 Application
|
1168
|
+
# Recovery Controller, including zonal shifts that you start yourself
|
1169
|
+
# and zonal shifts that Route 53 ARC starts on your behalf for practice
|
1170
|
+
# runs with zonal autoshift.
|
537
1171
|
#
|
538
|
-
# Zonal shifts are temporary
|
539
|
-
#
|
540
|
-
#
|
541
|
-
#
|
542
|
-
#
|
543
|
-
# to an expiry time (expiration time). You can cancel a zonal shift, for
|
544
|
-
# example, if you're ready to restore traffic to the Availability Zone.
|
545
|
-
# Or you can extend the zonal shift by updating the expiration so the
|
546
|
-
# zonal shift is active longer.
|
1172
|
+
# Zonal shifts are temporary, including customer-started zonal shifts
|
1173
|
+
# and the zonal autoshift practice run zonal shifts that Route 53 ARC
|
1174
|
+
# starts weekly, on your behalf. A zonal shift that a customer starts
|
1175
|
+
# can be active for up to three days (72 hours). A practice run zonal
|
1176
|
+
# shift has a 30 minute duration.
|
547
1177
|
#
|
548
1178
|
# @!attribute [rw] away_from
|
549
1179
|
# The Availability Zone that traffic is moved away from for a resource
|
550
1180
|
# when you start a zonal shift. Until the zonal shift expires or you
|
551
1181
|
# cancel it, traffic for the resource is instead moved to other
|
552
|
-
# Availability Zones in the
|
1182
|
+
# Availability Zones in the Amazon Web Services Region.
|
553
1183
|
# @return [String]
|
554
1184
|
#
|
555
1185
|
# @!attribute [rw] comment
|
@@ -559,19 +1189,49 @@ module Aws::ARCZonalShift
|
|
559
1189
|
# @return [String]
|
560
1190
|
#
|
561
1191
|
# @!attribute [rw] expiry_time
|
562
|
-
# The expiry time (expiration time) for
|
563
|
-
# is temporary and must be set to expire when you
|
564
|
-
# shift. You can initially set a zonal shift to expire
|
565
|
-
# three days (72 hours). However, you can update a
|
566
|
-
# a new expiration at any time.
|
1192
|
+
# The expiry time (expiration time) for a customer-started zonal
|
1193
|
+
# shift. A zonal shift is temporary and must be set to expire when you
|
1194
|
+
# start the zonal shift. You can initially set a zonal shift to expire
|
1195
|
+
# in a maximum of three days (72 hours). However, you can update a
|
1196
|
+
# zonal shift to set a new expiration at any time.
|
567
1197
|
#
|
568
1198
|
# When you start a zonal shift, you specify how long you want it to be
|
569
1199
|
# active, which Route 53 ARC converts to an expiry time (expiration
|
570
|
-
# time). You can cancel a zonal shift
|
571
|
-
#
|
572
|
-
# zonal shift to specify another length of time to
|
1200
|
+
# time). You can cancel a zonal shift when you're ready to restore
|
1201
|
+
# traffic to the Availability Zone, or just wait for it to expire. Or
|
1202
|
+
# you can update the zonal shift to specify another length of time to
|
1203
|
+
# expire in.
|
573
1204
|
# @return [Time]
|
574
1205
|
#
|
1206
|
+
# @!attribute [rw] practice_run_outcome
|
1207
|
+
# The outcome, or end state, of a practice run. The following values
|
1208
|
+
# can be returned:
|
1209
|
+
#
|
1210
|
+
# * **PENDING:** Outcome value when the practice run is in progress.
|
1211
|
+
#
|
1212
|
+
# * **SUCCEEDED:** Outcome value when the outcome alarm specified for
|
1213
|
+
# the practice run configuration does not go into an `ALARM` state
|
1214
|
+
# during the practice run, and the practice run was not interrupted
|
1215
|
+
# before it completed.
|
1216
|
+
#
|
1217
|
+
# * **INTERRUPTED:** Outcome value when the practice run did not run
|
1218
|
+
# for the expected 30 minutes or there was another problem with the
|
1219
|
+
# practice run that created an inconclusive outcome.
|
1220
|
+
#
|
1221
|
+
# * **FAILED:** Outcome value when the outcome alarm specified for the
|
1222
|
+
# practice run configuration goes into an `ALARM` state during the
|
1223
|
+
# practice run, and the practice run was not interrupted before it
|
1224
|
+
# completed.
|
1225
|
+
#
|
1226
|
+
# For more information about practice run outcomes, see [
|
1227
|
+
# Considerations when you configure zonal autoshift][1] in the Amazon
|
1228
|
+
# Route 53 Application Recovery Controller Developer Guide.
|
1229
|
+
#
|
1230
|
+
#
|
1231
|
+
#
|
1232
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.configure.html
|
1233
|
+
# @return [String]
|
1234
|
+
#
|
575
1235
|
# @!attribute [rw] resource_identifier
|
576
1236
|
# The identifier for the resource to include in a zonal shift. The
|
577
1237
|
# identifier is the Amazon Resource Name (ARN) for the resource.
|
@@ -582,7 +1242,7 @@ module Aws::ARCZonalShift
|
|
582
1242
|
# @return [String]
|
583
1243
|
#
|
584
1244
|
# @!attribute [rw] start_time
|
585
|
-
# The time (UTC) when the zonal shift
|
1245
|
+
# The time (UTC) when the zonal shift starts.
|
586
1246
|
# @return [Time]
|
587
1247
|
#
|
588
1248
|
# @!attribute [rw] status
|
@@ -590,7 +1250,7 @@ module Aws::ARCZonalShift
|
|
590
1250
|
#
|
591
1251
|
# The `Status` for a zonal shift can have one of the following values:
|
592
1252
|
#
|
593
|
-
# * **ACTIVE:** The zonal shift
|
1253
|
+
# * **ACTIVE:** The zonal shift has been started and active.
|
594
1254
|
#
|
595
1255
|
# * **EXPIRED:** The zonal shift has expired (the expiry time was
|
596
1256
|
# exceeded).
|
@@ -608,6 +1268,7 @@ module Aws::ARCZonalShift
|
|
608
1268
|
:away_from,
|
609
1269
|
:comment,
|
610
1270
|
:expiry_time,
|
1271
|
+
:practice_run_outcome,
|
611
1272
|
:resource_identifier,
|
612
1273
|
:start_time,
|
613
1274
|
:status,
|