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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c9cd36f48a1de32de00bdc151264f918c934f353aab359149d163adb9f69d36d
|
4
|
+
data.tar.gz: 1b6a955b6a32764849561d3e165a6151d95d87757ddcdb88a8cc1d4f46554359
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c9694f178e20e0dd279006d4f295fab8226922bf931c3c3baf6fecd769349f4a5ac8d923ba01f224bcb24850baee978eec133b9b08b3c57dff252d879aa1f36e
|
7
|
+
data.tar.gz: 02cf80294eb73695ea39ebf84f354fb76d619bba0e6e4cd9107b0ed69a079e840b4e1aab8233881de226ef9b65d3a0937e4e85840db45d2ec640962fa0b25431
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.11.0 (2023-11-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds a new capability, zonal autoshift. You can configure zonal autoshift so that AWS shifts traffic for a resource away from an Availability Zone, on your behalf, when AWS determines that there is an issue that could potentially affect customers in the Availability Zone.
|
8
|
+
|
4
9
|
1.10.0 (2023-11-28)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.11.0
|
@@ -389,8 +389,11 @@ module Aws::ARCZonalShift
|
|
389
389
|
# @!group API Operations
|
390
390
|
|
391
391
|
# Cancel a zonal shift in Amazon Route 53 Application Recovery
|
392
|
-
# Controller
|
393
|
-
#
|
392
|
+
# Controller. To cancel the zonal shift, specify the zonal shift ID.
|
393
|
+
#
|
394
|
+
# A zonal shift can be one that you've started for a resource in your
|
395
|
+
# Amazon Web Services account in an Amazon Web Services Region, or it
|
396
|
+
# can be a zonal shift started by a practice run with zonal autoshift.
|
394
397
|
#
|
395
398
|
# @option params [required, String] :zonal_shift_id
|
396
399
|
# The internally-generated identifier of a zonal shift.
|
@@ -430,28 +433,189 @@ module Aws::ARCZonalShift
|
|
430
433
|
req.send_request(options)
|
431
434
|
end
|
432
435
|
|
436
|
+
# A practice run configuration for zonal autoshift is required when you
|
437
|
+
# enable zonal autoshift. A practice run configuration includes
|
438
|
+
# specifications for blocked dates and blocked time windows, and for
|
439
|
+
# Amazon CloudWatch alarms that you create to use with practice runs.
|
440
|
+
# The alarms that you specify are an *outcome alarm*, to monitor
|
441
|
+
# application health during practice runs and, optionally, a *blocking
|
442
|
+
# alarm*, to block practice runs from starting.
|
443
|
+
#
|
444
|
+
# For more information, see [ Considerations when you configure zonal
|
445
|
+
# autoshift][1] in the Amazon Route 53 Application Recovery Controller
|
446
|
+
# Developer Guide.
|
447
|
+
#
|
448
|
+
#
|
449
|
+
#
|
450
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html
|
451
|
+
#
|
452
|
+
# @option params [Array<String>] :blocked_dates
|
453
|
+
# Optionally, you can block Route 53 ARC from starting practice runs for
|
454
|
+
# a resource on specific calendar dates.
|
455
|
+
#
|
456
|
+
# The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you
|
457
|
+
# specify dates, that dates and times for practice runs are in UTC.
|
458
|
+
# Separate multiple blocked dates with spaces.
|
459
|
+
#
|
460
|
+
# For example, if you have an application update scheduled to launch on
|
461
|
+
# May 1, 2024, and you don't want practice runs to shift traffic away
|
462
|
+
# at that time, you could set a blocked date for `2024-05-01`.
|
463
|
+
#
|
464
|
+
# @option params [Array<String>] :blocked_windows
|
465
|
+
# Optionally, you can block Route 53 ARC from starting practice runs for
|
466
|
+
# specific windows of days and times.
|
467
|
+
#
|
468
|
+
# The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind,
|
469
|
+
# when you specify dates, that dates and times for practice runs are in
|
470
|
+
# UTC. Also, be aware of potential time adjustments that might be
|
471
|
+
# required for daylight saving time differences. Separate multiple
|
472
|
+
# blocked windows with spaces.
|
473
|
+
#
|
474
|
+
# For example, say you run business report summaries three days a week.
|
475
|
+
# For this scenario, you might set the following recurring days and
|
476
|
+
# times as blocked windows, for example: `MON-20:30-21:30
|
477
|
+
# WED-20:30-21:30 FRI-20:30-21:30`.
|
478
|
+
#
|
479
|
+
# @option params [Array<Types::ControlCondition>] :blocking_alarms
|
480
|
+
# An Amazon CloudWatch alarm that you can specify for zonal autoshift
|
481
|
+
# practice runs. This alarm blocks Route 53 ARC from starting practice
|
482
|
+
# run zonal shifts, and ends a practice run that's in progress, when
|
483
|
+
# the alarm is in an `ALARM` state.
|
484
|
+
#
|
485
|
+
# @option params [required, Array<Types::ControlCondition>] :outcome_alarms
|
486
|
+
# The *outcome alarm* for practice runs is a required Amazon CloudWatch
|
487
|
+
# alarm that you specify that ends a practice run when the alarm is in
|
488
|
+
# an `ALARM` state.
|
489
|
+
#
|
490
|
+
# Configure the alarm to monitor the health of your application when
|
491
|
+
# traffic is shifted away from an Availability Zone during each weekly
|
492
|
+
# practice run. You should configure the alarm to go into an `ALARM`
|
493
|
+
# state if your application is impacted by the zonal shift, and you want
|
494
|
+
# to stop the zonal shift, to let traffic for the resource return to the
|
495
|
+
# Availability Zone.
|
496
|
+
#
|
497
|
+
# @option params [required, String] :resource_identifier
|
498
|
+
# The identifier of the resource to shift away traffic for when a
|
499
|
+
# practice run starts a zonal shift. The identifier is the Amazon
|
500
|
+
# Resource Name (ARN) for the resource.
|
501
|
+
#
|
502
|
+
# At this time, supported resources are Network Load Balancers and
|
503
|
+
# Application Load Balancers with cross-zone load balancing turned off.
|
504
|
+
#
|
505
|
+
# @return [Types::CreatePracticeRunConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
506
|
+
#
|
507
|
+
# * {Types::CreatePracticeRunConfigurationResponse#arn #arn} => String
|
508
|
+
# * {Types::CreatePracticeRunConfigurationResponse#name #name} => String
|
509
|
+
# * {Types::CreatePracticeRunConfigurationResponse#practice_run_configuration #practice_run_configuration} => Types::PracticeRunConfiguration
|
510
|
+
# * {Types::CreatePracticeRunConfigurationResponse#zonal_autoshift_status #zonal_autoshift_status} => String
|
511
|
+
#
|
512
|
+
# @example Request syntax with placeholder values
|
513
|
+
#
|
514
|
+
# resp = client.create_practice_run_configuration({
|
515
|
+
# blocked_dates: ["BlockedDate"],
|
516
|
+
# blocked_windows: ["BlockedWindow"],
|
517
|
+
# blocking_alarms: [
|
518
|
+
# {
|
519
|
+
# alarm_identifier: "ResourceArn", # required
|
520
|
+
# type: "CLOUDWATCH", # required, accepts CLOUDWATCH
|
521
|
+
# },
|
522
|
+
# ],
|
523
|
+
# outcome_alarms: [ # required
|
524
|
+
# {
|
525
|
+
# alarm_identifier: "ResourceArn", # required
|
526
|
+
# type: "CLOUDWATCH", # required, accepts CLOUDWATCH
|
527
|
+
# },
|
528
|
+
# ],
|
529
|
+
# resource_identifier: "ResourceIdentifier", # required
|
530
|
+
# })
|
531
|
+
#
|
532
|
+
# @example Response structure
|
533
|
+
#
|
534
|
+
# resp.arn #=> String
|
535
|
+
# resp.name #=> String
|
536
|
+
# resp.practice_run_configuration.blocked_dates #=> Array
|
537
|
+
# resp.practice_run_configuration.blocked_dates[0] #=> String
|
538
|
+
# resp.practice_run_configuration.blocked_windows #=> Array
|
539
|
+
# resp.practice_run_configuration.blocked_windows[0] #=> String
|
540
|
+
# resp.practice_run_configuration.blocking_alarms #=> Array
|
541
|
+
# resp.practice_run_configuration.blocking_alarms[0].alarm_identifier #=> String
|
542
|
+
# resp.practice_run_configuration.blocking_alarms[0].type #=> String, one of "CLOUDWATCH"
|
543
|
+
# resp.practice_run_configuration.outcome_alarms #=> Array
|
544
|
+
# resp.practice_run_configuration.outcome_alarms[0].alarm_identifier #=> String
|
545
|
+
# resp.practice_run_configuration.outcome_alarms[0].type #=> String, one of "CLOUDWATCH"
|
546
|
+
# resp.zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
|
547
|
+
#
|
548
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CreatePracticeRunConfiguration AWS API Documentation
|
549
|
+
#
|
550
|
+
# @overload create_practice_run_configuration(params = {})
|
551
|
+
# @param [Hash] params ({})
|
552
|
+
def create_practice_run_configuration(params = {}, options = {})
|
553
|
+
req = build_request(:create_practice_run_configuration, params)
|
554
|
+
req.send_request(options)
|
555
|
+
end
|
556
|
+
|
557
|
+
# Deletes the practice run configuration for a resource. Before you can
|
558
|
+
# delete a practice run configuration for a resource., you must disable
|
559
|
+
# zonal autoshift for the resource. Practice runs must be configured for
|
560
|
+
# zonal autoshift to be enabled.
|
561
|
+
#
|
562
|
+
# @option params [required, String] :resource_identifier
|
563
|
+
# The identifier for the resource that you want to delete the practice
|
564
|
+
# run configuration for. The identifier is the Amazon Resource Name
|
565
|
+
# (ARN) for the resource.
|
566
|
+
#
|
567
|
+
# @return [Types::DeletePracticeRunConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
568
|
+
#
|
569
|
+
# * {Types::DeletePracticeRunConfigurationResponse#arn #arn} => String
|
570
|
+
# * {Types::DeletePracticeRunConfigurationResponse#name #name} => String
|
571
|
+
# * {Types::DeletePracticeRunConfigurationResponse#zonal_autoshift_status #zonal_autoshift_status} => String
|
572
|
+
#
|
573
|
+
# @example Request syntax with placeholder values
|
574
|
+
#
|
575
|
+
# resp = client.delete_practice_run_configuration({
|
576
|
+
# resource_identifier: "ResourceIdentifier", # required
|
577
|
+
# })
|
578
|
+
#
|
579
|
+
# @example Response structure
|
580
|
+
#
|
581
|
+
# resp.arn #=> String
|
582
|
+
# resp.name #=> String
|
583
|
+
# resp.zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
|
584
|
+
#
|
585
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/DeletePracticeRunConfiguration AWS API Documentation
|
586
|
+
#
|
587
|
+
# @overload delete_practice_run_configuration(params = {})
|
588
|
+
# @param [Hash] params ({})
|
589
|
+
def delete_practice_run_configuration(params = {}, options = {})
|
590
|
+
req = build_request(:delete_practice_run_configuration, params)
|
591
|
+
req.send_request(options)
|
592
|
+
end
|
593
|
+
|
433
594
|
# Get information about a resource that's been registered for zonal
|
434
595
|
# shifts with Amazon Route 53 Application Recovery Controller in this
|
435
|
-
#
|
436
|
-
# resources in Route 53 ARC.
|
596
|
+
# Amazon Web Services Region. Resources that are registered for zonal
|
597
|
+
# shifts are managed resources in Route 53 ARC. You can start zonal
|
598
|
+
# shifts and configure zonal autoshift for managed resources.
|
437
599
|
#
|
438
|
-
# At this time, you can only start a zonal shift
|
439
|
-
# Balancers and Application Load Balancers
|
440
|
-
# balancing turned off.
|
600
|
+
# At this time, you can only start a zonal shift or configure zonal
|
601
|
+
# autoshift for Network Load Balancers and Application Load Balancers
|
602
|
+
# with cross-zone load balancing turned off.
|
441
603
|
#
|
442
604
|
# @option params [required, String] :resource_identifier
|
443
|
-
# The identifier for the resource to
|
605
|
+
# The identifier for the resource to shift away traffic for. The
|
444
606
|
# identifier is the Amazon Resource Name (ARN) for the resource.
|
445
607
|
#
|
446
|
-
# At this time,
|
447
|
-
#
|
448
|
-
# balancing turned off.
|
608
|
+
# At this time, supported resources are Network Load Balancers and
|
609
|
+
# Application Load Balancers with cross-zone load balancing turned off.
|
449
610
|
#
|
450
611
|
# @return [Types::GetManagedResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
451
612
|
#
|
452
613
|
# * {Types::GetManagedResourceResponse#applied_weights #applied_weights} => Hash<String,Float>
|
453
614
|
# * {Types::GetManagedResourceResponse#arn #arn} => String
|
615
|
+
# * {Types::GetManagedResourceResponse#autoshifts #autoshifts} => Array<Types::AutoshiftInResource>
|
454
616
|
# * {Types::GetManagedResourceResponse#name #name} => String
|
617
|
+
# * {Types::GetManagedResourceResponse#practice_run_configuration #practice_run_configuration} => Types::PracticeRunConfiguration
|
618
|
+
# * {Types::GetManagedResourceResponse#zonal_autoshift_status #zonal_autoshift_status} => String
|
455
619
|
# * {Types::GetManagedResourceResponse#zonal_shifts #zonal_shifts} => Array<Types::ZonalShiftInResource>
|
456
620
|
#
|
457
621
|
# @example Request syntax with placeholder values
|
@@ -465,12 +629,28 @@ module Aws::ARCZonalShift
|
|
465
629
|
# resp.applied_weights #=> Hash
|
466
630
|
# resp.applied_weights["AvailabilityZone"] #=> Float
|
467
631
|
# resp.arn #=> String
|
632
|
+
# resp.autoshifts #=> Array
|
633
|
+
# resp.autoshifts[0].applied_status #=> String, one of "APPLIED", "NOT_APPLIED"
|
634
|
+
# resp.autoshifts[0].away_from #=> String
|
635
|
+
# resp.autoshifts[0].start_time #=> Time
|
468
636
|
# resp.name #=> String
|
637
|
+
# resp.practice_run_configuration.blocked_dates #=> Array
|
638
|
+
# resp.practice_run_configuration.blocked_dates[0] #=> String
|
639
|
+
# resp.practice_run_configuration.blocked_windows #=> Array
|
640
|
+
# resp.practice_run_configuration.blocked_windows[0] #=> String
|
641
|
+
# resp.practice_run_configuration.blocking_alarms #=> Array
|
642
|
+
# resp.practice_run_configuration.blocking_alarms[0].alarm_identifier #=> String
|
643
|
+
# resp.practice_run_configuration.blocking_alarms[0].type #=> String, one of "CLOUDWATCH"
|
644
|
+
# resp.practice_run_configuration.outcome_alarms #=> Array
|
645
|
+
# resp.practice_run_configuration.outcome_alarms[0].alarm_identifier #=> String
|
646
|
+
# resp.practice_run_configuration.outcome_alarms[0].type #=> String, one of "CLOUDWATCH"
|
647
|
+
# resp.zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
|
469
648
|
# resp.zonal_shifts #=> Array
|
470
649
|
# resp.zonal_shifts[0].applied_status #=> String, one of "APPLIED", "NOT_APPLIED"
|
471
650
|
# resp.zonal_shifts[0].away_from #=> String
|
472
651
|
# resp.zonal_shifts[0].comment #=> String
|
473
652
|
# resp.zonal_shifts[0].expiry_time #=> Time
|
653
|
+
# resp.zonal_shifts[0].practice_run_outcome #=> String, one of "FAILED", "INTERRUPTED", "PENDING", "SUCCEEDED"
|
474
654
|
# resp.zonal_shifts[0].resource_identifier #=> String
|
475
655
|
# resp.zonal_shifts[0].start_time #=> Time
|
476
656
|
# resp.zonal_shifts[0].zonal_shift_id #=> String
|
@@ -484,11 +664,60 @@ module Aws::ARCZonalShift
|
|
484
664
|
req.send_request(options)
|
485
665
|
end
|
486
666
|
|
487
|
-
#
|
488
|
-
#
|
489
|
-
#
|
490
|
-
#
|
491
|
-
#
|
667
|
+
# Returns the active autoshifts for a specified resource.
|
668
|
+
#
|
669
|
+
# @option params [Integer] :max_results
|
670
|
+
# The number of objects that you want to return with this call.
|
671
|
+
#
|
672
|
+
# @option params [String] :next_token
|
673
|
+
# Specifies that you want to receive the next page of results. Valid
|
674
|
+
# only if you received a `NextToken` response in the previous request.
|
675
|
+
# If you did, it indicates that more output is available. Set this
|
676
|
+
# parameter to the value provided by the previous call's `NextToken`
|
677
|
+
# response to request the next page of results.
|
678
|
+
#
|
679
|
+
# @option params [String] :status
|
680
|
+
# The status of the autoshift.
|
681
|
+
#
|
682
|
+
# @return [Types::ListAutoshiftsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
683
|
+
#
|
684
|
+
# * {Types::ListAutoshiftsResponse#items #items} => Array<Types::AutoshiftSummary>
|
685
|
+
# * {Types::ListAutoshiftsResponse#next_token #next_token} => String
|
686
|
+
#
|
687
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
688
|
+
#
|
689
|
+
# @example Request syntax with placeholder values
|
690
|
+
#
|
691
|
+
# resp = client.list_autoshifts({
|
692
|
+
# max_results: 1,
|
693
|
+
# next_token: "String",
|
694
|
+
# status: "ACTIVE", # accepts ACTIVE, COMPLETED
|
695
|
+
# })
|
696
|
+
#
|
697
|
+
# @example Response structure
|
698
|
+
#
|
699
|
+
# resp.items #=> Array
|
700
|
+
# resp.items[0].away_from #=> String
|
701
|
+
# resp.items[0].end_time #=> Time
|
702
|
+
# resp.items[0].start_time #=> Time
|
703
|
+
# resp.items[0].status #=> String, one of "ACTIVE", "COMPLETED"
|
704
|
+
# resp.next_token #=> String
|
705
|
+
#
|
706
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListAutoshifts AWS API Documentation
|
707
|
+
#
|
708
|
+
# @overload list_autoshifts(params = {})
|
709
|
+
# @param [Hash] params ({})
|
710
|
+
def list_autoshifts(params = {}, options = {})
|
711
|
+
req = build_request(:list_autoshifts, params)
|
712
|
+
req.send_request(options)
|
713
|
+
end
|
714
|
+
|
715
|
+
# Lists all the resources in your Amazon Web Services account in this
|
716
|
+
# Amazon Web Services Region that are managed for zonal shifts in Amazon
|
717
|
+
# Route 53 Application Recovery Controller, and information about them.
|
718
|
+
# The information includes the zonal autoshift status for the resource,
|
719
|
+
# as well as the Amazon Resource Name (ARN), the Availability Zones that
|
720
|
+
# each resource is deployed in, and the resource name.
|
492
721
|
#
|
493
722
|
# @option params [Integer] :max_results
|
494
723
|
# The number of objects that you want to return with this call.
|
@@ -517,10 +746,27 @@ module Aws::ARCZonalShift
|
|
517
746
|
# @example Response structure
|
518
747
|
#
|
519
748
|
# resp.items #=> Array
|
749
|
+
# resp.items[0].applied_weights #=> Hash
|
750
|
+
# resp.items[0].applied_weights["AvailabilityZone"] #=> Float
|
520
751
|
# resp.items[0].arn #=> String
|
752
|
+
# resp.items[0].autoshifts #=> Array
|
753
|
+
# resp.items[0].autoshifts[0].applied_status #=> String, one of "APPLIED", "NOT_APPLIED"
|
754
|
+
# resp.items[0].autoshifts[0].away_from #=> String
|
755
|
+
# resp.items[0].autoshifts[0].start_time #=> Time
|
521
756
|
# resp.items[0].availability_zones #=> Array
|
522
757
|
# resp.items[0].availability_zones[0] #=> String
|
523
758
|
# resp.items[0].name #=> String
|
759
|
+
# resp.items[0].practice_run_status #=> String, one of "ENABLED", "DISABLED"
|
760
|
+
# resp.items[0].zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
|
761
|
+
# resp.items[0].zonal_shifts #=> Array
|
762
|
+
# resp.items[0].zonal_shifts[0].applied_status #=> String, one of "APPLIED", "NOT_APPLIED"
|
763
|
+
# resp.items[0].zonal_shifts[0].away_from #=> String
|
764
|
+
# resp.items[0].zonal_shifts[0].comment #=> String
|
765
|
+
# resp.items[0].zonal_shifts[0].expiry_time #=> Time
|
766
|
+
# resp.items[0].zonal_shifts[0].practice_run_outcome #=> String, one of "FAILED", "INTERRUPTED", "PENDING", "SUCCEEDED"
|
767
|
+
# resp.items[0].zonal_shifts[0].resource_identifier #=> String
|
768
|
+
# resp.items[0].zonal_shifts[0].start_time #=> Time
|
769
|
+
# resp.items[0].zonal_shifts[0].zonal_shift_id #=> String
|
524
770
|
# resp.next_token #=> String
|
525
771
|
#
|
526
772
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListManagedResources AWS API Documentation
|
@@ -532,8 +778,18 @@ module Aws::ARCZonalShift
|
|
532
778
|
req.send_request(options)
|
533
779
|
end
|
534
780
|
|
535
|
-
# Lists all
|
536
|
-
# Recovery Controller in your
|
781
|
+
# Lists all active and completed zonal shifts in Amazon Route 53
|
782
|
+
# Application Recovery Controller in your Amazon Web Services account in
|
783
|
+
# this Amazon Web Services Region. `ListZonalShifts` returns
|
784
|
+
# customer-started zonal shifts, as well as practice run zonal shifts
|
785
|
+
# that Route 53 ARC started on your behalf for zonal autoshift.
|
786
|
+
#
|
787
|
+
# The `ListZonalShifts` operation does not list autoshifts. For more
|
788
|
+
# information about listing autoshifts, see [">ListAutoshifts][1].
|
789
|
+
#
|
790
|
+
#
|
791
|
+
#
|
792
|
+
# [1]: https://docs.aws.amazon.com/arc-zonal-shift/latest/api/API_ListAutoshifts.html
|
537
793
|
#
|
538
794
|
# @option params [Integer] :max_results
|
539
795
|
# The number of objects that you want to return with this call.
|
@@ -545,12 +801,17 @@ module Aws::ARCZonalShift
|
|
545
801
|
# parameter to the value provided by the previous call's `NextToken`
|
546
802
|
# response to request the next page of results.
|
547
803
|
#
|
804
|
+
# @option params [String] :resource_identifier
|
805
|
+
# The identifier for the resource that you want to list zonal shifts
|
806
|
+
# for. The identifier is the Amazon Resource Name (ARN) for the
|
807
|
+
# resource.
|
808
|
+
#
|
548
809
|
# @option params [String] :status
|
549
810
|
# A status for a zonal shift.
|
550
811
|
#
|
551
812
|
# The `Status` for a zonal shift can have one of the following values:
|
552
813
|
#
|
553
|
-
# * **ACTIVE**: The zonal shift
|
814
|
+
# * **ACTIVE**: The zonal shift has been started and active.
|
554
815
|
#
|
555
816
|
# * **EXPIRED**: The zonal shift has expired (the expiry time was
|
556
817
|
# exceeded).
|
@@ -569,6 +830,7 @@ module Aws::ARCZonalShift
|
|
569
830
|
# resp = client.list_zonal_shifts({
|
570
831
|
# max_results: 1,
|
571
832
|
# next_token: "String",
|
833
|
+
# resource_identifier: "ResourceIdentifier",
|
572
834
|
# status: "ACTIVE", # accepts ACTIVE, EXPIRED, CANCELED
|
573
835
|
# })
|
574
836
|
#
|
@@ -578,6 +840,7 @@ module Aws::ARCZonalShift
|
|
578
840
|
# resp.items[0].away_from #=> String
|
579
841
|
# resp.items[0].comment #=> String
|
580
842
|
# resp.items[0].expiry_time #=> Time
|
843
|
+
# resp.items[0].practice_run_outcome #=> String, one of "FAILED", "INTERRUPTED", "PENDING", "SUCCEEDED"
|
581
844
|
# resp.items[0].resource_identifier #=> String
|
582
845
|
# resp.items[0].start_time #=> Time
|
583
846
|
# resp.items[0].status #=> String, one of "ACTIVE", "EXPIRED", "CANCELED"
|
@@ -594,12 +857,13 @@ module Aws::ARCZonalShift
|
|
594
857
|
end
|
595
858
|
|
596
859
|
# You start a zonal shift to temporarily move load balancer traffic away
|
597
|
-
# from an Availability Zone in
|
598
|
-
# recover immediately, for example, from a developer's
|
599
|
-
# deployment or from an
|
600
|
-
# Availability Zone. You can start a zonal shift in
|
601
|
-
# for managed resources in your
|
602
|
-
#
|
860
|
+
# from an Availability Zone in an Amazon Web Services Region, to help
|
861
|
+
# your application recover immediately, for example, from a developer's
|
862
|
+
# bad code deployment or from an Amazon Web Services infrastructure
|
863
|
+
# failure in a single Availability Zone. You can start a zonal shift in
|
864
|
+
# Route 53 ARC only for managed resources in your Amazon Web Services
|
865
|
+
# account in an Amazon Web Services Region. Resources are automatically
|
866
|
+
# registered with Route 53 ARC by Amazon Web Services services.
|
603
867
|
#
|
604
868
|
# At this time, you can only start a zonal shift for Network Load
|
605
869
|
# Balancers and Application Load Balancers with cross-zone load
|
@@ -622,7 +886,7 @@ module Aws::ARCZonalShift
|
|
622
886
|
# The Availability Zone that traffic is moved away from for a resource
|
623
887
|
# when you start a zonal shift. Until the zonal shift expires or you
|
624
888
|
# cancel it, traffic for the resource is instead moved to other
|
625
|
-
# Availability Zones in the
|
889
|
+
# Availability Zones in the Amazon Web Services Region.
|
626
890
|
#
|
627
891
|
# @option params [required, String] :comment
|
628
892
|
# A comment that you enter about the zonal shift. Only the latest
|
@@ -643,15 +907,19 @@ module Aws::ARCZonalShift
|
|
643
907
|
# To set a length of time for a zonal shift to be active, specify a
|
644
908
|
# whole number, and then one of the following, with no space:
|
645
909
|
#
|
646
|
-
#
|
910
|
+
# * **A lowercase letter m:** To specify that the value is in minutes.
|
911
|
+
#
|
912
|
+
# * **A lowercase letter h:** To specify that the value is in hours.
|
913
|
+
#
|
914
|
+
# For example: `20h` means the zonal shift expires in 20 hours. `120m`
|
915
|
+
# means the zonal shift expires in 120 minutes (2 hours).
|
647
916
|
#
|
648
917
|
# @option params [required, String] :resource_identifier
|
649
|
-
# The identifier for the resource to
|
918
|
+
# The identifier for the resource to shift away traffic for. The
|
650
919
|
# identifier is the Amazon Resource Name (ARN) for the resource.
|
651
920
|
#
|
652
|
-
# At this time,
|
653
|
-
#
|
654
|
-
# balancing turned off.
|
921
|
+
# At this time, supported resources are Network Load Balancers and
|
922
|
+
# Application Load Balancers with cross-zone load balancing turned off.
|
655
923
|
#
|
656
924
|
# @return [Types::ZonalShift] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
657
925
|
#
|
@@ -691,9 +959,151 @@ module Aws::ARCZonalShift
|
|
691
959
|
req.send_request(options)
|
692
960
|
end
|
693
961
|
|
962
|
+
# Update a practice run configuration to change one or more of the
|
963
|
+
# following: add, change, or remove the blocking alarm; change the
|
964
|
+
# outcome alarm; or add, change, or remove blocking dates or time
|
965
|
+
# windows.
|
966
|
+
#
|
967
|
+
# @option params [Array<String>] :blocked_dates
|
968
|
+
# Add, change, or remove blocked dates for a practice run in zonal
|
969
|
+
# autoshift.
|
970
|
+
#
|
971
|
+
# Optionally, you can block practice runs for specific calendar dates.
|
972
|
+
# The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you
|
973
|
+
# specify dates, that dates and times for practice runs are in UTC.
|
974
|
+
# Separate multiple blocked dates with spaces.
|
975
|
+
#
|
976
|
+
# For example, if you have an application update scheduled to launch on
|
977
|
+
# May 1, 2024, and you don't want practice runs to shift traffic away
|
978
|
+
# at that time, you could set a blocked date for `2024-05-01`.
|
979
|
+
#
|
980
|
+
# @option params [Array<String>] :blocked_windows
|
981
|
+
# Add, change, or remove windows of days and times for when you can,
|
982
|
+
# optionally, block Route 53 ARC from starting a practice run for a
|
983
|
+
# resource.
|
984
|
+
#
|
985
|
+
# The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind,
|
986
|
+
# when you specify dates, that dates and times for practice runs are in
|
987
|
+
# UTC. Also, be aware of potential time adjustments that might be
|
988
|
+
# required for daylight saving time differences. Separate multiple
|
989
|
+
# blocked windows with spaces.
|
990
|
+
#
|
991
|
+
# For example, say you run business report summaries three days a week.
|
992
|
+
# For this scenario, you might set the following recurring days and
|
993
|
+
# times as blocked windows, for example: `MON-20:30-21:30
|
994
|
+
# WED-20:30-21:30 FRI-20:30-21:30`.
|
995
|
+
#
|
996
|
+
# @option params [Array<Types::ControlCondition>] :blocking_alarms
|
997
|
+
# Add, change, or remove the Amazon CloudWatch alarm that you optionally
|
998
|
+
# specify as the blocking alarm for practice runs.
|
999
|
+
#
|
1000
|
+
# @option params [Array<Types::ControlCondition>] :outcome_alarms
|
1001
|
+
# Specify a new the Amazon CloudWatch alarm as the outcome alarm for
|
1002
|
+
# practice runs.
|
1003
|
+
#
|
1004
|
+
# @option params [required, String] :resource_identifier
|
1005
|
+
# The identifier for the resource that you want to update the practice
|
1006
|
+
# run configuration for. The identifier is the Amazon Resource Name
|
1007
|
+
# (ARN) for the resource.
|
1008
|
+
#
|
1009
|
+
# @return [Types::UpdatePracticeRunConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1010
|
+
#
|
1011
|
+
# * {Types::UpdatePracticeRunConfigurationResponse#arn #arn} => String
|
1012
|
+
# * {Types::UpdatePracticeRunConfigurationResponse#name #name} => String
|
1013
|
+
# * {Types::UpdatePracticeRunConfigurationResponse#practice_run_configuration #practice_run_configuration} => Types::PracticeRunConfiguration
|
1014
|
+
# * {Types::UpdatePracticeRunConfigurationResponse#zonal_autoshift_status #zonal_autoshift_status} => String
|
1015
|
+
#
|
1016
|
+
# @example Request syntax with placeholder values
|
1017
|
+
#
|
1018
|
+
# resp = client.update_practice_run_configuration({
|
1019
|
+
# blocked_dates: ["BlockedDate"],
|
1020
|
+
# blocked_windows: ["BlockedWindow"],
|
1021
|
+
# blocking_alarms: [
|
1022
|
+
# {
|
1023
|
+
# alarm_identifier: "ResourceArn", # required
|
1024
|
+
# type: "CLOUDWATCH", # required, accepts CLOUDWATCH
|
1025
|
+
# },
|
1026
|
+
# ],
|
1027
|
+
# outcome_alarms: [
|
1028
|
+
# {
|
1029
|
+
# alarm_identifier: "ResourceArn", # required
|
1030
|
+
# type: "CLOUDWATCH", # required, accepts CLOUDWATCH
|
1031
|
+
# },
|
1032
|
+
# ],
|
1033
|
+
# resource_identifier: "ResourceIdentifier", # required
|
1034
|
+
# })
|
1035
|
+
#
|
1036
|
+
# @example Response structure
|
1037
|
+
#
|
1038
|
+
# resp.arn #=> String
|
1039
|
+
# resp.name #=> String
|
1040
|
+
# resp.practice_run_configuration.blocked_dates #=> Array
|
1041
|
+
# resp.practice_run_configuration.blocked_dates[0] #=> String
|
1042
|
+
# resp.practice_run_configuration.blocked_windows #=> Array
|
1043
|
+
# resp.practice_run_configuration.blocked_windows[0] #=> String
|
1044
|
+
# resp.practice_run_configuration.blocking_alarms #=> Array
|
1045
|
+
# resp.practice_run_configuration.blocking_alarms[0].alarm_identifier #=> String
|
1046
|
+
# resp.practice_run_configuration.blocking_alarms[0].type #=> String, one of "CLOUDWATCH"
|
1047
|
+
# resp.practice_run_configuration.outcome_alarms #=> Array
|
1048
|
+
# resp.practice_run_configuration.outcome_alarms[0].alarm_identifier #=> String
|
1049
|
+
# resp.practice_run_configuration.outcome_alarms[0].type #=> String, one of "CLOUDWATCH"
|
1050
|
+
# resp.zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
|
1051
|
+
#
|
1052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdatePracticeRunConfiguration AWS API Documentation
|
1053
|
+
#
|
1054
|
+
# @overload update_practice_run_configuration(params = {})
|
1055
|
+
# @param [Hash] params ({})
|
1056
|
+
def update_practice_run_configuration(params = {}, options = {})
|
1057
|
+
req = build_request(:update_practice_run_configuration, params)
|
1058
|
+
req.send_request(options)
|
1059
|
+
end
|
1060
|
+
|
1061
|
+
# You can update the zonal autoshift status for a resource, to enable or
|
1062
|
+
# disable zonal autoshift. When zonal autoshift is `ENABLED`, Amazon Web
|
1063
|
+
# Services shifts away resource traffic from an Availability Zone, on
|
1064
|
+
# your behalf, when Amazon Web Services determines that there's an
|
1065
|
+
# issue in the Availability Zone that could potentially affect
|
1066
|
+
# customers.
|
1067
|
+
#
|
1068
|
+
# @option params [required, String] :resource_identifier
|
1069
|
+
# The identifier for the resource that you want to update the zonal
|
1070
|
+
# autoshift configuration for. The identifier is the Amazon Resource
|
1071
|
+
# Name (ARN) for the resource.
|
1072
|
+
#
|
1073
|
+
# @option params [required, String] :zonal_autoshift_status
|
1074
|
+
# The zonal autoshift status for the resource that you want to update
|
1075
|
+
# the zonal autoshift configuration for.
|
1076
|
+
#
|
1077
|
+
# @return [Types::UpdateZonalAutoshiftConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1078
|
+
#
|
1079
|
+
# * {Types::UpdateZonalAutoshiftConfigurationResponse#resource_identifier #resource_identifier} => String
|
1080
|
+
# * {Types::UpdateZonalAutoshiftConfigurationResponse#zonal_autoshift_status #zonal_autoshift_status} => String
|
1081
|
+
#
|
1082
|
+
# @example Request syntax with placeholder values
|
1083
|
+
#
|
1084
|
+
# resp = client.update_zonal_autoshift_configuration({
|
1085
|
+
# resource_identifier: "ResourceIdentifier", # required
|
1086
|
+
# zonal_autoshift_status: "ENABLED", # required, accepts ENABLED, DISABLED
|
1087
|
+
# })
|
1088
|
+
#
|
1089
|
+
# @example Response structure
|
1090
|
+
#
|
1091
|
+
# resp.resource_identifier #=> String
|
1092
|
+
# resp.zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
|
1093
|
+
#
|
1094
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdateZonalAutoshiftConfiguration AWS API Documentation
|
1095
|
+
#
|
1096
|
+
# @overload update_zonal_autoshift_configuration(params = {})
|
1097
|
+
# @param [Hash] params ({})
|
1098
|
+
def update_zonal_autoshift_configuration(params = {}, options = {})
|
1099
|
+
req = build_request(:update_zonal_autoshift_configuration, params)
|
1100
|
+
req.send_request(options)
|
1101
|
+
end
|
1102
|
+
|
694
1103
|
# Update an active zonal shift in Amazon Route 53 Application Recovery
|
695
|
-
# Controller in your
|
696
|
-
# new expiration, or edit or replace the comment for the
|
1104
|
+
# Controller in your Amazon Web Services account. You can update a zonal
|
1105
|
+
# shift to set a new expiration, or edit or replace the comment for the
|
1106
|
+
# zonal shift.
|
697
1107
|
#
|
698
1108
|
# @option params [String] :comment
|
699
1109
|
# A comment that you enter about the zonal shift. Only the latest
|
@@ -774,7 +1184,7 @@ module Aws::ARCZonalShift
|
|
774
1184
|
params: params,
|
775
1185
|
config: config)
|
776
1186
|
context[:gem_name] = 'aws-sdk-arczonalshift'
|
777
|
-
context[:gem_version] = '1.
|
1187
|
+
context[:gem_version] = '1.11.0'
|
778
1188
|
Seahorse::Client::Request.new(handlers, context)
|
779
1189
|
end
|
780
1190
|
|