Class: Aws::Route53RecoveryReadiness::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Route53RecoveryReadiness::Client
- Includes:
- ClientStubs
- Defined in:
- 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](/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
-
#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.
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.
444 445 446 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 444 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.
1740 1741 1742 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1740 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.
1743 1744 1745 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1743 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.
1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1713 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::Route53RecoveryReadiness') ) 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-route53recoveryreadiness' context[:gem_version] = '1.34.0' Seahorse::Client::Request.new(handlers, context) end |
#create_cell(params = {}) ⇒ Types::CreateCellResponse
Creates a cell in an account.
492 493 494 495 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 492 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.
523 524 525 526 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 523 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.
570 571 572 573 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 570 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.
616 617 618 619 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 616 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.
698 699 700 701 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 698 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.
720 721 722 723 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 720 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.
741 742 743 744 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 741 def (params = {}, = {}) req = build_request(:delete_cross_account_authorization, params) req.send_request() end |
#delete_readiness_check(params = {}) ⇒ Struct
Deletes a readiness check.
762 763 764 765 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 762 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.
783 784 785 786 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 783 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.
804 805 806 807 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 804 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.
843 844 845 846 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 843 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.
883 884 885 886 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 883 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.
925 926 927 928 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 925 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.
959 960 961 962 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 959 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.
1009 1010 1011 1012 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1009 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.
1058 1059 1060 1061 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1058 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.
1094 1095 1096 1097 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1094 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.
1137 1138 1139 1140 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1137 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.
1185 1186 1187 1188 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1185 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.
1227 1228 1229 1230 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1227 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.
1263 1264 1265 1266 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1263 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.
1302 1303 1304 1305 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1302 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.
1342 1343 1344 1345 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1342 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.
1393 1394 1395 1396 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1393 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.
1434 1435 1436 1437 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1434 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.
1462 1463 1464 1465 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1462 def (params = {}, = {}) req = build_request(:list_tags_for_resources, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds a tag to a resource.
1489 1490 1491 1492 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1489 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a resource.
1513 1514 1515 1516 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1513 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.
1555 1556 1557 1558 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1555 def update_cell(params = {}, = {}) req = build_request(:update_cell, params) req.send_request() end |
#update_readiness_check(params = {}) ⇒ Types::UpdateReadinessCheckResponse
Updates a readiness check.
1592 1593 1594 1595 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1592 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.
1630 1631 1632 1633 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1630 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.
1704 1705 1706 1707 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1704 def update_resource_set(params = {}, = {}) req = build_request(:update_resource_set, 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.
1733 1734 1735 |
# File 'lib/aws-sdk-route53recoveryreadiness/client.rb', line 1733 def waiter_names [] end |