Class: Aws::Route53RecoveryReadiness::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Route53RecoveryReadiness::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb
Overview
An API client for Route53RecoveryReadiness. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Route53RecoveryReadiness::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
-
#create_cell(params = {}) ⇒ Types::CreateCellResponse
Creates a cell in an account.
-
#create_cross_account_authorization(params = {}) ⇒ Types::CreateCrossAccountAuthorizationResponse
Creates a cross-account readiness authorization.
-
#create_readiness_check(params = {}) ⇒ Types::CreateReadinessCheckResponse
Creates a readiness check in an account.
-
#create_recovery_group(params = {}) ⇒ Types::CreateRecoveryGroupResponse
Creates a recovery group in an account.
-
#create_resource_set(params = {}) ⇒ Types::CreateResourceSetResponse
Creates a resource set.
-
#delete_cell(params = {}) ⇒ Struct
Delete a cell.
-
#delete_cross_account_authorization(params = {}) ⇒ Struct
Deletes cross account readiness authorization.
-
#delete_readiness_check(params = {}) ⇒ Struct
Deletes a readiness check.
-
#delete_recovery_group(params = {}) ⇒ Struct
Deletes a recovery group.
-
#delete_resource_set(params = {}) ⇒ Struct
Deletes a resource set.
-
#get_architecture_recommendations(params = {}) ⇒ Types::GetArchitectureRecommendationsResponse
Gets recommendations about architecture designs for improving resiliency for an application, based on a recovery group.
-
#get_cell(params = {}) ⇒ Types::GetCellResponse
Gets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of nested cells for this cell, and a list of those cell ARNs with their associated recovery group ARNs.
-
#get_cell_readiness_summary(params = {}) ⇒ Types::GetCellReadinessSummaryResponse
Gets readiness for a cell.
-
#get_readiness_check(params = {}) ⇒ Types::GetReadinessCheckResponse
Gets details about a readiness check.
-
#get_readiness_check_resource_status(params = {}) ⇒ Types::GetReadinessCheckResourceStatusResponse
Gets individual readiness status for a readiness check.
-
#get_readiness_check_status(params = {}) ⇒ Types::GetReadinessCheckStatusResponse
Gets the readiness status for an individual readiness check.
-
#get_recovery_group(params = {}) ⇒ Types::GetRecoveryGroupResponse
Gets details about a recovery group, including a list of the cells that are included in it.
-
#get_recovery_group_readiness_summary(params = {}) ⇒ Types::GetRecoveryGroupReadinessSummaryResponse
Displays a summary of information about a recovery group's readiness status.
-
#get_resource_set(params = {}) ⇒ Types::GetResourceSetResponse
Displays the details about a resource set, including a list of the resources in the set.
-
#list_cells(params = {}) ⇒ Types::ListCellsResponse
Lists the cells for an account.
-
#list_cross_account_authorizations(params = {}) ⇒ Types::ListCrossAccountAuthorizationsResponse
Lists the cross-account readiness authorizations that are in place for an account.
-
#list_readiness_checks(params = {}) ⇒ Types::ListReadinessChecksResponse
Lists the readiness checks for an account.
-
#list_recovery_groups(params = {}) ⇒ Types::ListRecoveryGroupsResponse
Lists the recovery groups in an account.
-
#list_resource_sets(params = {}) ⇒ Types::ListResourceSetsResponse
Lists the resource sets in an account.
-
#list_rules(params = {}) ⇒ Types::ListRulesResponse
Lists all readiness rules, or lists the readiness rules for a specific resource type.
-
#list_tags_for_resources(params = {}) ⇒ Types::ListTagsForResourcesResponse
Lists the tags for a resource.
-
#tag_resource(params = {}) ⇒ Struct
Adds a tag to a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a resource.
-
#update_cell(params = {}) ⇒ Types::UpdateCellResponse
Updates a cell to replace the list of nested cells with a new list of nested cells.
-
#update_readiness_check(params = {}) ⇒ Types::UpdateReadinessCheckResponse
Updates a readiness check.
-
#update_recovery_group(params = {}) ⇒ Types::UpdateRecoveryGroupResponse
Updates a recovery group.
-
#update_resource_set(params = {}) ⇒ Types::UpdateResourceSetResponse
Updates a resource set.
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.
410 411 412 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#create_cell(params = {}) ⇒ Types::CreateCellResponse
Creates a cell in an account.
458 459 460 461 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 458 def create_cell(params = {}, = {}) req = build_request(:create_cell, params) req.send_request() end |
#create_cross_account_authorization(params = {}) ⇒ Types::CreateCrossAccountAuthorizationResponse
Creates a cross-account readiness authorization. This lets you authorize another account to work with Route 53 Application Recovery Controller, for example, to check the readiness status of resources in a separate account.
489 490 491 492 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 489 def (params = {}, = {}) req = build_request(:create_cross_account_authorization, params) req.send_request() end |
#create_readiness_check(params = {}) ⇒ Types::CreateReadinessCheckResponse
Creates a readiness check in an account. A readiness check monitors a resource set in your application, such as a set of Amazon Aurora instances, that Application Recovery Controller is auditing recovery readiness for. The audits run once every minute on every resource that's associated with a readiness check.
536 537 538 539 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 536 def create_readiness_check(params = {}, = {}) req = build_request(:create_readiness_check, params) req.send_request() end |
#create_recovery_group(params = {}) ⇒ Types::CreateRecoveryGroupResponse
Creates a recovery group in an account. A recovery group corresponds to an application and includes a list of the cells that make up the application.
582 583 584 585 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 582 def create_recovery_group(params = {}, = {}) req = build_request(:create_recovery_group, params) req.send_request() end |
#create_resource_set(params = {}) ⇒ Types::CreateResourceSetResponse
Creates a resource set. A resource set is a set of resources of one type that span multiple cells. You can associate a resource set with a readiness check to monitor the resources for failover readiness.
664 665 666 667 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 664 def create_resource_set(params = {}, = {}) req = build_request(:create_resource_set, params) req.send_request() end |
#delete_cell(params = {}) ⇒ Struct
Delete a cell. When successful, the response code is 204, with no response body.
686 687 688 689 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 686 def delete_cell(params = {}, = {}) req = build_request(:delete_cell, params) req.send_request() end |
#delete_cross_account_authorization(params = {}) ⇒ Struct
Deletes cross account readiness authorization.
707 708 709 710 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 707 def (params = {}, = {}) req = build_request(:delete_cross_account_authorization, params) req.send_request() end |
#delete_readiness_check(params = {}) ⇒ Struct
Deletes a readiness check.
728 729 730 731 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 728 def delete_readiness_check(params = {}, = {}) req = build_request(:delete_readiness_check, params) req.send_request() end |
#delete_recovery_group(params = {}) ⇒ Struct
Deletes a recovery group.
749 750 751 752 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 749 def delete_recovery_group(params = {}, = {}) req = build_request(:delete_recovery_group, params) req.send_request() end |
#delete_resource_set(params = {}) ⇒ Struct
Deletes a resource set.
770 771 772 773 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 770 def delete_resource_set(params = {}, = {}) req = build_request(:delete_resource_set, params) req.send_request() end |
#get_architecture_recommendations(params = {}) ⇒ Types::GetArchitectureRecommendationsResponse
Gets recommendations about architecture designs for improving resiliency for an application, based on a recovery group.
809 810 811 812 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 809 def get_architecture_recommendations(params = {}, = {}) req = build_request(:get_architecture_recommendations, params) req.send_request() end |
#get_cell(params = {}) ⇒ Types::GetCellResponse
Gets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of nested cells for this cell, and a list of those cell ARNs with their associated recovery group ARNs.
849 850 851 852 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 849 def get_cell(params = {}, = {}) req = build_request(:get_cell, params) req.send_request() end |
#get_cell_readiness_summary(params = {}) ⇒ Types::GetCellReadinessSummaryResponse
Gets readiness for a cell. Aggregates the readiness of all the resources that are associated with the cell into a single value.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
891 892 893 894 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 891 def get_cell_readiness_summary(params = {}, = {}) req = build_request(:get_cell_readiness_summary, params) req.send_request() end |
#get_readiness_check(params = {}) ⇒ Types::GetReadinessCheckResponse
Gets details about a readiness check.
925 926 927 928 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 925 def get_readiness_check(params = {}, = {}) req = build_request(:get_readiness_check, params) req.send_request() end |
#get_readiness_check_resource_status(params = {}) ⇒ Types::GetReadinessCheckResourceStatusResponse
Gets individual readiness status for a readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in the recovery group, use GetRecoveryGroupReadinessSummary.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
975 976 977 978 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 975 def get_readiness_check_resource_status(params = {}, = {}) req = build_request(:get_readiness_check_resource_status, params) req.send_request() end |
#get_readiness_check_status(params = {}) ⇒ Types::GetReadinessCheckStatusResponse
Gets the readiness status for an individual readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in a recovery group, use GetRecoveryGroupReadinessSummary.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1024 1025 1026 1027 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1024 def get_readiness_check_status(params = {}, = {}) req = build_request(:get_readiness_check_status, params) req.send_request() end |
#get_recovery_group(params = {}) ⇒ Types::GetRecoveryGroupResponse
Gets details about a recovery group, including a list of the cells that are included in it.
1060 1061 1062 1063 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1060 def get_recovery_group(params = {}, = {}) req = build_request(:get_recovery_group, params) req.send_request() end |
#get_recovery_group_readiness_summary(params = {}) ⇒ Types::GetRecoveryGroupReadinessSummaryResponse
Displays a summary of information about a recovery group's readiness status. Includes the readiness checks for resources in the recovery group and the readiness status of each one.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1103 1104 1105 1106 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1103 def get_recovery_group_readiness_summary(params = {}, = {}) req = build_request(:get_recovery_group_readiness_summary, params) req.send_request() end |
#get_resource_set(params = {}) ⇒ Types::GetResourceSetResponse
Displays the details about a resource set, including a list of the resources in the set.
1151 1152 1153 1154 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1151 def get_resource_set(params = {}, = {}) req = build_request(:get_resource_set, params) req.send_request() end |
#list_cells(params = {}) ⇒ Types::ListCellsResponse
Lists the cells for an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1193 1194 1195 1196 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1193 def list_cells(params = {}, = {}) req = build_request(:list_cells, params) req.send_request() end |
#list_cross_account_authorizations(params = {}) ⇒ Types::ListCrossAccountAuthorizationsResponse
Lists the cross-account readiness authorizations that are in place for an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1229 1230 1231 1232 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1229 def (params = {}, = {}) req = build_request(:list_cross_account_authorizations, params) req.send_request() end |
#list_readiness_checks(params = {}) ⇒ Types::ListReadinessChecksResponse
Lists the readiness checks for an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1268 1269 1270 1271 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1268 def list_readiness_checks(params = {}, = {}) req = build_request(:list_readiness_checks, params) req.send_request() end |
#list_recovery_groups(params = {}) ⇒ Types::ListRecoveryGroupsResponse
Lists the recovery groups in an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1308 1309 1310 1311 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1308 def list_recovery_groups(params = {}, = {}) req = build_request(:list_recovery_groups, params) req.send_request() end |
#list_resource_sets(params = {}) ⇒ Types::ListResourceSetsResponse
Lists the resource sets in an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1359 1360 1361 1362 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1359 def list_resource_sets(params = {}, = {}) req = build_request(:list_resource_sets, params) req.send_request() end |
#list_rules(params = {}) ⇒ Types::ListRulesResponse
Lists all readiness rules, or lists the readiness rules for a specific resource type.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1400 1401 1402 1403 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1400 def list_rules(params = {}, = {}) req = build_request(:list_rules, params) req.send_request() end |
#list_tags_for_resources(params = {}) ⇒ Types::ListTagsForResourcesResponse
Lists the tags for a resource.
1428 1429 1430 1431 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1428 def (params = {}, = {}) req = build_request(:list_tags_for_resources, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds a tag to a resource.
1455 1456 1457 1458 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1455 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a resource.
1479 1480 1481 1482 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1479 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_cell(params = {}) ⇒ Types::UpdateCellResponse
Updates a cell to replace the list of nested cells with a new list of nested cells.
1521 1522 1523 1524 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1521 def update_cell(params = {}, = {}) req = build_request(:update_cell, params) req.send_request() end |
#update_readiness_check(params = {}) ⇒ Types::UpdateReadinessCheckResponse
Updates a readiness check.
1558 1559 1560 1561 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1558 def update_readiness_check(params = {}, = {}) req = build_request(:update_readiness_check, params) req.send_request() end |
#update_recovery_group(params = {}) ⇒ Types::UpdateRecoveryGroupResponse
Updates a recovery group.
1596 1597 1598 1599 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1596 def update_recovery_group(params = {}, = {}) req = build_request(:update_recovery_group, params) req.send_request() end |
#update_resource_set(params = {}) ⇒ Types::UpdateResourceSetResponse
Updates a resource set.
1670 1671 1672 1673 |
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1670 def update_resource_set(params = {}, = {}) req = build_request(:update_resource_set, params) req.send_request() end |