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 that you've started for a resource in your AWS account in an AWS Region.
-
#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 AWS Region.
-
#list_managed_resources(params = {}) ⇒ Types::ListManagedResourcesResponse
Lists all the resources in your AWS account in this AWS 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 the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.
-
#start_zonal_shift(params = {}) ⇒ Types::ZonalShift
You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone.
-
#update_zonal_shift(params = {}) ⇒ Types::ZonalShift
Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your AWS 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 that you've started for a resource in your AWS account in an AWS Region.
428 429 430 431 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 428 def cancel_zonal_shift(params = {}, = {}) req = build_request(:cancel_zonal_shift, 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 AWS Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC.
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.
482 483 484 485 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 482 def get_managed_resource(params = {}, = {}) req = build_request(:get_managed_resource, params) req.send_request() end |
#list_managed_resources(params = {}) ⇒ Types::ListManagedResourcesResponse
Lists all the resources in your AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes their Amazon Resource Names (ARNs), the Availability Zones the resources are deployed in, and the resource name.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
530 531 532 533 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 530 def list_managed_resources(params = {}, = {}) req = build_request(:list_managed_resources, params) req.send_request() end |
#list_zonal_shifts(params = {}) ⇒ Types::ListZonalShiftsResponse
Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
591 592 593 594 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 591 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 a AWS Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your account in an AWS Region. Resources are automatically registered with Route 53 ARC by AWS 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.
689 690 691 692 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 689 def start_zonal_shift(params = {}, = {}) req = build_request(:start_zonal_shift, 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 AWS account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.
759 760 761 762 |
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/client.rb', line 759 def update_zonal_shift(params = {}, = {}) req = build_request(:update_zonal_shift, params) req.send_request() end |