aws-sdk-route53recoverycluster 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15b45a22e398f4d22c68de1d15ec4baf0326e9544c08744eb39ad38e5e2eb5eb
-  data.tar.gz: bfb85370f7ebcf77e442a4baf0b41924219d93877aba0c1b21c3e9c03d75502c
+  metadata.gz: f056cc69373080730ec362738dadfae29b85b71725c5fb4a115dffe9a0d93a7b
+  data.tar.gz: 41c963fcdad2d37d117b5d098ed9654b484a50838d13f8802f15c59ad458eec3
 SHA512:
-  metadata.gz: a719bb50b7e429561425dfc7a868d126f00cf5fc2e8abcbe44c883a82bb3ccafdd54adebe2906bee4fa2ae316e281d8057f3f6f99d63e972eb3a31b0da2e974d
-  data.tar.gz: fab0a857302fbe9e5d8c750f79387c412416c6a8a24aec990e38fc563a0856507961a090d01348fd279af2b2c973178541fc56351ed6d876de07a6d4c4318d65
+  metadata.gz: fdcb8d7886a77419677e60b5691754f187344d6ad179e6d77bc74dae6224010009c50c37a9829e997883b471994170383b4ba689335c8ab9563ce6a427471709
+  data.tar.gz: f6c72de1f9feb7b61c6cb53c84afca7f1df171d3e6abb1ff015850eb4f69fb7862b8a94ac1f81ebf2c634d35d845171b0e76f56f3e1114602167005466a27919

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.10.0 (2022-02-28)
+------------------
+
+* Feature - This release adds a new API option to enable overriding safety rules to allow routing control state updates.
+
 1.9.0 (2022-02-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.9.0
+1.10.0

data/lib/aws-sdk-route53recoverycluster/client.rb

@@ -363,22 +363,39 @@ module Aws::Route53RecoveryCluster
 
     # Get the state for a routing control. A routing control is a simple
     # on/off switch that you can use to route traffic to cells. When the
-    # state is On, traffic flows to a cell. When it's off, traffic does not
+    # state is On, traffic flows to a cell. When it's Off, traffic does not
     # flow.
     #
-    # Before you can create a routing control, you first must create a
-    # cluster to host the control. For more information, see
-    # [CreateCluster][1]. Access one of the endpoints for the cluster to get
-    # or update the routing control state to redirect traffic.
+    # Before you can create a routing control, you must first create a
+    # cluster to host the control in a control panel. For more information,
+    # see [ Create routing control structures][1] in the Amazon Route 53
+    # Application Recovery Controller Developer Guide. Then you access one
+    # of the endpoints for the cluster to get or update the routing control
+    # state to redirect traffic.
     #
-    # For more information about working with routing controls, see [Routing
-    # control][2] in the Route 53 Application Recovery Controller Developer
-    # Guide.
+    # *You must specify Regional endpoints when you work with API cluster
+    # operations to get or update routing control states in Application
+    # Recovery Controller.*
     #
+    # To see a code example for getting a routing control state, including
+    # accessing Regional cluster endpoints in sequence, see [API
+    # examples][2] in the Amazon Route 53 Application Recovery Controller
+    # Developer Guide.
     #
+    # Learn more about working with routing controls in the following topics
+    # in the Amazon Route 53 Application Recovery Controller Developer
+    # Guide:
     #
-    # [1]: https://docs.aws.amazon.com/recovery-cluster/latest/api/cluster.html
-    # [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html
+    # * [ Viewing and updating routing control states][3]
+    #
+    # * [Working with routing controls overall][4]
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html
+    # [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html
+    # [3]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html
+    # [4]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html
     #
     # @option params [required, String] :routing_control_arn
     #   The Amazon Resource Number (ARN) for the routing control that you want
@@ -411,15 +428,44 @@ module Aws::Route53RecoveryCluster
 
     # Set the state of the routing control to reroute traffic. You can set
     # the value to be On or Off. When the state is On, traffic flows to a
-    # cell. When it's off, traffic does not flow.
+    # cell. When it's Off, traffic does not flow.
+    #
+    # With Application Recovery Controller, you can add safety rules for
+    # routing controls, which are safeguards for routing control state
+    # updates that help prevent unexpected outcomes, like fail open traffic
+    # routing. However, there are scenarios when you might want to bypass
+    # the routing control safeguards that are enforced with safety rules
+    # that you've configured. For example, you might want to fail over
+    # quickly for disaster recovery, and one or more safety rules might be
+    # unexpectedly preventing you from updating a routing control state to
+    # reroute traffic. In a "break glass" scenario like this, you can
+    # override one or more safety rules to change a routing control state
+    # and fail over your application.
+    #
+    # The `SafetyRulesToOverride` property enables you override one or more
+    # safety rules and update routing control states. For more information,
+    # see [ Override safety rules to reroute traffic][1] in the Amazon Route
+    # 53 Application Recovery Controller Developer Guide.
     #
-    # For more information about working with routing controls, see [Routing
-    # control][1] in the Route 53 Application Recovery Controller Developer
-    # Guide.
+    # *You must specify Regional endpoints when you work with API cluster
+    # operations to get or update routing control states in Application
+    # Recovery Controller.*
     #
+    # To see a code example for getting a routing control state, including
+    # accessing Regional cluster endpoints in sequence, see [API
+    # examples][2] in the Amazon Route 53 Application Recovery Controller
+    # Developer Guide.
     #
+    # * [ Viewing and updating routing control states][3]
     #
-    # [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html
+    # * [Working with routing controls overall][4]
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html
+    # [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html
+    # [3]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html
+    # [4]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html
     #
     # @option params [required, String] :routing_control_arn
     #   The Amazon Resource Number (ARN) for the routing control that you want
@@ -429,6 +475,20 @@ module Aws::Route53RecoveryCluster
     #   The state of the routing control. You can set the value to be On or
     #   Off.
     #
+    # @option params [Array<String>] :safety_rules_to_override
+    #   The Amazon Resource Numbers (ARNs) for the safety rules that you want
+    #   to override when you're updating the state of a routing control. You
+    #   can override one safety rule or multiple safety rules by including one
+    #   or more ARNs, separated by commas.
+    #
+    #   For more information, see [ Override safety rules to reroute
+    #   traffic][1] in the Amazon Route 53 Application Recovery Controller
+    #   Developer Guide.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html
+    #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
@@ -436,6 +496,7 @@ module Aws::Route53RecoveryCluster
     #   resp = client.update_routing_control_state({
     #     routing_control_arn: "Arn", # required
     #     routing_control_state: "On", # required, accepts On, Off
+    #     safety_rules_to_override: ["Arn"],
     #   })
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02/UpdateRoutingControlState AWS API Documentation
@@ -449,19 +510,62 @@ module Aws::Route53RecoveryCluster
 
     # Set multiple routing control states. You can set the value for each
     # state to be On or Off. When the state is On, traffic flows to a cell.
-    # When it's off, traffic does not flow.
+    # When it's Off, traffic does not flow.
+    #
+    # With Application Recovery Controller, you can add safety rules for
+    # routing controls, which are safeguards for routing control state
+    # updates that help prevent unexpected outcomes, like fail open traffic
+    # routing. However, there are scenarios when you might want to bypass
+    # the routing control safeguards that are enforced with safety rules
+    # that you've configured. For example, you might want to fail over
+    # quickly for disaster recovery, and one or more safety rules might be
+    # unexpectedly preventing you from updating a routing control state to
+    # reroute traffic. In a "break glass" scenario like this, you can
+    # override one or more safety rules to change a routing control state
+    # and fail over your application.
+    #
+    # The `SafetyRulesToOverride` property enables you override one or more
+    # safety rules and update routing control states. For more information,
+    # see [ Override safety rules to reroute traffic][1] in the Amazon Route
+    # 53 Application Recovery Controller Developer Guide.
+    #
+    # *You must specify Regional endpoints when you work with API cluster
+    # operations to get or update routing control states in Application
+    # Recovery Controller.*
+    #
+    # To see a code example for getting a routing control state, including
+    # accessing Regional cluster endpoints in sequence, see [API
+    # examples][2] in the Amazon Route 53 Application Recovery Controller
+    # Developer Guide.
     #
-    # For more information about working with routing controls, see [Routing
-    # control][1] in the Route 53 Application Recovery Controller Developer
-    # Guide.
+    # * [ Viewing and updating routing control states][3]
     #
+    # * [Working with routing controls overall][4]
     #
     #
-    # [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html
+    #
+    # [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html
+    # [2]: https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html
+    # [3]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html
+    # [4]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html
     #
     # @option params [required, Array<Types::UpdateRoutingControlStateEntry>] :update_routing_control_state_entries
     #   A set of routing control entries that you want to update.
     #
+    # @option params [Array<String>] :safety_rules_to_override
+    #   The Amazon Resource Numbers (ARNs) for the safety rules that you want
+    #   to override when you're updating routing control states. You can
+    #   override one safety rule or multiple safety rules by including one or
+    #   more ARNs, separated by commas.
+    #
+    #   For more information, see [ Override safety rules to reroute
+    #   traffic][1] in the Amazon Route 53 Application Recovery Controller
+    #   Developer Guide.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html
+    #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
@@ -473,6 +577,7 @@ module Aws::Route53RecoveryCluster
     #         routing_control_state: "On", # required, accepts On, Off
     #       },
     #     ],
+    #     safety_rules_to_override: ["Arn"],
     #   })
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02/UpdateRoutingControlStates AWS API Documentation
@@ -497,7 +602,7 @@ module Aws::Route53RecoveryCluster
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-route53recoverycluster'
-      context[:gem_version] = '1.9.0'
+      context[:gem_version] = '1.10.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-route53recoverycluster/client_api.rb

@@ -15,6 +15,7 @@ module Aws::Route53RecoveryCluster
 
     AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
     Arn = Shapes::StringShape.new(name: 'Arn')
+    Arns = Shapes::ListShape.new(name: 'Arns')
     ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
     EndpointTemporarilyUnavailableException = Shapes::StructureShape.new(name: 'EndpointTemporarilyUnavailableException')
     GetRoutingControlStateRequest = Shapes::StructureShape.new(name: 'GetRoutingControlStateRequest')
@@ -39,6 +40,8 @@ module Aws::Route53RecoveryCluster
     AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
     AccessDeniedException.struct_class = Types::AccessDeniedException
 
+    Arns.member = Shapes::ShapeRef.new(shape: Arn)
+
     ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
     ConflictException.add_member(:resource_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "resourceId"))
     ConflictException.add_member(:resource_type, Shapes::ShapeRef.new(shape: String, required: true, location_name: "resourceType"))
