Class: Aws::Route53RecoveryCluster::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Route53RecoveryCluster::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-route53recoverycluster/client.rb
Overview
An API client for Route53RecoveryCluster. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::Route53RecoveryCluster::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#get_routing_control_state(params = {}) ⇒ Types::GetRoutingControlStateResponse
Get the state for a routing control.
-
#list_routing_controls(params = {}) ⇒ Types::ListRoutingControlsResponse
List routing control names and Amazon Resource Names (ARNs), as well as the routing control state for each routing control, along with the control panel name and control panel ARN for the routing controls.
-
#update_routing_control_state(params = {}) ⇒ Struct
Set the state of the routing control to reroute traffic.
-
#update_routing_control_states(params = {}) ⇒ Struct
Set multiple routing control states.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
441 442 443 |
# File 'lib/aws-sdk-route53recoverycluster/client.rb', line 441 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
788 789 790 |
# File 'lib/aws-sdk-route53recoverycluster/client.rb', line 788 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
791 792 793 |
# File 'lib/aws-sdk-route53recoverycluster/client.rb', line 791 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 |
# File 'lib/aws-sdk-route53recoverycluster/client.rb', line 761 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::Route53RecoveryCluster') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-route53recoverycluster' context[:gem_version] = '1.32.0' Seahorse::Client::Request.new(handlers, context) end |
#get_routing_control_state(params = {}) ⇒ Types::GetRoutingControlStateResponse
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 a routing control state is set to ON, traffic flows to a cell. When the state is set to OFF, traffic does not flow.
Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see [ Create routing control structures] in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application.
*You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC.*
To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see [API examples] 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:
- Viewing and updating routing control states][3
- Working with routing controls in Route 53 ARC][4
[1]: docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html [2]: docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html [3]: docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html [4]: docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html
508 509 510 511 |
# File 'lib/aws-sdk-route53recoverycluster/client.rb', line 508 def get_routing_control_state(params = {}, = {}) req = build_request(:get_routing_control_state, params) req.send_request() end |
#list_routing_controls(params = {}) ⇒ Types::ListRoutingControlsResponse
List routing control names and Amazon Resource Names (ARNs), as well as the routing control state for each routing control, along with the control panel name and control panel ARN for the routing controls. If you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists all the routing controls in the cluster.
A routing control is a simple on/off switch in Route 53 ARC that you can use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When the state is set to OFF, traffic does not flow.
Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see [ Create routing control structures] in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application.
*You must specify Regional endpoints when you work with API cluster operations to use this API operation to list routing controls in Route 53 ARC.*
Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide:
- Viewing and updating routing control states][2
- Working with routing controls in Route 53 ARC][3
[1]: docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html [2]: docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html [3]: docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
592 593 594 595 |
# File 'lib/aws-sdk-route53recoverycluster/client.rb', line 592 def list_routing_controls(params = {}, = {}) req = build_request(:list_routing_controls, params) req.send_request() end |
#update_routing_control_state(params = {}) ⇒ Struct
Set the state of the routing control to reroute traffic. You can set the value to ON or OFF. When the state is ON, traffic flows to a cell. When the state is OFF, traffic does not flow.
With Route 53 ARC, 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] 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 Route 53 ARC.*
To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see [API examples] in the Amazon Route 53 Application Recovery Controller Developer Guide.
- Viewing and updating routing control states][3
- Working with routing controls overall][4
[1]: docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html [2]: docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html [3]: docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html [4]: docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html
672 673 674 675 |
# File 'lib/aws-sdk-route53recoverycluster/client.rb', line 672 def update_routing_control_state(params = {}, = {}) req = build_request(:update_routing_control_state, params) req.send_request() end |
#update_routing_control_states(params = {}) ⇒ Struct
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.
With Route 53 ARC, 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] 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 Route 53 ARC.*
To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see [API examples] in the Amazon Route 53 Application Recovery Controller Developer Guide.
- Viewing and updating routing control states][3
- Working with routing controls overall][4
[1]: docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html [2]: docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html [3]: docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html [4]: docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html
752 753 754 755 |
# File 'lib/aws-sdk-route53recoverycluster/client.rb', line 752 def update_routing_control_states(params = {}, = {}) req = build_request(:update_routing_control_states, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
781 782 783 |
# File 'lib/aws-sdk-route53recoverycluster/client.rb', line 781 def waiter_names [] end |