Class: Aws::ARCZonalShift::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ARCZonalShift::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb
Overview
An API client for ARCZonalShift. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ARCZonalShift::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#cancel_zonal_shift(params = {}) ⇒ Types::ZonalShift
Cancel a zonal shift in Amazon Route 53 Application Recovery Controller.
-
#create_practice_run_configuration(params = {}) ⇒ Types::CreatePracticeRunConfigurationResponse
A practice run configuration for zonal autoshift is required when you enable zonal autoshift.
-
#delete_practice_run_configuration(params = {}) ⇒ Types::DeletePracticeRunConfigurationResponse
Deletes the practice run configuration for a resource.
-
#get_managed_resource(params = {}) ⇒ Types::GetManagedResourceResponse
Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region.
-
#list_autoshifts(params = {}) ⇒ Types::ListAutoshiftsResponse
Returns the active autoshifts for a specified resource.
-
#list_managed_resources(params = {}) ⇒ Types::ListManagedResourcesResponse
Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them.
-
#list_zonal_shifts(params = {}) ⇒ Types::ListZonalShiftsResponse
Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region.
-
#start_zonal_shift(params = {}) ⇒ Types::ZonalShift
You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone.
-
#update_practice_run_configuration(params = {}) ⇒ Types::UpdatePracticeRunConfigurationResponse
Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.
-
#update_zonal_autoshift_configuration(params = {}) ⇒ Types::UpdateZonalAutoshiftConfigurationResponse
You can update the zonal autoshift status for a resource, to enable or disable zonal autoshift.
-
#update_zonal_shift(params = {}) ⇒ Types::ZonalShift
Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#cancel_zonal_shift(params = {}) ⇒ Types::ZonalShift
Cancel a zonal shift in Amazon Route 53 Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID.
A zonal shift can be one that you've started for a resource in your Amazon Web Services account in an Amazon Web Services Region, or it can be a zonal shift started by a practice run with zonal autoshift.
431 432 433 434 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 431 def cancel_zonal_shift(params = {}, = {}) req = build_request(:cancel_zonal_shift, params) req.send_request() end |
#create_practice_run_configuration(params = {}) ⇒ Types::CreatePracticeRunConfigurationResponse
A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting.
For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
552 553 554 555 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 552 def create_practice_run_configuration(params = {}, = {}) req = build_request(:create_practice_run_configuration, params) req.send_request() end |
#delete_practice_run_configuration(params = {}) ⇒ Types::DeletePracticeRunConfigurationResponse
Deletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.
589 590 591 592 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 589 def delete_practice_run_configuration(params = {}, = {}) req = build_request(:delete_practice_run_configuration, params) req.send_request() end |
#get_managed_resource(params = {}) ⇒ Types::GetManagedResourceResponse
Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC. You can start zonal shifts and configure zonal autoshift for managed resources.
At this time, you can only start a zonal shift or configure zonal autoshift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
662 663 664 665 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 662 def get_managed_resource(params = {}, = {}) req = build_request(:get_managed_resource, params) req.send_request() end |
#list_autoshifts(params = {}) ⇒ Types::ListAutoshiftsResponse
Returns the active autoshifts for a specified resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
710 711 712 713 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 710 def list_autoshifts(params = {}, = {}) req = build_request(:list_autoshifts, params) req.send_request() end |
#list_managed_resources(params = {}) ⇒ Types::ListManagedResourcesResponse
Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and the resource name.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
776 777 778 779 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 776 def list_managed_resources(params = {}, = {}) req = build_request(:list_managed_resources, params) req.send_request() end |
#list_zonal_shifts(params = {}) ⇒ Types::ListZonalShiftsResponse
Lists all active and completed zonal shifts in Amazon Route 53
Application Recovery Controller in your Amazon Web Services account in
this Amazon Web Services Region. ListZonalShifts
returns
customer-started zonal shifts, as well as practice run zonal shifts
that Route 53 ARC started on your behalf for zonal autoshift.
The ListZonalShifts
operation does not list autoshifts. For more
information about listing autoshifts, see ">ListAutoshifts.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
854 855 856 857 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 854 def list_zonal_shifts(params = {}, = {}) req = build_request(:list_zonal_shifts, params) req.send_request() end |
#start_zonal_shift(params = {}) ⇒ Types::ZonalShift
You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with Route 53 ARC by Amazon Web Services services.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The zonal shift is created immediately in Route 53 ARC. However, it can take a short time, typically up to a few minutes, for existing, in-progress connections in the Availability Zone to complete.
For more information, see Zonal shift in the Amazon Route 53 Application Recovery Controller Developer Guide.
957 958 959 960 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 957 def start_zonal_shift(params = {}, = {}) req = build_request(:start_zonal_shift, params) req.send_request() end |
#update_practice_run_configuration(params = {}) ⇒ Types::UpdatePracticeRunConfigurationResponse
Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.
1056 1057 1058 1059 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 1056 def update_practice_run_configuration(params = {}, = {}) req = build_request(:update_practice_run_configuration, params) req.send_request() end |
#update_zonal_autoshift_configuration(params = {}) ⇒ Types::UpdateZonalAutoshiftConfigurationResponse
You can update the zonal autoshift status for a resource, to enable or
disable zonal autoshift. When zonal autoshift is ENABLED
, Amazon Web
Services shifts away resource traffic from an Availability Zone, on
your behalf, when Amazon Web Services determines that there's an
issue in the Availability Zone that could potentially affect
customers.
1098 1099 1100 1101 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 1098 def update_zonal_autoshift_configuration(params = {}, = {}) req = build_request(:update_zonal_autoshift_configuration, params) req.send_request() end |
#update_zonal_shift(params = {}) ⇒ Types::ZonalShift
Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.
1169 1170 1171 1172 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 1169 def update_zonal_shift(params = {}, = {}) req = build_request(:update_zonal_shift, params) req.send_request() end |