@@ -75,11 +78,13 @@ module Aws::Route53RecoveryCluster
 
     UpdateRoutingControlStateRequest.add_member(:routing_control_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "RoutingControlArn"))
     UpdateRoutingControlStateRequest.add_member(:routing_control_state, Shapes::ShapeRef.new(shape: RoutingControlState, required: true, location_name: "RoutingControlState"))
+    UpdateRoutingControlStateRequest.add_member(:safety_rules_to_override, Shapes::ShapeRef.new(shape: Arns, location_name: "SafetyRulesToOverride"))
     UpdateRoutingControlStateRequest.struct_class = Types::UpdateRoutingControlStateRequest
 
     UpdateRoutingControlStateResponse.struct_class = Types::UpdateRoutingControlStateResponse
 
     UpdateRoutingControlStatesRequest.add_member(:update_routing_control_state_entries, Shapes::ShapeRef.new(shape: UpdateRoutingControlStateEntries, required: true, location_name: "UpdateRoutingControlStateEntries"))
+    UpdateRoutingControlStatesRequest.add_member(:safety_rules_to_override, Shapes::ShapeRef.new(shape: Arns, location_name: "SafetyRulesToOverride"))
     UpdateRoutingControlStatesRequest.struct_class = Types::UpdateRoutingControlStatesRequest
 
     UpdateRoutingControlStatesResponse.struct_class = Types::UpdateRoutingControlStatesResponse

