aws-sdk-arczonalshift 1.0.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.
@@ -0,0 +1,670 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::ARCZonalShift
11
+ module Types
12
+
13
+ # You do not have sufficient access to perform this action.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # @note When making an API call, you may pass CancelZonalShiftRequest
27
+ # data as a hash:
28
+ #
29
+ # {
30
+ # zonal_shift_id: "ZonalShiftId", # required
31
+ # }
32
+ #
33
+ # @!attribute [rw] zonal_shift_id
34
+ # The internally-generated identifier of a zonal shift.
35
+ # @return [String]
36
+ #
37
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CancelZonalShiftRequest AWS API Documentation
38
+ #
39
+ class CancelZonalShiftRequest < Struct.new(
40
+ :zonal_shift_id)
41
+ SENSITIVE = []
42
+ include Aws::Structure
43
+ end
44
+
45
+ # The request could not be processed because of conflict in the current
46
+ # state of the resource.
47
+ #
48
+ # @!attribute [rw] message
49
+ # @return [String]
50
+ #
51
+ # @!attribute [rw] reason
52
+ # The reason for the conflict exception.
53
+ # @return [String]
54
+ #
55
+ # @!attribute [rw] zonal_shift_id
56
+ # The zonal shift ID associated with the conflict exception.
57
+ # @return [String]
58
+ #
59
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ConflictException AWS API Documentation
60
+ #
61
+ class ConflictException < Struct.new(
62
+ :message,
63
+ :reason,
64
+ :zonal_shift_id)
65
+ SENSITIVE = []
66
+ include Aws::Structure
67
+ end
68
+
69
+ # @note When making an API call, you may pass GetManagedResourceRequest
70
+ # data as a hash:
71
+ #
72
+ # {
73
+ # resource_identifier: "ResourceIdentifier", # required
74
+ # }
75
+ #
76
+ # @!attribute [rw] resource_identifier
77
+ # The identifier for the resource to include in a zonal shift. The
78
+ # identifier is the Amazon Resource Name (ARN) for the resource.
79
+ #
80
+ # At this time, you can only start a zonal shift for Network Load
81
+ # Balancers and Application Load Balancers with cross-zone load
82
+ # balancing turned off.
83
+ # @return [String]
84
+ #
85
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/GetManagedResourceRequest AWS API Documentation
86
+ #
87
+ class GetManagedResourceRequest < Struct.new(
88
+ :resource_identifier)
89
+ SENSITIVE = []
90
+ include Aws::Structure
91
+ end
92
+
93
+ # @!attribute [rw] applied_weights
94
+ # A collection of key-value pairs that indicate whether resources are
95
+ # active in Availability Zones or not. The key name is the
96
+ # Availability Zone where the resource is deployed. The value is 1 or
97
+ # 0.
98
+ # @return [Hash<String,Float>]
99
+ #
100
+ # @!attribute [rw] arn
101
+ # The Amazon Resource Name (ARN) for the resource.
102
+ # @return [String]
103
+ #
104
+ # @!attribute [rw] name
105
+ # The name of the resource.
106
+ # @return [String]
107
+ #
108
+ # @!attribute [rw] zonal_shifts
109
+ # The zonal shifts that are currently active for a resource.
110
+ # @return [Array<Types::ZonalShiftInResource>]
111
+ #
112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/GetManagedResourceResponse AWS API Documentation
113
+ #
114
+ class GetManagedResourceResponse < Struct.new(
115
+ :applied_weights,
116
+ :arn,
117
+ :name,
118
+ :zonal_shifts)
119
+ SENSITIVE = []
120
+ include Aws::Structure
121
+ end
122
+
123
+ # There was an internal server error.
124
+ #
125
+ # @!attribute [rw] message
126
+ # @return [String]
127
+ #
128
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/InternalServerException AWS API Documentation
129
+ #
130
+ class InternalServerException < Struct.new(
131
+ :message)
132
+ SENSITIVE = []
133
+ include Aws::Structure
134
+ end
135
+
136
+ # @note When making an API call, you may pass ListManagedResourcesRequest
137
+ # data as a hash:
138
+ #
139
+ # {
140
+ # max_results: 1,
141
+ # next_token: "String",
142
+ # }
143
+ #
144
+ # @!attribute [rw] max_results
145
+ # The number of objects that you want to return with this call.
146
+ # @return [Integer]
147
+ #
148
+ # @!attribute [rw] next_token
149
+ # Specifies that you want to receive the next page of results. Valid
150
+ # only if you received a `NextToken` response in the previous request.
151
+ # If you did, it indicates that more output is available. Set this
152
+ # parameter to the value provided by the previous call's `NextToken`
153
+ # response to request the next page of results.
154
+ # @return [String]
155
+ #
156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListManagedResourcesRequest AWS API Documentation
157
+ #
158
+ class ListManagedResourcesRequest < Struct.new(
159
+ :max_results,
160
+ :next_token)
161
+ SENSITIVE = []
162
+ include Aws::Structure
163
+ end
164
+
165
+ # @!attribute [rw] items
166
+ # The items in the response list.
167
+ # @return [Array<Types::ManagedResourceSummary>]
168
+ #
169
+ # @!attribute [rw] next_token
170
+ # Specifies that you want to receive the next page of results. Valid
171
+ # only if you received a `NextToken` response in the previous request.
172
+ # If you did, it indicates that more output is available. Set this
173
+ # parameter to the value provided by the previous call's `NextToken`
174
+ # response to request the next page of results.
175
+ # @return [String]
176
+ #
177
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListManagedResourcesResponse AWS API Documentation
178
+ #
179
+ class ListManagedResourcesResponse < Struct.new(
180
+ :items,
181
+ :next_token)
182
+ SENSITIVE = []
183
+ include Aws::Structure
184
+ end
185
+
186
+ # @note When making an API call, you may pass ListZonalShiftsRequest
187
+ # data as a hash:
188
+ #
189
+ # {
190
+ # max_results: 1,
191
+ # next_token: "String",
192
+ # status: "ACTIVE", # accepts ACTIVE, EXPIRED, CANCELED
193
+ # }
194
+ #
195
+ # @!attribute [rw] max_results
196
+ # The number of objects that you want to return with this call.
197
+ # @return [Integer]
198
+ #
199
+ # @!attribute [rw] next_token
200
+ # Specifies that you want to receive the next page of results. Valid
201
+ # only if you received a `NextToken` response in the previous request.
202
+ # If you did, it indicates that more output is available. Set this
203
+ # parameter to the value provided by the previous call's `NextToken`
204
+ # response to request the next page of results.
205
+ # @return [String]
206
+ #
207
+ # @!attribute [rw] status
208
+ # A status for a zonal shift.
209
+ #
210
+ # The `Status` for a zonal shift can have one of the following values:
211
+ #
212
+ # * **ACTIVE**\: The zonal shift is started and active.
213
+ #
214
+ # * **EXPIRED**\: The zonal shift has expired (the expiry time was
215
+ # exceeded).
216
+ #
217
+ # * **CANCELED**\: The zonal shift was canceled.
218
+ # @return [String]
219
+ #
220
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListZonalShiftsRequest AWS API Documentation
221
+ #
222
+ class ListZonalShiftsRequest < Struct.new(
223
+ :max_results,
224
+ :next_token,
225
+ :status)
226
+ SENSITIVE = []
227
+ include Aws::Structure
228
+ end
229
+
230
+ # @!attribute [rw] items
231
+ # The items in the response list.
232
+ # @return [Array<Types::ZonalShiftSummary>]
233
+ #
234
+ # @!attribute [rw] next_token
235
+ # Specifies that you want to receive the next page of results. Valid
236
+ # only if you received a `NextToken` response in the previous request.
237
+ # If you did, it indicates that more output is available. Set this
238
+ # parameter to the value provided by the previous call's `NextToken`
239
+ # response to request the next page of results.
240
+ # @return [String]
241
+ #
242
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListZonalShiftsResponse AWS API Documentation
243
+ #
244
+ class ListZonalShiftsResponse < Struct.new(
245
+ :items,
246
+ :next_token)
247
+ SENSITIVE = []
248
+ include Aws::Structure
249
+ end
250
+
251
+ # A complex structure for a managed resource in an account.
252
+ #
253
+ # A managed resource is a Network Load Balancer or Application Load
254
+ # Balancer that has been registered with Route 53 ARC by Elastic Load
255
+ # Balancing. You can start a zonal shift in Route 53 ARC for a managed
256
+ # resource to temporarily move traffic for the resource away from an
257
+ # Availability Zone in an AWS Region.
258
+ #
259
+ # <note markdown="1"> At this time, you can only start a zonal shift for Network Load
260
+ # Balancers and Application Load Balancers with cross-zone load
261
+ # balancing turned off.
262
+ #
263
+ # </note>
264
+ #
265
+ # @!attribute [rw] arn
266
+ # The Amazon Resource Name (ARN) for the managed resource.
267
+ # @return [String]
268
+ #
269
+ # @!attribute [rw] availability_zones
270
+ # The Availability Zones that a resource is deployed in.
271
+ # @return [Array<String>]
272
+ #
273
+ # @!attribute [rw] name
274
+ # The name of the managed resource.
275
+ # @return [String]
276
+ #
277
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ManagedResourceSummary AWS API Documentation
278
+ #
279
+ class ManagedResourceSummary < Struct.new(
280
+ :arn,
281
+ :availability_zones,
282
+ :name)
283
+ SENSITIVE = []
284
+ include Aws::Structure
285
+ end
286
+
287
+ # The input requested a resource that was not found.
288
+ #
289
+ # @!attribute [rw] message
290
+ # @return [String]
291
+ #
292
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ResourceNotFoundException AWS API Documentation
293
+ #
294
+ class ResourceNotFoundException < Struct.new(
295
+ :message)
296
+ SENSITIVE = []
297
+ include Aws::Structure
298
+ end
299
+
300
+ # @note When making an API call, you may pass StartZonalShiftRequest
301
+ # data as a hash:
302
+ #
303
+ # {
304
+ # away_from: "AvailabilityZone", # required
305
+ # comment: "ZonalShiftComment", # required
306
+ # expires_in: "ExpiresIn", # required
307
+ # resource_identifier: "ResourceIdentifier", # required
308
+ # }
309
+ #
310
+ # @!attribute [rw] away_from
311
+ # The Availability Zone that traffic is moved away from for a resource
312
+ # when you start a zonal shift. Until the zonal shift expires or you
313
+ # cancel it, traffic for the resource is instead moved to other
314
+ # Availability Zones in the AWS Region.
315
+ # @return [String]
316
+ #
317
+ # @!attribute [rw] comment
318
+ # A comment that you enter about the zonal shift. Only the latest
319
+ # comment is retained; no comment history is maintained. A new comment
320
+ # overwrites any existing comment string.
321
+ # @return [String]
322
+ #
323
+ # @!attribute [rw] expires_in
324
+ # The length of time that you want a zonal shift to be active, which
325
+ # Route 53 ARC converts to an expiry time (expiration time). Zonal
326
+ # shifts are temporary. You can set a zonal shift to be active
327
+ # initially for up to three days (72 hours).
328
+ #
329
+ # If you want to still keep traffic away from an Availability Zone,
330
+ # you can update the zonal shift and set a new expiration. You can
331
+ # also cancel a zonal shift, before it expires, for example, if
332
+ # you're ready to restore traffic to the Availability Zone.
333
+ #
334
+ # To set a length of time for a zonal shift to be active, specify a
335
+ # whole number, and then one of the following, with no space:
336
+ #
337
+ # <ul> <li> <p> <b>A lowercase letter m:</b> To specify that the value is in minutes.</p> </li> <li> <p> <b>A lowercase letter h:</b> To specify that the value is in hours.</p> </li> </ul> <p>For example: <code>20h</code> means the zonal shift expires in 20 hours. <code>120m</code> means the zonal shift expires in 120 minutes (2 hours).</p>
338
+ # @return [String]
339
+ #
340
+ # @!attribute [rw] resource_identifier
341
+ # The identifier for the resource to include in a zonal shift. The
342
+ # identifier is the Amazon Resource Name (ARN) for the resource.
343
+ #
344
+ # At this time, you can only start a zonal shift for Network Load
345
+ # Balancers and Application Load Balancers with cross-zone load
346
+ # balancing turned off.
347
+ # @return [String]
348
+ #
349
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/StartZonalShiftRequest AWS API Documentation
350
+ #
351
+ class StartZonalShiftRequest < Struct.new(
352
+ :away_from,
353
+ :comment,
354
+ :expires_in,
355
+ :resource_identifier)
356
+ SENSITIVE = []
357
+ include Aws::Structure
358
+ end
359
+
360
+ # The request was denied due to request throttling.
361
+ #
362
+ # @!attribute [rw] message
363
+ # @return [String]
364
+ #
365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ThrottlingException AWS API Documentation
366
+ #
367
+ class ThrottlingException < Struct.new(
368
+ :message)
369
+ SENSITIVE = []
370
+ include Aws::Structure
371
+ end
372
+
373
+ # @note When making an API call, you may pass UpdateZonalShiftRequest
374
+ # data as a hash:
375
+ #
376
+ # {
377
+ # comment: "ZonalShiftComment",
378
+ # expires_in: "ExpiresIn",
379
+ # zonal_shift_id: "ZonalShiftId", # required
380
+ # }
381
+ #
382
+ # @!attribute [rw] comment
383
+ # A comment that you enter about the zonal shift. Only the latest
384
+ # comment is retained; no comment history is maintained. A new comment
385
+ # overwrites any existing comment string.
386
+ # @return [String]
387
+ #
388
+ # @!attribute [rw] expires_in
389
+ # The length of time that you want a zonal shift to be active, which
390
+ # Route 53 ARC converts to an expiry time (expiration time). Zonal
391
+ # shifts are temporary. You can set a zonal shift to be active
392
+ # initially for up to three days (72 hours).
393
+ #
394
+ # If you want to still keep traffic away from an Availability Zone,
395
+ # you can update the zonal shift and set a new expiration. You can
396
+ # also cancel a zonal shift, before it expires, for example, if
397
+ # you're ready to restore traffic to the Availability Zone.
398
+ #
399
+ # To set a length of time for a zonal shift to be active, specify a
400
+ # whole number, and then one of the following, with no space:
401
+ #
402
+ # * **A lowercase letter m:** To specify that the value is in minutes.
403
+ #
404
+ # * **A lowercase letter h:** To specify that the value is in hours.
405
+ #
406
+ # For example: `20h` means the zonal shift expires in 20 hours. `120m`
407
+ # means the zonal shift expires in 120 minutes (2 hours).
408
+ # @return [String]
409
+ #
410
+ # @!attribute [rw] zonal_shift_id
411
+ # The identifier of a zonal shift.
412
+ # @return [String]
413
+ #
414
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdateZonalShiftRequest AWS API Documentation
415
+ #
416
+ class UpdateZonalShiftRequest < Struct.new(
417
+ :comment,
418
+ :expires_in,
419
+ :zonal_shift_id)
420
+ SENSITIVE = []
421
+ include Aws::Structure
422
+ end
423
+
424
+ # The input fails to satisfy the constraints specified by an AWS
425
+ # service.
426
+ #
427
+ # @!attribute [rw] message
428
+ # @return [String]
429
+ #
430
+ # @!attribute [rw] reason
431
+ # The reason for the validation exception.
432
+ # @return [String]
433
+ #
434
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ValidationException AWS API Documentation
435
+ #
436
+ class ValidationException < Struct.new(
437
+ :message,
438
+ :reason)
439
+ SENSITIVE = []
440
+ include Aws::Structure
441
+ end
442
+
443
+ # @!attribute [rw] away_from
444
+ # The Availability Zone that traffic is moved away from for a resource
445
+ # when you start a zonal shift. Until the zonal shift expires or you
446
+ # cancel it, traffic for the resource is instead moved to other
447
+ # Availability Zones in the AWS Region.
448
+ # @return [String]
449
+ #
450
+ # @!attribute [rw] comment
451
+ # A comment that you enter about the zonal shift. Only the latest
452
+ # comment is retained; no comment history is maintained. A new comment
453
+ # overwrites any existing comment string.
454
+ # @return [String]
455
+ #
456
+ # @!attribute [rw] expiry_time
457
+ # The expiry time (expiration time) for the zonal shift. A zonal shift
458
+ # is temporary and must be set to expire when you start the zonal
459
+ # shift. You can initially set a zonal shift to expire in a maximum of
460
+ # three days (72 hours). However, you can update a zonal shift to set
461
+ # a new expiration at any time.
462
+ #
463
+ # When you start a zonal shift, you specify how long you want it to be
464
+ # active, which Route 53 ARC converts to an expiry time (expiration
465
+ # time). You can cancel a zonal shift, for example, if you're ready
466
+ # to restore traffic to the Availability Zone. Or you can update the
467
+ # zonal shift to specify another length of time to expire in.
468
+ # @return [Time]
469
+ #
470
+ # @!attribute [rw] resource_identifier
471
+ # The identifier for the resource to include in a zonal shift. The
472
+ # identifier is the Amazon Resource Name (ARN) for the resource.
473
+ #
474
+ # At this time, you can only start a zonal shift for Network Load
475
+ # Balancers and Application Load Balancers with cross-zone load
476
+ # balancing turned off.
477
+ # @return [String]
478
+ #
479
+ # @!attribute [rw] start_time
480
+ # The time (UTC) when the zonal shift is started.
481
+ # @return [Time]
482
+ #
483
+ # @!attribute [rw] status
484
+ # A status for a zonal shift.
485
+ #
486
+ # The `Status` for a zonal shift can have one of the following values:
487
+ #
488
+ # * **ACTIVE:** The zonal shift is started and active.
489
+ #
490
+ # * **EXPIRED:** The zonal shift has expired (the expiry time was
491
+ # exceeded).
492
+ #
493
+ # * **CANCELED:** The zonal shift was canceled.
494
+ # @return [String]
495
+ #
496
+ # @!attribute [rw] zonal_shift_id
497
+ # The identifier of a zonal shift.
498
+ # @return [String]
499
+ #
500
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ZonalShift AWS API Documentation
501
+ #
502
+ class ZonalShift < Struct.new(
503
+ :away_from,
504
+ :comment,
505
+ :expiry_time,
506
+ :resource_identifier,
507
+ :start_time,
508
+ :status,
509
+ :zonal_shift_id)
510
+ SENSITIVE = []
511
+ include Aws::Structure
512
+ end
513
+
514
+ # A complex structure that lists the zonal shifts for a managed resource
515
+ # and their statuses for the resource.
516
+ #
517
+ # @!attribute [rw] applied_status
518
+ # An `appliedStatus` for a zonal shift for a resource can have one of
519
+ # two values: `APPLIED` or `NOT_APPLIED`.
520
+ # @return [String]
521
+ #
522
+ # @!attribute [rw] away_from
523
+ # The Availability Zone that traffic is moved away from for a resource
524
+ # when you start a zonal shift. Until the zonal shift expires or you
525
+ # cancel it, traffic for the resource is instead moved to other
526
+ # Availability Zones in the AWS Region.
527
+ # @return [String]
528
+ #
529
+ # @!attribute [rw] comment
530
+ # A comment that you enter about the zonal shift. Only the latest
531
+ # comment is retained; no comment history is maintained. That is, a
532
+ # new comment overwrites any existing comment string.
533
+ # @return [String]
534
+ #
535
+ # @!attribute [rw] expiry_time
536
+ # The expiry time (expiration time) for the zonal shift. A zonal shift
537
+ # is temporary and must be set to expire when you start the zonal
538
+ # shift. You can initially set a zonal shift to expire in a maximum of
539
+ # three days (72 hours). However, you can update a zonal shift to set
540
+ # a new expiration at any time.
541
+ #
542
+ # When you start a zonal shift, you specify how long you want it to be
543
+ # active, which Route 53 ARC converts to an expiry time (expiration
544
+ # time). You can cancel a zonal shift, for example, if you're ready
545
+ # to restore traffic to the Availability Zone. Or you can update the
546
+ # zonal shift to specify another length of time to expire in.
547
+ # @return [Time]
548
+ #
549
+ # @!attribute [rw] resource_identifier
550
+ # The identifier for the resource to include in a zonal shift. The
551
+ # identifier is the Amazon Resource Name (ARN) for the resource.
552
+ #
553
+ # At this time, you can only start a zonal shift for Network Load
554
+ # Balancers and Application Load Balancers with cross-zone load
555
+ # balancing turned off.
556
+ # @return [String]
557
+ #
558
+ # @!attribute [rw] start_time
559
+ # The time (UTC) when the zonal shift is started.
560
+ # @return [Time]
561
+ #
562
+ # @!attribute [rw] zonal_shift_id
563
+ # The identifier of a zonal shift.
564
+ # @return [String]
565
+ #
566
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ZonalShiftInResource AWS API Documentation
567
+ #
568
+ class ZonalShiftInResource < Struct.new(
569
+ :applied_status,
570
+ :away_from,
571
+ :comment,
572
+ :expiry_time,
573
+ :resource_identifier,
574
+ :start_time,
575
+ :zonal_shift_id)
576
+ SENSITIVE = []
577
+ include Aws::Structure
578
+ end
579
+
580
+ # You start a zonal shift to temporarily move load balancer traffic away
581
+ # from an Availability Zone in a AWS Region. A zonal shift helps your
582
+ # application recover immediately, for example, from a developer's bad
583
+ # code deployment or from an AWS infrastructure failure in a single
584
+ # Availability Zone. You can start a zonal shift in Route 53 ARC only
585
+ # for managed resources in your account in an AWS Region. Supported AWS
586
+ # resources are automatically registered with Route 53 ARC.
587
+ #
588
+ # Zonal shifts are temporary. A zonal shift can be active for up to
589
+ # three days (72 hours).
590
+ #
591
+ # When you start a zonal shift, you specify how long you want it to be
592
+ # active, which Amazon Route 53 Application Recovery Controller converts
593
+ # to an expiry time (expiration time). You can cancel a zonal shift, for
594
+ # example, if you're ready to restore traffic to the Availability Zone.
595
+ # Or you can extend the zonal shift by updating the expiration so the
596
+ # zonal shift is active longer.
597
+ #
598
+ # @!attribute [rw] away_from
599
+ # The Availability Zone that traffic is moved away from for a resource
600
+ # when you start a zonal shift. Until the zonal shift expires or you
601
+ # cancel it, traffic for the resource is instead moved to other
602
+ # Availability Zones in the AWS Region.
603
+ # @return [String]
604
+ #
605
+ # @!attribute [rw] comment
606
+ # A comment that you enter about the zonal shift. Only the latest
607
+ # comment is retained; no comment history is maintained. That is, a
608
+ # new comment overwrites any existing comment string.
609
+ # @return [String]
610
+ #
611
+ # @!attribute [rw] expiry_time
612
+ # The expiry time (expiration time) for the zonal shift. A zonal shift
613
+ # is temporary and must be set to expire when you start the zonal
614
+ # shift. You can initially set a zonal shift to expire in a maximum of
615
+ # three days (72 hours). However, you can update a zonal shift to set
616
+ # a new expiration at any time.
617
+ #
618
+ # When you start a zonal shift, you specify how long you want it to be
619
+ # active, which Route 53 ARC converts to an expiry time (expiration
620
+ # time). You can cancel a zonal shift, for example, if you're ready
621
+ # to restore traffic to the Availability Zone. Or you can update the
622
+ # zonal shift to specify another length of time to expire in.
623
+ # @return [Time]
624
+ #
625
+ # @!attribute [rw] resource_identifier
626
+ # The identifier for the resource to include in a zonal shift. The
627
+ # identifier is the Amazon Resource Name (ARN) for the resource.
628
+ #
629
+ # At this time, you can only start a zonal shift for Network Load
630
+ # Balancers and Application Load Balancers with cross-zone load
631
+ # balancing turned off.
632
+ # @return [String]
633
+ #
634
+ # @!attribute [rw] start_time
635
+ # The time (UTC) when the zonal shift is started.
636
+ # @return [Time]
637
+ #
638
+ # @!attribute [rw] status
639
+ # A status for a zonal shift.
640
+ #
641
+ # The `Status` for a zonal shift can have one of the following values:
642
+ #
643
+ # * **ACTIVE:** The zonal shift is started and active.
644
+ #
645
+ # * **EXPIRED:** The zonal shift has expired (the expiry time was
646
+ # exceeded).
647
+ #
648
+ # * **CANCELED:** The zonal shift was canceled.
649
+ # @return [String]
650
+ #
651
+ # @!attribute [rw] zonal_shift_id
652
+ # The identifier of a zonal shift.
653
+ # @return [String]
654
+ #
655
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ZonalShiftSummary AWS API Documentation
656
+ #
657
+ class ZonalShiftSummary < Struct.new(
658
+ :away_from,
659
+ :comment,
660
+ :expiry_time,
661
+ :resource_identifier,
662
+ :start_time,
663
+ :status,
664
+ :zonal_shift_id)
665
+ SENSITIVE = []
666
+ include Aws::Structure
667
+ end
668
+
669
+ end
670
+ end