aws-sdk-arczonalshift 1.34.0 → 1.35.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-arczonalshift/client.rb +365 -186
- data/lib/aws-sdk-arczonalshift/client_api.rb +107 -50
- data/lib/aws-sdk-arczonalshift/types.rb +555 -294
- data/lib/aws-sdk-arczonalshift/waiters.rb +15 -0
- data/lib/aws-sdk-arczonalshift.rb +3 -2
- data/sig/client.rbs +73 -39
- data/sig/types.rbs +73 -39
- metadata +2 -1
@@ -469,8 +469,50 @@ module Aws::ARCZonalShift
|
|
469
469
|
|
470
470
|
# @!group API Operations
|
471
471
|
|
472
|
-
# Cancel
|
473
|
-
# Controller.
|
472
|
+
# Cancel an in-progress practice run zonal shift in Amazon Application
|
473
|
+
# Recovery Controller.
|
474
|
+
#
|
475
|
+
# @option params [required, String] :zonal_shift_id
|
476
|
+
# The identifier of a practice run zonal shift in Amazon Application
|
477
|
+
# Recovery Controller that you want to cancel.
|
478
|
+
#
|
479
|
+
# @return [Types::CancelPracticeRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
480
|
+
#
|
481
|
+
# * {Types::CancelPracticeRunResponse#zonal_shift_id #zonal_shift_id} => String
|
482
|
+
# * {Types::CancelPracticeRunResponse#resource_identifier #resource_identifier} => String
|
483
|
+
# * {Types::CancelPracticeRunResponse#away_from #away_from} => String
|
484
|
+
# * {Types::CancelPracticeRunResponse#expiry_time #expiry_time} => Time
|
485
|
+
# * {Types::CancelPracticeRunResponse#start_time #start_time} => Time
|
486
|
+
# * {Types::CancelPracticeRunResponse#status #status} => String
|
487
|
+
# * {Types::CancelPracticeRunResponse#comment #comment} => String
|
488
|
+
#
|
489
|
+
# @example Request syntax with placeholder values
|
490
|
+
#
|
491
|
+
# resp = client.cancel_practice_run({
|
492
|
+
# zonal_shift_id: "ZonalShiftId", # required
|
493
|
+
# })
|
494
|
+
#
|
495
|
+
# @example Response structure
|
496
|
+
#
|
497
|
+
# resp.zonal_shift_id #=> String
|
498
|
+
# resp.resource_identifier #=> String
|
499
|
+
# resp.away_from #=> String
|
500
|
+
# resp.expiry_time #=> Time
|
501
|
+
# resp.start_time #=> Time
|
502
|
+
# resp.status #=> String, one of "ACTIVE", "EXPIRED", "CANCELED"
|
503
|
+
# resp.comment #=> String
|
504
|
+
#
|
505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CancelPracticeRun AWS API Documentation
|
506
|
+
#
|
507
|
+
# @overload cancel_practice_run(params = {})
|
508
|
+
# @param [Hash] params ({})
|
509
|
+
def cancel_practice_run(params = {}, options = {})
|
510
|
+
req = build_request(:cancel_practice_run, params)
|
511
|
+
req.send_request(options)
|
512
|
+
end
|
513
|
+
|
514
|
+
# Cancel a zonal shift in Amazon Application Recovery Controller. To
|
515
|
+
# cancel the zonal shift, specify the zonal shift ID.
|
474
516
|
#
|
475
517
|
# A zonal shift can be one that you've started for a resource in your
|
476
518
|
# Amazon Web Services account in an Amazon Web Services Region, or it
|
@@ -481,13 +523,13 @@ module Aws::ARCZonalShift
|
|
481
523
|
#
|
482
524
|
# @return [Types::ZonalShift] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
483
525
|
#
|
526
|
+
# * {Types::ZonalShift#zonal_shift_id #zonal_shift_id} => String
|
527
|
+
# * {Types::ZonalShift#resource_identifier #resource_identifier} => String
|
484
528
|
# * {Types::ZonalShift#away_from #away_from} => String
|
485
|
-
# * {Types::ZonalShift#comment #comment} => String
|
486
529
|
# * {Types::ZonalShift#expiry_time #expiry_time} => Time
|
487
|
-
# * {Types::ZonalShift#resource_identifier #resource_identifier} => String
|
488
530
|
# * {Types::ZonalShift#start_time #start_time} => Time
|
489
531
|
# * {Types::ZonalShift#status #status} => String
|
490
|
-
# * {Types::ZonalShift#
|
532
|
+
# * {Types::ZonalShift#comment #comment} => String
|
491
533
|
#
|
492
534
|
# @example Request syntax with placeholder values
|
493
535
|
#
|
@@ -497,13 +539,13 @@ module Aws::ARCZonalShift
|
|
497
539
|
#
|
498
540
|
# @example Response structure
|
499
541
|
#
|
542
|
+
# resp.zonal_shift_id #=> String
|
543
|
+
# resp.resource_identifier #=> String
|
500
544
|
# resp.away_from #=> String
|
501
|
-
# resp.comment #=> String
|
502
545
|
# resp.expiry_time #=> Time
|
503
|
-
# resp.resource_identifier #=> String
|
504
546
|
# resp.start_time #=> Time
|
505
547
|
# resp.status #=> String, one of "ACTIVE", "EXPIRED", "CANCELED"
|
506
|
-
# resp.
|
548
|
+
# resp.comment #=> String
|
507
549
|
#
|
508
550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CancelZonalShift AWS API Documentation
|
509
551
|
#
|
@@ -528,24 +570,35 @@ module Aws::ARCZonalShift
|
|
528
570
|
# Availability Zone during an autoshift is safe for your application.
|
529
571
|
#
|
530
572
|
# For more information, see [ Considerations when you configure zonal
|
531
|
-
# autoshift][1] in the Amazon
|
532
|
-
#
|
573
|
+
# autoshift][1] in the Amazon Application Recovery Controller Developer
|
574
|
+
# Guide.
|
533
575
|
#
|
534
576
|
#
|
535
577
|
#
|
536
578
|
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html
|
537
579
|
#
|
538
|
-
# @option params [
|
539
|
-
#
|
540
|
-
#
|
580
|
+
# @option params [required, String] :resource_identifier
|
581
|
+
# The identifier of the resource that Amazon Web Services shifts traffic
|
582
|
+
# for with a practice run zonal shift. The identifier is the Amazon
|
583
|
+
# Resource Name (ARN) for the resource.
|
541
584
|
#
|
542
|
-
#
|
543
|
-
#
|
544
|
-
#
|
585
|
+
# Amazon Application Recovery Controller currently supports enabling the
|
586
|
+
# following resources for zonal shift and zonal autoshift:
|
587
|
+
#
|
588
|
+
# * [Amazon EC2 Auto Scaling groups][1]
|
589
|
+
#
|
590
|
+
# * [Amazon Elastic Kubernetes Service][2]
|
591
|
+
#
|
592
|
+
# * [Application Load Balancer][3]
|
593
|
+
#
|
594
|
+
# * [Network Load Balancer][4]
|
545
595
|
#
|
546
|
-
#
|
547
|
-
#
|
548
|
-
#
|
596
|
+
#
|
597
|
+
#
|
598
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html
|
599
|
+
# [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html
|
600
|
+
# [3]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html
|
601
|
+
# [4]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html
|
549
602
|
#
|
550
603
|
# @option params [Array<String>] :blocked_windows
|
551
604
|
# Optionally, you can block ARC from starting practice runs for specific
|
@@ -562,6 +615,18 @@ module Aws::ARCZonalShift
|
|
562
615
|
# times as blocked windows, for example: `MON-20:30-21:30
|
563
616
|
# WED-20:30-21:30 FRI-20:30-21:30`.
|
564
617
|
#
|
618
|
+
# @option params [Array<String>] :blocked_dates
|
619
|
+
# Optionally, you can block ARC from starting practice runs for a
|
620
|
+
# resource on specific calendar dates.
|
621
|
+
#
|
622
|
+
# The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you
|
623
|
+
# specify dates, that dates and times for practice runs are in UTC.
|
624
|
+
# Separate multiple blocked dates with spaces.
|
625
|
+
#
|
626
|
+
# For example, if you have an application update scheduled to launch on
|
627
|
+
# May 1, 2024, and you don't want practice runs to shift traffic away
|
628
|
+
# at that time, you could set a blocked date for `2024-05-01`.
|
629
|
+
#
|
565
630
|
# @option params [Array<Types::ControlCondition>] :blocking_alarms
|
566
631
|
# An Amazon CloudWatch alarm that you can specify for zonal autoshift
|
567
632
|
# practice runs. This alarm blocks ARC from starting practice run zonal
|
@@ -580,56 +645,48 @@ module Aws::ARCZonalShift
|
|
580
645
|
# the zonal shift, to let traffic for the resource return to the
|
581
646
|
# Availability Zone.
|
582
647
|
#
|
583
|
-
# @option params [required, String] :resource_identifier
|
584
|
-
# The identifier of the resource that Amazon Web Services shifts traffic
|
585
|
-
# for with a practice run zonal shift. The identifier is the Amazon
|
586
|
-
# Resource Name (ARN) for the resource.
|
587
|
-
#
|
588
|
-
# At this time, supported resources are Network Load Balancers and
|
589
|
-
# Application Load Balancers with cross-zone load balancing turned off.
|
590
|
-
#
|
591
648
|
# @return [Types::CreatePracticeRunConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
592
649
|
#
|
593
650
|
# * {Types::CreatePracticeRunConfigurationResponse#arn #arn} => String
|
594
651
|
# * {Types::CreatePracticeRunConfigurationResponse#name #name} => String
|
595
|
-
# * {Types::CreatePracticeRunConfigurationResponse#practice_run_configuration #practice_run_configuration} => Types::PracticeRunConfiguration
|
596
652
|
# * {Types::CreatePracticeRunConfigurationResponse#zonal_autoshift_status #zonal_autoshift_status} => String
|
653
|
+
# * {Types::CreatePracticeRunConfigurationResponse#practice_run_configuration #practice_run_configuration} => Types::PracticeRunConfiguration
|
597
654
|
#
|
598
655
|
# @example Request syntax with placeholder values
|
599
656
|
#
|
600
657
|
# resp = client.create_practice_run_configuration({
|
601
|
-
#
|
658
|
+
# resource_identifier: "ResourceIdentifier", # required
|
602
659
|
# blocked_windows: ["BlockedWindow"],
|
660
|
+
# blocked_dates: ["BlockedDate"],
|
603
661
|
# blocking_alarms: [
|
604
662
|
# {
|
605
|
-
# alarm_identifier: "MetricIdentifier", # required
|
606
663
|
# type: "CLOUDWATCH", # required, accepts CLOUDWATCH
|
664
|
+
# alarm_identifier: "MetricIdentifier", # required
|
607
665
|
# },
|
608
666
|
# ],
|
609
667
|
# outcome_alarms: [ # required
|
610
668
|
# {
|
611
|
-
# alarm_identifier: "MetricIdentifier", # required
|
612
669
|
# type: "CLOUDWATCH", # required, accepts CLOUDWATCH
|
670
|
+
# alarm_identifier: "MetricIdentifier", # required
|
613
671
|
# },
|
614
672
|
# ],
|
615
|
-
# resource_identifier: "ResourceIdentifier", # required
|
616
673
|
# })
|
617
674
|
#
|
618
675
|
# @example Response structure
|
619
676
|
#
|
620
677
|
# resp.arn #=> String
|
621
678
|
# resp.name #=> String
|
622
|
-
# resp.
|
623
|
-
# resp.practice_run_configuration.blocked_dates[0] #=> String
|
624
|
-
# resp.practice_run_configuration.blocked_windows #=> Array
|
625
|
-
# resp.practice_run_configuration.blocked_windows[0] #=> String
|
679
|
+
# resp.zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
|
626
680
|
# resp.practice_run_configuration.blocking_alarms #=> Array
|
627
|
-
# resp.practice_run_configuration.blocking_alarms[0].alarm_identifier #=> String
|
628
681
|
# resp.practice_run_configuration.blocking_alarms[0].type #=> String, one of "CLOUDWATCH"
|
682
|
+
# resp.practice_run_configuration.blocking_alarms[0].alarm_identifier #=> String
|
629
683
|
# resp.practice_run_configuration.outcome_alarms #=> Array
|
630
|
-
# resp.practice_run_configuration.outcome_alarms[0].alarm_identifier #=> String
|
631
684
|
# resp.practice_run_configuration.outcome_alarms[0].type #=> String, one of "CLOUDWATCH"
|
632
|
-
# resp.
|
685
|
+
# resp.practice_run_configuration.outcome_alarms[0].alarm_identifier #=> String
|
686
|
+
# resp.practice_run_configuration.blocked_windows #=> Array
|
687
|
+
# resp.practice_run_configuration.blocked_windows[0] #=> String
|
688
|
+
# resp.practice_run_configuration.blocked_dates #=> Array
|
689
|
+
# resp.practice_run_configuration.blocked_dates[0] #=> String
|
633
690
|
#
|
634
691
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CreatePracticeRunConfiguration AWS API Documentation
|
635
692
|
#
|
@@ -702,28 +759,43 @@ module Aws::ARCZonalShift
|
|
702
759
|
end
|
703
760
|
|
704
761
|
# Get information about a resource that's been registered for zonal
|
705
|
-
# shifts with Amazon
|
706
|
-
#
|
707
|
-
#
|
708
|
-
#
|
762
|
+
# shifts with Amazon Application Recovery Controller in this Amazon Web
|
763
|
+
# Services Region. Resources that are registered for zonal shifts are
|
764
|
+
# managed resources in ARC. You can start zonal shifts and configure
|
765
|
+
# zonal autoshift for managed resources.
|
709
766
|
#
|
710
767
|
# @option params [required, String] :resource_identifier
|
711
768
|
# The identifier for the resource that Amazon Web Services shifts
|
712
769
|
# traffic for. The identifier is the Amazon Resource Name (ARN) for the
|
713
770
|
# resource.
|
714
771
|
#
|
715
|
-
#
|
716
|
-
#
|
772
|
+
# Amazon Application Recovery Controller currently supports enabling the
|
773
|
+
# following resources for zonal shift and zonal autoshift:
|
774
|
+
#
|
775
|
+
# * [Amazon EC2 Auto Scaling groups][1]
|
776
|
+
#
|
777
|
+
# * [Amazon Elastic Kubernetes Service][2]
|
778
|
+
#
|
779
|
+
# * [Application Load Balancer][3]
|
780
|
+
#
|
781
|
+
# * [Network Load Balancer][4]
|
782
|
+
#
|
783
|
+
#
|
784
|
+
#
|
785
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html
|
786
|
+
# [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html
|
787
|
+
# [3]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html
|
788
|
+
# [4]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html
|
717
789
|
#
|
718
790
|
# @return [Types::GetManagedResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
719
791
|
#
|
720
|
-
# * {Types::GetManagedResourceResponse#applied_weights #applied_weights} => Hash<String,Float>
|
721
792
|
# * {Types::GetManagedResourceResponse#arn #arn} => String
|
722
|
-
# * {Types::GetManagedResourceResponse#autoshifts #autoshifts} => Array<Types::AutoshiftInResource>
|
723
793
|
# * {Types::GetManagedResourceResponse#name #name} => String
|
794
|
+
# * {Types::GetManagedResourceResponse#applied_weights #applied_weights} => Hash<String,Float>
|
795
|
+
# * {Types::GetManagedResourceResponse#zonal_shifts #zonal_shifts} => Array<Types::ZonalShiftInResource>
|
796
|
+
# * {Types::GetManagedResourceResponse#autoshifts #autoshifts} => Array<Types::AutoshiftInResource>
|
724
797
|
# * {Types::GetManagedResourceResponse#practice_run_configuration #practice_run_configuration} => Types::PracticeRunConfiguration
|
725
798
|
# * {Types::GetManagedResourceResponse#zonal_autoshift_status #zonal_autoshift_status} => String
|
726
|
-
# * {Types::GetManagedResourceResponse#zonal_shifts #zonal_shifts} => Array<Types::ZonalShiftInResource>
|
727
799
|
#
|
728
800
|
# @example Request syntax with placeholder values
|
729
801
|
#
|
@@ -733,35 +805,35 @@ module Aws::ARCZonalShift
|
|
733
805
|
#
|
734
806
|
# @example Response structure
|
735
807
|
#
|
808
|
+
# resp.arn #=> String
|
809
|
+
# resp.name #=> String
|
736
810
|
# resp.applied_weights #=> Hash
|
737
811
|
# resp.applied_weights["AvailabilityZone"] #=> Float
|
738
|
-
# resp.
|
812
|
+
# resp.zonal_shifts #=> Array
|
813
|
+
# resp.zonal_shifts[0].applied_status #=> String, one of "APPLIED", "NOT_APPLIED"
|
814
|
+
# resp.zonal_shifts[0].zonal_shift_id #=> String
|
815
|
+
# resp.zonal_shifts[0].resource_identifier #=> String
|
816
|
+
# resp.zonal_shifts[0].away_from #=> String
|
817
|
+
# resp.zonal_shifts[0].expiry_time #=> Time
|
818
|
+
# resp.zonal_shifts[0].start_time #=> Time
|
819
|
+
# resp.zonal_shifts[0].comment #=> String
|
820
|
+
# resp.zonal_shifts[0].shift_type #=> String, one of "ZONAL_SHIFT", "PRACTICE_RUN", "FIS_EXPERIMENT", "ZONAL_AUTOSHIFT"
|
821
|
+
# resp.zonal_shifts[0].practice_run_outcome #=> String, one of "FAILED", "INTERRUPTED", "PENDING", "SUCCEEDED", "CAPACITY_CHECK_FAILED"
|
739
822
|
# resp.autoshifts #=> Array
|
740
823
|
# resp.autoshifts[0].applied_status #=> String, one of "APPLIED", "NOT_APPLIED"
|
741
824
|
# resp.autoshifts[0].away_from #=> String
|
742
825
|
# resp.autoshifts[0].start_time #=> Time
|
743
|
-
# resp.name #=> String
|
744
|
-
# resp.practice_run_configuration.blocked_dates #=> Array
|
745
|
-
# resp.practice_run_configuration.blocked_dates[0] #=> String
|
746
|
-
# resp.practice_run_configuration.blocked_windows #=> Array
|
747
|
-
# resp.practice_run_configuration.blocked_windows[0] #=> String
|
748
826
|
# resp.practice_run_configuration.blocking_alarms #=> Array
|
749
|
-
# resp.practice_run_configuration.blocking_alarms[0].alarm_identifier #=> String
|
750
827
|
# resp.practice_run_configuration.blocking_alarms[0].type #=> String, one of "CLOUDWATCH"
|
828
|
+
# resp.practice_run_configuration.blocking_alarms[0].alarm_identifier #=> String
|
751
829
|
# resp.practice_run_configuration.outcome_alarms #=> Array
|
752
|
-
# resp.practice_run_configuration.outcome_alarms[0].alarm_identifier #=> String
|
753
830
|
# resp.practice_run_configuration.outcome_alarms[0].type #=> String, one of "CLOUDWATCH"
|
831
|
+
# resp.practice_run_configuration.outcome_alarms[0].alarm_identifier #=> String
|
832
|
+
# resp.practice_run_configuration.blocked_windows #=> Array
|
833
|
+
# resp.practice_run_configuration.blocked_windows[0] #=> String
|
834
|
+
# resp.practice_run_configuration.blocked_dates #=> Array
|
835
|
+
# resp.practice_run_configuration.blocked_dates[0] #=> String
|
754
836
|
# resp.zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
|
755
|
-
# resp.zonal_shifts #=> Array
|
756
|
-
# resp.zonal_shifts[0].applied_status #=> String, one of "APPLIED", "NOT_APPLIED"
|
757
|
-
# resp.zonal_shifts[0].away_from #=> String
|
758
|
-
# resp.zonal_shifts[0].comment #=> String
|
759
|
-
# resp.zonal_shifts[0].expiry_time #=> Time
|
760
|
-
# resp.zonal_shifts[0].practice_run_outcome #=> String, one of "FAILED", "INTERRUPTED", "PENDING", "SUCCEEDED"
|
761
|
-
# resp.zonal_shifts[0].resource_identifier #=> String
|
762
|
-
# resp.zonal_shifts[0].shift_type #=> String, one of "ZONAL_SHIFT", "PRACTICE_RUN", "FIS_EXPERIMENT", "ZONAL_AUTOSHIFT"
|
763
|
-
# resp.zonal_shifts[0].start_time #=> Time
|
764
|
-
# resp.zonal_shifts[0].zonal_shift_id #=> String
|
765
837
|
#
|
766
838
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/GetManagedResource AWS API Documentation
|
767
839
|
#
|
@@ -776,9 +848,6 @@ module Aws::ARCZonalShift
|
|
776
848
|
# the call returns only `ACTIVE` autoshifts. Optionally, you can specify
|
777
849
|
# the `status` parameter to return `COMPLETED` autoshifts.
|
778
850
|
#
|
779
|
-
# @option params [Integer] :max_results
|
780
|
-
# The number of objects that you want to return with this call.
|
781
|
-
#
|
782
851
|
# @option params [String] :next_token
|
783
852
|
# Specifies that you want to receive the next page of results. Valid
|
784
853
|
# only if you received a `nextToken` response in the previous request.
|
@@ -789,6 +858,9 @@ module Aws::ARCZonalShift
|
|
789
858
|
# @option params [String] :status
|
790
859
|
# The status of the autoshift.
|
791
860
|
#
|
861
|
+
# @option params [Integer] :max_results
|
862
|
+
# The number of objects that you want to return with this call.
|
863
|
+
#
|
792
864
|
# @return [Types::ListAutoshiftsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
793
865
|
#
|
794
866
|
# * {Types::ListAutoshiftsResponse#items #items} => Array<Types::AutoshiftSummary>
|
@@ -799,9 +871,9 @@ module Aws::ARCZonalShift
|
|
799
871
|
# @example Request syntax with placeholder values
|
800
872
|
#
|
801
873
|
# resp = client.list_autoshifts({
|
802
|
-
# max_results: 1,
|
803
874
|
# next_token: "String",
|
804
875
|
# status: "ACTIVE", # accepts ACTIVE, COMPLETED
|
876
|
+
# max_results: 1,
|
805
877
|
# })
|
806
878
|
#
|
807
879
|
# @example Response structure
|
@@ -824,14 +896,11 @@ module Aws::ARCZonalShift
|
|
824
896
|
|
825
897
|
# Lists all the resources in your Amazon Web Services account in this
|
826
898
|
# Amazon Web Services Region that are managed for zonal shifts in Amazon
|
827
|
-
#
|
828
|
-
#
|
829
|
-
#
|
899
|
+
# Application Recovery Controller, and information about them. The
|
900
|
+
# information includes the zonal autoshift status for the resource, as
|
901
|
+
# well as the Amazon Resource Name (ARN), the Availability Zones that
|
830
902
|
# each resource is deployed in, and the resource name.
|
831
903
|
#
|
832
|
-
# @option params [Integer] :max_results
|
833
|
-
# The number of objects that you want to return with this call.
|
834
|
-
#
|
835
904
|
# @option params [String] :next_token
|
836
905
|
# Specifies that you want to receive the next page of results. Valid
|
837
906
|
# only if you received a `nextToken` response in the previous request.
|
@@ -839,6 +908,9 @@ module Aws::ARCZonalShift
|
|
839
908
|
# parameter to the value provided by the previous call's `nextToken`
|
840
909
|
# response to request the next page of results.
|
841
910
|
#
|
911
|
+
# @option params [Integer] :max_results
|
912
|
+
# The number of objects that you want to return with this call.
|
913
|
+
#
|
842
914
|
# @return [Types::ListManagedResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
843
915
|
#
|
844
916
|
# * {Types::ListManagedResourcesResponse#items #items} => Array<Types::ManagedResourceSummary>
|
@@ -849,35 +921,35 @@ module Aws::ARCZonalShift
|
|
849
921
|
# @example Request syntax with placeholder values
|
850
922
|
#
|
851
923
|
# resp = client.list_managed_resources({
|
852
|
-
# max_results: 1,
|
853
924
|
# next_token: "String",
|
925
|
+
# max_results: 1,
|
854
926
|
# })
|
855
927
|
#
|
856
928
|
# @example Response structure
|
857
929
|
#
|
858
930
|
# resp.items #=> Array
|
859
|
-
# resp.items[0].applied_weights #=> Hash
|
860
|
-
# resp.items[0].applied_weights["AvailabilityZone"] #=> Float
|
861
931
|
# resp.items[0].arn #=> String
|
862
|
-
# resp.items[0].
|
863
|
-
# resp.items[0].autoshifts[0].applied_status #=> String, one of "APPLIED", "NOT_APPLIED"
|
864
|
-
# resp.items[0].autoshifts[0].away_from #=> String
|
865
|
-
# resp.items[0].autoshifts[0].start_time #=> Time
|
932
|
+
# resp.items[0].name #=> String
|
866
933
|
# resp.items[0].availability_zones #=> Array
|
867
934
|
# resp.items[0].availability_zones[0] #=> String
|
868
|
-
# resp.items[0].
|
869
|
-
# resp.items[0].
|
870
|
-
# resp.items[0].zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
|
935
|
+
# resp.items[0].applied_weights #=> Hash
|
936
|
+
# resp.items[0].applied_weights["AvailabilityZone"] #=> Float
|
871
937
|
# resp.items[0].zonal_shifts #=> Array
|
872
938
|
# resp.items[0].zonal_shifts[0].applied_status #=> String, one of "APPLIED", "NOT_APPLIED"
|
939
|
+
# resp.items[0].zonal_shifts[0].zonal_shift_id #=> String
|
940
|
+
# resp.items[0].zonal_shifts[0].resource_identifier #=> String
|
873
941
|
# resp.items[0].zonal_shifts[0].away_from #=> String
|
874
|
-
# resp.items[0].zonal_shifts[0].comment #=> String
|
875
942
|
# resp.items[0].zonal_shifts[0].expiry_time #=> Time
|
876
|
-
# resp.items[0].zonal_shifts[0].practice_run_outcome #=> String, one of "FAILED", "INTERRUPTED", "PENDING", "SUCCEEDED"
|
877
|
-
# resp.items[0].zonal_shifts[0].resource_identifier #=> String
|
878
|
-
# resp.items[0].zonal_shifts[0].shift_type #=> String, one of "ZONAL_SHIFT", "PRACTICE_RUN", "FIS_EXPERIMENT", "ZONAL_AUTOSHIFT"
|
879
943
|
# resp.items[0].zonal_shifts[0].start_time #=> Time
|
880
|
-
# resp.items[0].zonal_shifts[0].
|
944
|
+
# resp.items[0].zonal_shifts[0].comment #=> String
|
945
|
+
# resp.items[0].zonal_shifts[0].shift_type #=> String, one of "ZONAL_SHIFT", "PRACTICE_RUN", "FIS_EXPERIMENT", "ZONAL_AUTOSHIFT"
|
946
|
+
# resp.items[0].zonal_shifts[0].practice_run_outcome #=> String, one of "FAILED", "INTERRUPTED", "PENDING", "SUCCEEDED", "CAPACITY_CHECK_FAILED"
|
947
|
+
# resp.items[0].autoshifts #=> Array
|
948
|
+
# resp.items[0].autoshifts[0].applied_status #=> String, one of "APPLIED", "NOT_APPLIED"
|
949
|
+
# resp.items[0].autoshifts[0].away_from #=> String
|
950
|
+
# resp.items[0].autoshifts[0].start_time #=> Time
|
951
|
+
# resp.items[0].zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
|
952
|
+
# resp.items[0].practice_run_status #=> String, one of "ENABLED", "DISABLED"
|
881
953
|
# resp.next_token #=> String
|
882
954
|
#
|
883
955
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListManagedResources AWS API Documentation
|
@@ -889,12 +961,18 @@ module Aws::ARCZonalShift
|
|
889
961
|
req.send_request(options)
|
890
962
|
end
|
891
963
|
|
892
|
-
# Lists all active and completed zonal shifts in Amazon
|
893
|
-
#
|
894
|
-
#
|
964
|
+
# Lists all active and completed zonal shifts in Amazon Application
|
965
|
+
# Recovery Controller in your Amazon Web Services account in this Amazon
|
966
|
+
# Web Services Region. `ListZonalShifts` returns customer-initiated
|
967
|
+
# zonal shifts, as well as practice run zonal shifts that ARC started on
|
968
|
+
# your behalf for zonal autoshift.
|
969
|
+
#
|
970
|
+
# For more information about listing autoshifts, see
|
971
|
+
# [">ListAutoshifts][1].
|
972
|
+
#
|
895
973
|
#
|
896
|
-
#
|
897
|
-
#
|
974
|
+
#
|
975
|
+
# [1]: https://docs.aws.amazon.com/arc-zonal-shift/latest/api/API_ListAutoshifts.html
|
898
976
|
#
|
899
977
|
# @option params [String] :next_token
|
900
978
|
# Specifies that you want to receive the next page of results. Valid
|
@@ -903,23 +981,26 @@ module Aws::ARCZonalShift
|
|
903
981
|
# parameter to the value provided by the previous call's `nextToken`
|
904
982
|
# response to request the next page of results.
|
905
983
|
#
|
906
|
-
# @option params [String] :resource_identifier
|
907
|
-
# The identifier for the resource that you want to list zonal shifts
|
908
|
-
# for. The identifier is the Amazon Resource Name (ARN) for the
|
909
|
-
# resource.
|
910
|
-
#
|
911
984
|
# @option params [String] :status
|
912
985
|
# A status for a zonal shift.
|
913
986
|
#
|
914
987
|
# The `Status` for a zonal shift can have one of the following values:
|
915
988
|
#
|
916
|
-
# * **ACTIVE**: The zonal shift has been started and active.
|
989
|
+
# * **ACTIVE**: The zonal shift has been started and is active.
|
917
990
|
#
|
918
991
|
# * **EXPIRED**: The zonal shift has expired (the expiry time was
|
919
992
|
# exceeded).
|
920
993
|
#
|
921
994
|
# * **CANCELED**: The zonal shift was canceled.
|
922
995
|
#
|
996
|
+
# @option params [Integer] :max_results
|
997
|
+
# The number of objects that you want to return with this call.
|
998
|
+
#
|
999
|
+
# @option params [String] :resource_identifier
|
1000
|
+
# The identifier for the resource that you want to list zonal shifts
|
1001
|
+
# for. The identifier is the Amazon Resource Name (ARN) for the
|
1002
|
+
# resource.
|
1003
|
+
#
|
923
1004
|
# @return [Types::ListZonalShiftsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
924
1005
|
#
|
925
1006
|
# * {Types::ListZonalShiftsResponse#items #items} => Array<Types::ZonalShiftSummary>
|
@@ -930,24 +1011,24 @@ module Aws::ARCZonalShift
|
|
930
1011
|
# @example Request syntax with placeholder values
|
931
1012
|
#
|
932
1013
|
# resp = client.list_zonal_shifts({
|
933
|
-
# max_results: 1,
|
934
1014
|
# next_token: "String",
|
935
|
-
# resource_identifier: "ResourceIdentifier",
|
936
1015
|
# status: "ACTIVE", # accepts ACTIVE, EXPIRED, CANCELED
|
1016
|
+
# max_results: 1,
|
1017
|
+
# resource_identifier: "ResourceIdentifier",
|
937
1018
|
# })
|
938
1019
|
#
|
939
1020
|
# @example Response structure
|
940
1021
|
#
|
941
1022
|
# resp.items #=> Array
|
1023
|
+
# resp.items[0].zonal_shift_id #=> String
|
1024
|
+
# resp.items[0].resource_identifier #=> String
|
942
1025
|
# resp.items[0].away_from #=> String
|
943
|
-
# resp.items[0].comment #=> String
|
944
1026
|
# resp.items[0].expiry_time #=> Time
|
945
|
-
# resp.items[0].practice_run_outcome #=> String, one of "FAILED", "INTERRUPTED", "PENDING", "SUCCEEDED"
|
946
|
-
# resp.items[0].resource_identifier #=> String
|
947
|
-
# resp.items[0].shift_type #=> String, one of "ZONAL_SHIFT", "PRACTICE_RUN", "FIS_EXPERIMENT", "ZONAL_AUTOSHIFT"
|
948
1027
|
# resp.items[0].start_time #=> Time
|
949
1028
|
# resp.items[0].status #=> String, one of "ACTIVE", "EXPIRED", "CANCELED"
|
950
|
-
# resp.items[0].
|
1029
|
+
# resp.items[0].comment #=> String
|
1030
|
+
# resp.items[0].shift_type #=> String, one of "ZONAL_SHIFT", "PRACTICE_RUN", "FIS_EXPERIMENT", "ZONAL_AUTOSHIFT"
|
1031
|
+
# resp.items[0].practice_run_outcome #=> String, one of "FAILED", "INTERRUPTED", "PENDING", "SUCCEEDED", "CAPACITY_CHECK_FAILED"
|
951
1032
|
# resp.next_token #=> String
|
952
1033
|
#
|
953
1034
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListZonalShifts AWS API Documentation
|
@@ -959,6 +1040,78 @@ module Aws::ARCZonalShift
|
|
959
1040
|
req.send_request(options)
|
960
1041
|
end
|
961
1042
|
|
1043
|
+
# Start an on-demand practice run zonal shift in Amazon Application
|
1044
|
+
# Recovery Controller. With zonal autoshift enabled, you can start an
|
1045
|
+
# on-demand practice run to verify preparedness at any time. Amazon Web
|
1046
|
+
# Services also runs automated practice runs about weekly when you have
|
1047
|
+
# enabled zonal autoshift.
|
1048
|
+
#
|
1049
|
+
# For more information, see [ Considerations when you configure zonal
|
1050
|
+
# autoshift][1] in the Amazon Application Recovery Controller Developer
|
1051
|
+
# Guide.
|
1052
|
+
#
|
1053
|
+
#
|
1054
|
+
#
|
1055
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html
|
1056
|
+
#
|
1057
|
+
# @option params [required, String] :resource_identifier
|
1058
|
+
# The identifier for the resource that you want to start a practice run
|
1059
|
+
# zonal shift for. The identifier is the Amazon Resource Name (ARN) for
|
1060
|
+
# the resource.
|
1061
|
+
#
|
1062
|
+
# @option params [required, String] :away_from
|
1063
|
+
# The Availability Zone (for example, `use1-az1`) that traffic is
|
1064
|
+
# shifted away from for the resource that you specify for the practice
|
1065
|
+
# run.
|
1066
|
+
#
|
1067
|
+
# @option params [required, String] :comment
|
1068
|
+
# The initial comment that you enter about the practice run. Be aware
|
1069
|
+
# that this comment can be overwritten by Amazon Web Services if the
|
1070
|
+
# automatic check for balanced capacity fails. For more information, see
|
1071
|
+
# [ Capacity checks for practice runs][1] in the Amazon Application
|
1072
|
+
# Recovery Controller Developer Guide.
|
1073
|
+
#
|
1074
|
+
#
|
1075
|
+
#
|
1076
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.capacity-check.html
|
1077
|
+
#
|
1078
|
+
# @return [Types::StartPracticeRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1079
|
+
#
|
1080
|
+
# * {Types::StartPracticeRunResponse#zonal_shift_id #zonal_shift_id} => String
|
1081
|
+
# * {Types::StartPracticeRunResponse#resource_identifier #resource_identifier} => String
|
1082
|
+
# * {Types::StartPracticeRunResponse#away_from #away_from} => String
|
1083
|
+
# * {Types::StartPracticeRunResponse#expiry_time #expiry_time} => Time
|
1084
|
+
# * {Types::StartPracticeRunResponse#start_time #start_time} => Time
|
1085
|
+
# * {Types::StartPracticeRunResponse#status #status} => String
|
1086
|
+
# * {Types::StartPracticeRunResponse#comment #comment} => String
|
1087
|
+
#
|
1088
|
+
# @example Request syntax with placeholder values
|
1089
|
+
#
|
1090
|
+
# resp = client.start_practice_run({
|
1091
|
+
# resource_identifier: "ResourceIdentifier", # required
|
1092
|
+
# away_from: "AvailabilityZone", # required
|
1093
|
+
# comment: "ZonalShiftComment", # required
|
1094
|
+
# })
|
1095
|
+
#
|
1096
|
+
# @example Response structure
|
1097
|
+
#
|
1098
|
+
# resp.zonal_shift_id #=> String
|
1099
|
+
# resp.resource_identifier #=> String
|
1100
|
+
# resp.away_from #=> String
|
1101
|
+
# resp.expiry_time #=> Time
|
1102
|
+
# resp.start_time #=> Time
|
1103
|
+
# resp.status #=> String, one of "ACTIVE", "EXPIRED", "CANCELED"
|
1104
|
+
# resp.comment #=> String
|
1105
|
+
#
|
1106
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/StartPracticeRun AWS API Documentation
|
1107
|
+
#
|
1108
|
+
# @overload start_practice_run(params = {})
|
1109
|
+
# @param [Hash] params ({})
|
1110
|
+
def start_practice_run(params = {}, options = {})
|
1111
|
+
req = build_request(:start_practice_run, params)
|
1112
|
+
req.send_request(options)
|
1113
|
+
end
|
1114
|
+
|
962
1115
|
# You start a zonal shift to temporarily move load balancer traffic away
|
963
1116
|
# from an Availability Zone in an Amazon Web Services Region, to help
|
964
1117
|
# your application recover immediately, for example, from a developer's
|
@@ -968,9 +1121,16 @@ module Aws::ARCZonalShift
|
|
968
1121
|
# an Amazon Web Services Region. Resources are automatically registered
|
969
1122
|
# with ARC by Amazon Web Services services.
|
970
1123
|
#
|
971
|
-
#
|
972
|
-
#
|
973
|
-
#
|
1124
|
+
# Amazon Application Recovery Controller currently supports enabling the
|
1125
|
+
# following resources for zonal shift and zonal autoshift:
|
1126
|
+
#
|
1127
|
+
# * [Amazon EC2 Auto Scaling groups][1]
|
1128
|
+
#
|
1129
|
+
# * [Amazon Elastic Kubernetes Service][2]
|
1130
|
+
#
|
1131
|
+
# * [Application Load Balancer][3]
|
1132
|
+
#
|
1133
|
+
# * [Network Load Balancer][4]
|
974
1134
|
#
|
975
1135
|
# When you start a zonal shift, traffic for the resource is no longer
|
976
1136
|
# routed to the Availability Zone. The zonal shift is created
|
@@ -978,12 +1138,39 @@ module Aws::ARCZonalShift
|
|
978
1138
|
# a few minutes, for existing, in-progress connections in the
|
979
1139
|
# Availability Zone to complete.
|
980
1140
|
#
|
981
|
-
# For more information, see [Zonal shift][
|
982
|
-
#
|
1141
|
+
# For more information, see [Zonal shift][5] in the Amazon Application
|
1142
|
+
# Recovery Controller Developer Guide.
|
1143
|
+
#
|
1144
|
+
#
|
983
1145
|
#
|
1146
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html
|
1147
|
+
# [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html
|
1148
|
+
# [3]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html
|
1149
|
+
# [4]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html
|
1150
|
+
# [5]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.html
|
984
1151
|
#
|
1152
|
+
# @option params [required, String] :resource_identifier
|
1153
|
+
# The identifier for the resource that Amazon Web Services shifts
|
1154
|
+
# traffic for. The identifier is the Amazon Resource Name (ARN) for the
|
1155
|
+
# resource.
|
1156
|
+
#
|
1157
|
+
# Amazon Application Recovery Controller currently supports enabling the
|
1158
|
+
# following resources for zonal shift and zonal autoshift:
|
1159
|
+
#
|
1160
|
+
# * [Amazon EC2 Auto Scaling groups][1]
|
985
1161
|
#
|
986
|
-
# [
|
1162
|
+
# * [Amazon Elastic Kubernetes Service][2]
|
1163
|
+
#
|
1164
|
+
# * [Application Load Balancer][3]
|
1165
|
+
#
|
1166
|
+
# * [Network Load Balancer][4]
|
1167
|
+
#
|
1168
|
+
#
|
1169
|
+
#
|
1170
|
+
# [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html
|
1171
|
+
# [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html
|
1172
|
+
# [3]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html
|
1173
|
+
# [4]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html
|
987
1174
|
#
|
988
1175
|
# @option params [required, String] :away_from
|
989
1176
|
# The Availability Zone (for example, `use1-az1`) that traffic is moved
|
@@ -991,11 +1178,6 @@ module Aws::ARCZonalShift
|
|
991
1178
|
# shift expires or you cancel it, traffic for the resource is instead
|
992
1179
|
# moved to other Availability Zones in the Amazon Web Services Region.
|
993
1180
|
#
|
994
|
-
# @option params [required, String] :comment
|
995
|
-
# A comment that you enter about the zonal shift. Only the latest
|
996
|
-
# comment is retained; no comment history is maintained. A new comment
|
997
|
-
# overwrites any existing comment string.
|
998
|
-
#
|
999
1181
|
# @option params [required, String] :expires_in
|
1000
1182
|
# The length of time that you want a zonal shift to be active, which ARC
|
1001
1183
|
# converts to an expiry time (expiration time). Zonal shifts are
|
@@ -1017,42 +1199,39 @@ module Aws::ARCZonalShift
|
|
1017
1199
|
# For example: `20h` means the zonal shift expires in 20 hours. `120m`
|
1018
1200
|
# means the zonal shift expires in 120 minutes (2 hours).
|
1019
1201
|
#
|
1020
|
-
# @option params [required, String] :
|
1021
|
-
#
|
1022
|
-
#
|
1023
|
-
#
|
1024
|
-
#
|
1025
|
-
# At this time, supported resources are Network Load Balancers and
|
1026
|
-
# Application Load Balancers with cross-zone load balancing turned off.
|
1202
|
+
# @option params [required, String] :comment
|
1203
|
+
# A comment that you enter about the zonal shift. Only the latest
|
1204
|
+
# comment is retained; no comment history is maintained. A new comment
|
1205
|
+
# overwrites any existing comment string.
|
1027
1206
|
#
|
1028
1207
|
# @return [Types::ZonalShift] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1029
1208
|
#
|
1209
|
+
# * {Types::ZonalShift#zonal_shift_id #zonal_shift_id} => String
|
1210
|
+
# * {Types::ZonalShift#resource_identifier #resource_identifier} => String
|
1030
1211
|
# * {Types::ZonalShift#away_from #away_from} => String
|
1031
|
-
# * {Types::ZonalShift#comment #comment} => String
|
1032
1212
|
# * {Types::ZonalShift#expiry_time #expiry_time} => Time
|
1033
|
-
# * {Types::ZonalShift#resource_identifier #resource_identifier} => String
|
1034
1213
|
# * {Types::ZonalShift#start_time #start_time} => Time
|
1035
1214
|
# * {Types::ZonalShift#status #status} => String
|
1036
|
-
# * {Types::ZonalShift#
|
1215
|
+
# * {Types::ZonalShift#comment #comment} => String
|
1037
1216
|
#
|
1038
1217
|
# @example Request syntax with placeholder values
|
1039
1218
|
#
|
1040
1219
|
# resp = client.start_zonal_shift({
|
1220
|
+
# resource_identifier: "ResourceIdentifier", # required
|
1041
1221
|
# away_from: "AvailabilityZone", # required
|
1042
|
-
# comment: "ZonalShiftComment", # required
|
1043
1222
|
# expires_in: "ExpiresIn", # required
|
1044
|
-
#
|
1223
|
+
# comment: "ZonalShiftComment", # required
|
1045
1224
|
# })
|
1046
1225
|
#
|
1047
1226
|
# @example Response structure
|
1048
1227
|
#
|
1228
|
+
# resp.zonal_shift_id #=> String
|
1229
|
+
# resp.resource_identifier #=> String
|
1049
1230
|
# resp.away_from #=> String
|
1050
|
-
# resp.comment #=> String
|
1051
1231
|
# resp.expiry_time #=> Time
|
1052
|
-
# resp.resource_identifier #=> String
|
1053
1232
|
# resp.start_time #=> Time
|
1054
1233
|
# resp.status #=> String, one of "ACTIVE", "EXPIRED", "CANCELED"
|
1055
|
-
# resp.
|
1234
|
+
# resp.comment #=> String
|
1056
1235
|
#
|
1057
1236
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/StartZonalShift AWS API Documentation
|
1058
1237
|
#
|
@@ -1073,8 +1252,8 @@ module Aws::ARCZonalShift
|
|
1073
1252
|
# one or more of your resources is included in the autoshift.
|
1074
1253
|
#
|
1075
1254
|
# For more information, see [ Notifications for practice runs and
|
1076
|
-
# autoshifts][1] in the Amazon
|
1077
|
-
#
|
1255
|
+
# autoshifts][1] in the Amazon Application Recovery Controller Developer
|
1256
|
+
# Guide.
|
1078
1257
|
#
|
1079
1258
|
#
|
1080
1259
|
#
|
@@ -1115,18 +1294,10 @@ module Aws::ARCZonalShift
|
|
1115
1294
|
# outcome alarm; or add, change, or remove blocking dates or time
|
1116
1295
|
# windows.
|
1117
1296
|
#
|
1118
|
-
# @option params [
|
1119
|
-
#
|
1120
|
-
#
|
1121
|
-
#
|
1122
|
-
# Optionally, you can block practice runs for specific calendar dates.
|
1123
|
-
# The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you
|
1124
|
-
# specify dates, that dates and times for practice runs are in UTC.
|
1125
|
-
# Separate multiple blocked dates with spaces.
|
1126
|
-
#
|
1127
|
-
# For example, if you have an application update scheduled to launch on
|
1128
|
-
# May 1, 2024, and you don't want practice runs to shift traffic away
|
1129
|
-
# at that time, you could set a blocked date for `2024-05-01`.
|
1297
|
+
# @option params [required, String] :resource_identifier
|
1298
|
+
# The identifier for the resource that you want to update the practice
|
1299
|
+
# run configuration for. The identifier is the Amazon Resource Name
|
1300
|
+
# (ARN) for the resource.
|
1130
1301
|
#
|
1131
1302
|
# @option params [Array<String>] :blocked_windows
|
1132
1303
|
# Add, change, or remove windows of days and times for when you can,
|
@@ -1143,6 +1314,19 @@ module Aws::ARCZonalShift
|
|
1143
1314
|
# times as blocked windows, for example: `MON-20:30-21:30
|
1144
1315
|
# WED-20:30-21:30 FRI-20:30-21:30`.
|
1145
1316
|
#
|
1317
|
+
# @option params [Array<String>] :blocked_dates
|
1318
|
+
# Add, change, or remove blocked dates for a practice run in zonal
|
1319
|
+
# autoshift.
|
1320
|
+
#
|
1321
|
+
# Optionally, you can block practice runs for specific calendar dates.
|
1322
|
+
# The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you
|
1323
|
+
# specify dates, that dates and times for practice runs are in UTC.
|
1324
|
+
# Separate multiple blocked dates with spaces.
|
1325
|
+
#
|
1326
|
+
# For example, if you have an application update scheduled to launch on
|
1327
|
+
# May 1, 2024, and you don't want practice runs to shift traffic away
|
1328
|
+
# at that time, you could set a blocked date for `2024-05-01`.
|
1329
|
+
#
|
1146
1330
|
# @option params [Array<Types::ControlCondition>] :blocking_alarms
|
1147
1331
|
# Add, change, or remove the Amazon CloudWatch alarm that you optionally
|
1148
1332
|
# specify as the blocking alarm for practice runs.
|
@@ -1151,53 +1335,48 @@ module Aws::ARCZonalShift
|
|
1151
1335
|
# Specify a new the Amazon CloudWatch alarm as the outcome alarm for
|
1152
1336
|
# practice runs.
|
1153
1337
|
#
|
1154
|
-
# @option params [required, String] :resource_identifier
|
1155
|
-
# The identifier for the resource that you want to update the practice
|
1156
|
-
# run configuration for. The identifier is the Amazon Resource Name
|
1157
|
-
# (ARN) for the resource.
|
1158
|
-
#
|
1159
1338
|
# @return [Types::UpdatePracticeRunConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1160
1339
|
#
|
1161
1340
|
# * {Types::UpdatePracticeRunConfigurationResponse#arn #arn} => String
|
1162
1341
|
# * {Types::UpdatePracticeRunConfigurationResponse#name #name} => String
|
1163
|
-
# * {Types::UpdatePracticeRunConfigurationResponse#practice_run_configuration #practice_run_configuration} => Types::PracticeRunConfiguration
|
1164
1342
|
# * {Types::UpdatePracticeRunConfigurationResponse#zonal_autoshift_status #zonal_autoshift_status} => String
|
1343
|
+
# * {Types::UpdatePracticeRunConfigurationResponse#practice_run_configuration #practice_run_configuration} => Types::PracticeRunConfiguration
|
1165
1344
|
#
|
1166
1345
|
# @example Request syntax with placeholder values
|
1167
1346
|
#
|
1168
1347
|
# resp = client.update_practice_run_configuration({
|
1169
|
-
#
|
1348
|
+
# resource_identifier: "ResourceIdentifier", # required
|
1170
1349
|
# blocked_windows: ["BlockedWindow"],
|
1350
|
+
# blocked_dates: ["BlockedDate"],
|
1171
1351
|
# blocking_alarms: [
|
1172
1352
|
# {
|
1173
|
-
# alarm_identifier: "MetricIdentifier", # required
|
1174
1353
|
# type: "CLOUDWATCH", # required, accepts CLOUDWATCH
|
1354
|
+
# alarm_identifier: "MetricIdentifier", # required
|
1175
1355
|
# },
|
1176
1356
|
# ],
|
1177
1357
|
# outcome_alarms: [
|
1178
1358
|
# {
|
1179
|
-
# alarm_identifier: "MetricIdentifier", # required
|
1180
1359
|
# type: "CLOUDWATCH", # required, accepts CLOUDWATCH
|
1360
|
+
# alarm_identifier: "MetricIdentifier", # required
|
1181
1361
|
# },
|
1182
1362
|
# ],
|
1183
|
-
# resource_identifier: "ResourceIdentifier", # required
|
1184
1363
|
# })
|
1185
1364
|
#
|
1186
1365
|
# @example Response structure
|
1187
1366
|
#
|
1188
1367
|
# resp.arn #=> String
|
1189
1368
|
# resp.name #=> String
|
1190
|
-
# resp.
|
1191
|
-
# resp.practice_run_configuration.blocked_dates[0] #=> String
|
1192
|
-
# resp.practice_run_configuration.blocked_windows #=> Array
|
1193
|
-
# resp.practice_run_configuration.blocked_windows[0] #=> String
|
1369
|
+
# resp.zonal_autoshift_status #=> String, one of "ENABLED", "DISABLED"
|
1194
1370
|
# resp.practice_run_configuration.blocking_alarms #=> Array
|
1195
|
-
# resp.practice_run_configuration.blocking_alarms[0].alarm_identifier #=> String
|
1196
1371
|
# resp.practice_run_configuration.blocking_alarms[0].type #=> String, one of "CLOUDWATCH"
|
1372
|
+
# resp.practice_run_configuration.blocking_alarms[0].alarm_identifier #=> String
|
1197
1373
|
# resp.practice_run_configuration.outcome_alarms #=> Array
|
1198
|
-
# resp.practice_run_configuration.outcome_alarms[0].alarm_identifier #=> String
|
1199
1374
|
# resp.practice_run_configuration.outcome_alarms[0].type #=> String, one of "CLOUDWATCH"
|
1200
|
-
# resp.
|
1375
|
+
# resp.practice_run_configuration.outcome_alarms[0].alarm_identifier #=> String
|
1376
|
+
# resp.practice_run_configuration.blocked_windows #=> Array
|
1377
|
+
# resp.practice_run_configuration.blocked_windows[0] #=> String
|
1378
|
+
# resp.practice_run_configuration.blocked_dates #=> Array
|
1379
|
+
# resp.practice_run_configuration.blocked_dates[0] #=> String
|
1201
1380
|
#
|
1202
1381
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdatePracticeRunConfiguration AWS API Documentation
|
1203
1382
|
#
|
@@ -1210,11 +1389,11 @@ module Aws::ARCZonalShift
|
|
1210
1389
|
|
1211
1390
|
# The zonal autoshift configuration for a resource includes the practice
|
1212
1391
|
# run configuration and the status for running autoshifts, zonal
|
1213
|
-
# autoshift status. When a resource has a practice run configuation,
|
1214
|
-
#
|
1215
|
-
#
|
1216
|
-
#
|
1217
|
-
#
|
1392
|
+
# autoshift status. When a resource has a practice run configuation, ARC
|
1393
|
+
# starts weekly zonal shifts for the resource, to shift traffic away
|
1394
|
+
# from an Availability Zone. Weekly practice runs help you to make sure
|
1395
|
+
# that your application can continue to operate normally with the loss
|
1396
|
+
# of one Availability Zone.
|
1218
1397
|
#
|
1219
1398
|
# You can update the zonal autoshift autoshift status to enable or
|
1220
1399
|
# disable zonal autoshift. When zonal autoshift is `ENABLED`, you
|
@@ -1261,10 +1440,13 @@ module Aws::ARCZonalShift
|
|
1261
1440
|
req.send_request(options)
|
1262
1441
|
end
|
1263
1442
|
|
1264
|
-
# Update an active zonal shift in Amazon
|
1265
|
-
#
|
1266
|
-
#
|
1267
|
-
#
|
1443
|
+
# Update an active zonal shift in Amazon Application Recovery Controller
|
1444
|
+
# in your Amazon Web Services account. You can update a zonal shift to
|
1445
|
+
# set a new expiration, or edit or replace the comment for the zonal
|
1446
|
+
# shift.
|
1447
|
+
#
|
1448
|
+
# @option params [required, String] :zonal_shift_id
|
1449
|
+
# The identifier of a zonal shift.
|
1268
1450
|
#
|
1269
1451
|
# @option params [String] :comment
|
1270
1452
|
# A comment that you enter about the zonal shift. Only the latest
|
@@ -1292,36 +1474,33 @@ module Aws::ARCZonalShift
|
|
1292
1474
|
# For example: `20h` means the zonal shift expires in 20 hours. `120m`
|
1293
1475
|
# means the zonal shift expires in 120 minutes (2 hours).
|
1294
1476
|
#
|
1295
|
-
# @option params [required, String] :zonal_shift_id
|
1296
|
-
# The identifier of a zonal shift.
|
1297
|
-
#
|
1298
1477
|
# @return [Types::ZonalShift] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1299
1478
|
#
|
1479
|
+
# * {Types::ZonalShift#zonal_shift_id #zonal_shift_id} => String
|
1480
|
+
# * {Types::ZonalShift#resource_identifier #resource_identifier} => String
|
1300
1481
|
# * {Types::ZonalShift#away_from #away_from} => String
|
1301
|
-
# * {Types::ZonalShift#comment #comment} => String
|
1302
1482
|
# * {Types::ZonalShift#expiry_time #expiry_time} => Time
|
1303
|
-
# * {Types::ZonalShift#resource_identifier #resource_identifier} => String
|
1304
1483
|
# * {Types::ZonalShift#start_time #start_time} => Time
|
1305
1484
|
# * {Types::ZonalShift#status #status} => String
|
1306
|
-
# * {Types::ZonalShift#
|
1485
|
+
# * {Types::ZonalShift#comment #comment} => String
|
1307
1486
|
#
|
1308
1487
|
# @example Request syntax with placeholder values
|
1309
1488
|
#
|
1310
1489
|
# resp = client.update_zonal_shift({
|
1490
|
+
# zonal_shift_id: "ZonalShiftId", # required
|
1311
1491
|
# comment: "ZonalShiftComment",
|
1312
1492
|
# expires_in: "ExpiresIn",
|
1313
|
-
# zonal_shift_id: "ZonalShiftId", # required
|
1314
1493
|
# })
|
1315
1494
|
#
|
1316
1495
|
# @example Response structure
|
1317
1496
|
#
|
1497
|
+
# resp.zonal_shift_id #=> String
|
1498
|
+
# resp.resource_identifier #=> String
|
1318
1499
|
# resp.away_from #=> String
|
1319
|
-
# resp.comment #=> String
|
1320
1500
|
# resp.expiry_time #=> Time
|
1321
|
-
# resp.resource_identifier #=> String
|
1322
1501
|
# resp.start_time #=> Time
|
1323
1502
|
# resp.status #=> String, one of "ACTIVE", "EXPIRED", "CANCELED"
|
1324
|
-
# resp.
|
1503
|
+
# resp.comment #=> String
|
1325
1504
|
#
|
1326
1505
|
# @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdateZonalShift AWS API Documentation
|
1327
1506
|
#
|
@@ -1350,7 +1529,7 @@ module Aws::ARCZonalShift
|
|
1350
1529
|
tracer: tracer
|
1351
1530
|
)
|
1352
1531
|
context[:gem_name] = 'aws-sdk-arczonalshift'
|
1353
|
-
context[:gem_version] = '1.
|
1532
|
+
context[:gem_version] = '1.35.0'
|
1354
1533
|
Seahorse::Client::Request.new(handlers, context)
|
1355
1534
|
end
|
1356
1535
|
|