data/lib/aws-sdk-route53recoverycluster/types.rb

@@ -157,7 +157,7 @@ module Aws::Route53RecoveryCluster
       include Aws::Structure
     end
 
-    # A routing control state.
+    # A routing control state entry.
     #
     # @note When making an API call, you may pass UpdateRoutingControlStateEntry
     #   data as a hash:
@@ -168,8 +168,7 @@ module Aws::Route53RecoveryCluster
     #       }
     #
     # @!attribute [rw] routing_control_arn
-    #   The Amazon Resource Number (ARN) for the routing control state
-    #   entry.
+    #   The Amazon Resource Number (ARN) for a routing control state entry.
     #   @return [String]
     #
     # @!attribute [rw] routing_control_state
@@ -191,6 +190,7 @@ module Aws::Route53RecoveryCluster
     #       {
     #         routing_control_arn: "Arn", # required
     #         routing_control_state: "On", # required, accepts On, Off
+    #         safety_rules_to_override: ["Arn"],
     #       }
     #
     # @!attribute [rw] routing_control_arn
@@ -203,11 +203,27 @@ module Aws::Route53RecoveryCluster
     #   Off.
     #   @return [String]
     #
+    # @!attribute [rw] safety_rules_to_override
+    #   The Amazon Resource Numbers (ARNs) for the safety rules that you
+    #   want to override when you're updating the state of a routing
+    #   control. You can override one safety rule or multiple safety rules
+    #   by including one or more ARNs, separated by commas.
+    #
+    #   For more information, see [ Override safety rules to reroute
+    #   traffic][1] in the Amazon Route 53 Application Recovery Controller
+    #   Developer Guide.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html
+    #   @return [Array<String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02/UpdateRoutingControlStateRequest AWS API Documentation
     #
     class UpdateRoutingControlStateRequest < Struct.new(
       :routing_control_arn,
-      :routing_control_state)
+      :routing_control_state,
+      :safety_rules_to_override)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -226,16 +242,33 @@ module Aws::Route53RecoveryCluster
     #             routing_control_state: "On", # required, accepts On, Off
     #           },
     #         ],
+    #         safety_rules_to_override: ["Arn"],
     #       }
     #
     # @!attribute [rw] update_routing_control_state_entries
     #   A set of routing control entries that you want to update.
     #   @return [Array<Types::UpdateRoutingControlStateEntry>]
     #
+    # @!attribute [rw] safety_rules_to_override
+    #   The Amazon Resource Numbers (ARNs) for the safety rules that you
+    #   want to override when you're updating routing control states. You
+    #   can override one safety rule or multiple safety rules by including
+    #   one or more ARNs, separated by commas.
+    #
+    #   For more information, see [ Override safety rules to reroute
+    #   traffic][1] in the Amazon Route 53 Application Recovery Controller
+    #   Developer Guide.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html
+    #   @return [Array<String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02/UpdateRoutingControlStatesRequest AWS API Documentation
     #
     class UpdateRoutingControlStatesRequest < Struct.new(
-      :update_routing_control_state_entries)
+      :update_routing_control_state_entries,
+      :safety_rules_to_override)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-route53recoverycluster.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-route53recoverycluster/customizations'
 # @!group service
 module Aws::Route53RecoveryCluster
 
-  GEM_VERSION = '1.9.0'
+  GEM_VERSION = '1.10.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-route53recoverycluster
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core