AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::Route53RecoveryReadiness::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



324
325
326
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 324

def initialize(*args)
  super
end

Instance Method Details

#create_cell(params = {}) ⇒ Types::CreateCellResponse

Creates a new Cell.

Examples:

Request syntax with placeholder values


resp = client.create_cell({
  cell_name: "__string", # required
  cells: ["__string"],
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.cell_arn #=> String
resp.cell_name #=> String
resp.cells #=> Array
resp.cells[0] #=> String
resp.parent_readiness_scopes #=> Array
resp.parent_readiness_scopes[0] #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cell_name (required, String)
  • :cells (Array<String>)
  • :tags (Hash<String,String>)

    A collection of tags associated with a resource

Returns:

See Also:



372
373
374
375
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 372

def create_cell(params = {}, options = {})
  req = build_request(:create_cell, params)
  req.send_request(options)
end

#create_cross_account_authorization(params = {}) ⇒ Types::CreateCrossAccountAuthorizationResponse

Create a new cross account readiness authorization.

Examples:

Request syntax with placeholder values


resp = client.({
  cross_account_authorization: "CrossAccountAuthorization", # required
})

Response structure


resp. #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cross_account_authorization (required, String)

    A cross-account authorization, e.g. arn:aws:iam::123456789012:root

Returns:

See Also:



400
401
402
403
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 400

def (params = {}, options = {})
  req = build_request(:create_cross_account_authorization, params)
  req.send_request(options)
end

#create_readiness_check(params = {}) ⇒ Types::CreateReadinessCheckResponse

Creates a new Readiness Check.

Examples:

Request syntax with placeholder values


resp = client.create_readiness_check({
  readiness_check_name: "__string", # required
  resource_set_name: "__string", # required
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.readiness_check_arn #=> String
resp.readiness_check_name #=> String
resp.resource_set #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :readiness_check_name (required, String)
  • :resource_set_name (required, String)
  • :tags (Hash<String,String>)

    A collection of tags associated with a resource

Returns:

See Also:



443
444
445
446
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 443

def create_readiness_check(params = {}, options = {})
  req = build_request(:create_readiness_check, params)
  req.send_request(options)
end

#create_recovery_group(params = {}) ⇒ Types::CreateRecoveryGroupResponse

Creates a new Recovery Group.

Examples:

Request syntax with placeholder values


resp = client.create_recovery_group({
  cells: ["__string"],
  recovery_group_name: "__string", # required
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.cells #=> Array
resp.cells[0] #=> String
resp.recovery_group_arn #=> String
resp.recovery_group_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cells (Array<String>)
  • :recovery_group_name (required, String)
  • :tags (Hash<String,String>)

    A collection of tags associated with a resource

Returns:

See Also:



487
488
489
490
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 487

def create_recovery_group(params = {}, options = {})
  req = build_request(:create_recovery_group, params)
  req.send_request(options)
end

#create_resource_set(params = {}) ⇒ Types::CreateResourceSetResponse

Creates a new Resource Set.

Examples:

Request syntax with placeholder values


resp = client.create_resource_set({
  resource_set_name: "__string", # required
  resource_set_type: "__stringPatternAWSAZaZ09AZaZ09", # required
  resources: [ # required
    {
      component_id: "__string",
      dns_target_resource: {
        domain_name: "__string",
        hosted_zone_arn: "__string",
        record_set_id: "__string",
        record_type: "__string",
        target_resource: {
          nlb_resource: {
            arn: "__string",
          },
          r53_resource: {
            domain_name: "__string",
            record_set_id: "__string",
          },
        },
      },
      readiness_scopes: ["__string"],
      resource_arn: "__string",
    },
  ],
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.resource_set_arn #=> String
resp.resource_set_name #=> String
resp.resource_set_type #=> String
resp.resources #=> Array
resp.resources[0].component_id #=> String
resp.resources[0].dns_target_resource.domain_name #=> String
resp.resources[0].dns_target_resource.hosted_zone_arn #=> String
resp.resources[0].dns_target_resource.record_set_id #=> String
resp.resources[0].dns_target_resource.record_type #=> String
resp.resources[0].dns_target_resource.target_resource.nlb_resource.arn #=> String
resp.resources[0].dns_target_resource.target_resource.r53_resource.domain_name #=> String
resp.resources[0].dns_target_resource.target_resource.r53_resource.record_set_id #=> String
resp.resources[0].readiness_scopes #=> Array
resp.resources[0].readiness_scopes[0] #=> String
resp.resources[0].resource_arn #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_set_name (required, String)
  • :resource_set_type (required, String)
  • :resources (required, Array<Types::Resource>)
  • :tags (Hash<String,String>)

    A collection of tags associated with a resource

Returns:

See Also:



567
568
569
570
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 567

def create_resource_set(params = {}, options = {})
  req = build_request(:create_resource_set, params)
  req.send_request(options)
end

#delete_cell(params = {}) ⇒ Struct

Deletes an existing Cell.

Examples:

Request syntax with placeholder values


resp = client.delete_cell({
  cell_name: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cell_name (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



588
589
590
591
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 588

def delete_cell(params = {}, options = {})
  req = build_request(:delete_cell, params)
  req.send_request(options)
end

#delete_cross_account_authorization(params = {}) ⇒ Struct

Delete cross account readiness authorization

Examples:

Request syntax with placeholder values


resp = client.({
  cross_account_authorization: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cross_account_authorization (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



609
610
611
612
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 609

def (params = {}, options = {})
  req = build_request(:delete_cross_account_authorization, params)
  req.send_request(options)
end

#delete_readiness_check(params = {}) ⇒ Struct

Deletes an existing Readiness Check.

Examples:

Request syntax with placeholder values


resp = client.delete_readiness_check({
  readiness_check_name: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :readiness_check_name (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



630
631
632
633
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 630

def delete_readiness_check(params = {}, options = {})
  req = build_request(:delete_readiness_check, params)
  req.send_request(options)
end

#delete_recovery_group(params = {}) ⇒ Struct

Deletes an existing Recovery Group.

Examples:

Request syntax with placeholder values


resp = client.delete_recovery_group({
  recovery_group_name: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :recovery_group_name (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



651
652
653
654
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 651

def delete_recovery_group(params = {}, options = {})
  req = build_request(:delete_recovery_group, params)
  req.send_request(options)
end

#delete_resource_set(params = {}) ⇒ Struct

Deletes an existing Resource Set.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_set({
  resource_set_name: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_set_name (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



672
673
674
675
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 672

def delete_resource_set(params = {}, options = {})
  req = build_request(:delete_resource_set, params)
  req.send_request(options)
end

#get_architecture_recommendations(params = {}) ⇒ Types::GetArchitectureRecommendationsResponse

Returns a collection of recommendations to improve resilliance and readiness check quality for a Recovery Group.

Examples:

Request syntax with placeholder values


resp = client.get_architecture_recommendations({
  max_results: 1,
  next_token: "__string",
  recovery_group_name: "__string", # required
})

Response structure


resp.last_audit_timestamp #=> Time
resp.next_token #=> String
resp.recommendations #=> Array
resp.recommendations[0].recommendation_text #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)
  • :recovery_group_name (required, String)

Returns:

See Also:



711
712
713
714
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 711

def get_architecture_recommendations(params = {}, options = {})
  req = build_request(:get_architecture_recommendations, params)
  req.send_request(options)
end

#get_cell(params = {}) ⇒ Types::GetCellResponse

Returns information about a Cell.

Examples:

Request syntax with placeholder values


resp = client.get_cell({
  cell_name: "__string", # required
})

Response structure


resp.cell_arn #=> String
resp.cell_name #=> String
resp.cells #=> Array
resp.cells[0] #=> String
resp.parent_readiness_scopes #=> Array
resp.parent_readiness_scopes[0] #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cell_name (required, String)

Returns:

See Also:



749
750
751
752
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 749

def get_cell(params = {}, options = {})
  req = build_request(:get_cell, params)
  req.send_request(options)
end

#get_cell_readiness_summary(params = {}) ⇒ Types::GetCellReadinessSummaryResponse

Returns information about readiness of a Cell.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_cell_readiness_summary({
  cell_name: "__string", # required
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.readiness #=> String, one of "READY", "NOT_READY", "UNKNOWN", "NOT_AUTHORIZED"
resp.readiness_checks #=> Array
resp.readiness_checks[0].readiness #=> String, one of "READY", "NOT_READY", "UNKNOWN", "NOT_AUTHORIZED"
resp.readiness_checks[0].readiness_check_name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cell_name (required, String)
  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



790
791
792
793
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 790

def get_cell_readiness_summary(params = {}, options = {})
  req = build_request(:get_cell_readiness_summary, params)
  req.send_request(options)
end

#get_readiness_check(params = {}) ⇒ Types::GetReadinessCheckResponse

Returns information about a ReadinessCheck.

Examples:

Request syntax with placeholder values


resp = client.get_readiness_check({
  readiness_check_name: "__string", # required
})

Response structure


resp.readiness_check_arn #=> String
resp.readiness_check_name #=> String
resp.resource_set #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :readiness_check_name (required, String)

Returns:

See Also:



824
825
826
827
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 824

def get_readiness_check(params = {}, options = {})
  req = build_request(:get_readiness_check, params)
  req.send_request(options)
end

#get_readiness_check_resource_status(params = {}) ⇒ Types::GetReadinessCheckResourceStatusResponse

Returns detailed information about the status of an individual resource within a Readiness Check's Resource Set.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_readiness_check_resource_status({
  max_results: 1,
  next_token: "__string",
  readiness_check_name: "__string", # required
  resource_identifier: "__string", # required
})

Response structure


resp.next_token #=> String
resp.readiness #=> String, one of "READY", "NOT_READY", "UNKNOWN", "NOT_AUTHORIZED"
resp.rules #=> Array
resp.rules[0].last_checked_timestamp #=> Time
resp.rules[0].messages #=> Array
resp.rules[0].messages[0].message_text #=> String
resp.rules[0].readiness #=> String, one of "READY", "NOT_READY", "UNKNOWN", "NOT_AUTHORIZED"
resp.rules[0].rule_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)
  • :readiness_check_name (required, String)
  • :resource_identifier (required, String)

Returns:

See Also:



872
873
874
875
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 872

def get_readiness_check_resource_status(params = {}, options = {})
  req = build_request(:get_readiness_check_resource_status, params)
  req.send_request(options)
end

#get_readiness_check_status(params = {}) ⇒ Types::GetReadinessCheckStatusResponse

Returns information about the status of a Readiness Check.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_readiness_check_status({
  max_results: 1,
  next_token: "__string",
  readiness_check_name: "__string", # required
})

Response structure


resp.messages #=> Array
resp.messages[0].message_text #=> String
resp.next_token #=> String
resp.readiness #=> String, one of "READY", "NOT_READY", "UNKNOWN", "NOT_AUTHORIZED"
resp.resources #=> Array
resp.resources[0].component_id #=> String
resp.resources[0].last_checked_timestamp #=> Time
resp.resources[0].readiness #=> String, one of "READY", "NOT_READY", "UNKNOWN", "NOT_AUTHORIZED"
resp.resources[0].resource_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)
  • :readiness_check_name (required, String)

Returns:

See Also:



918
919
920
921
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 918

def get_readiness_check_status(params = {}, options = {})
  req = build_request(:get_readiness_check_status, params)
  req.send_request(options)
end

#get_recovery_group(params = {}) ⇒ Types::GetRecoveryGroupResponse

Returns information about a Recovery Group.

Examples:

Request syntax with placeholder values


resp = client.get_recovery_group({
  recovery_group_name: "__string", # required
})

Response structure


resp.cells #=> Array
resp.cells[0] #=> String
resp.recovery_group_arn #=> String
resp.recovery_group_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :recovery_group_name (required, String)

Returns:

See Also:



953
954
955
956
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 953

def get_recovery_group(params = {}, options = {})
  req = build_request(:get_recovery_group, params)
  req.send_request(options)
end

#get_recovery_group_readiness_summary(params = {}) ⇒ Types::GetRecoveryGroupReadinessSummaryResponse

Returns information about a Recovery Group.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_recovery_group_readiness_summary({
  max_results: 1,
  next_token: "__string",
  recovery_group_name: "__string", # required
})

Response structure


resp.next_token #=> String
resp.readiness #=> String, one of "READY", "NOT_READY", "UNKNOWN", "NOT_AUTHORIZED"
resp.readiness_checks #=> Array
resp.readiness_checks[0].readiness #=> String, one of "READY", "NOT_READY", "UNKNOWN", "NOT_AUTHORIZED"
resp.readiness_checks[0].readiness_check_name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)
  • :recovery_group_name (required, String)

Returns:

See Also:



994
995
996
997
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 994

def get_recovery_group_readiness_summary(params = {}, options = {})
  req = build_request(:get_recovery_group_readiness_summary, params)
  req.send_request(options)
end

#get_resource_set(params = {}) ⇒ Types::GetResourceSetResponse

Returns information about a Resource Set.

Examples:

Request syntax with placeholder values


resp = client.get_resource_set({
  resource_set_name: "__string", # required
})

Response structure


resp.resource_set_arn #=> String
resp.resource_set_name #=> String
resp.resource_set_type #=> String
resp.resources #=> Array
resp.resources[0].component_id #=> String
resp.resources[0].dns_target_resource.domain_name #=> String
resp.resources[0].dns_target_resource.hosted_zone_arn #=> String
resp.resources[0].dns_target_resource.record_set_id #=> String
resp.resources[0].dns_target_resource.record_type #=> String
resp.resources[0].dns_target_resource.target_resource.nlb_resource.arn #=> String
resp.resources[0].dns_target_resource.target_resource.r53_resource.domain_name #=> String
resp.resources[0].dns_target_resource.target_resource.r53_resource.record_set_id #=> String
resp.resources[0].readiness_scopes #=> Array
resp.resources[0].readiness_scopes[0] #=> String
resp.resources[0].resource_arn #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_set_name (required, String)

Returns:

See Also:



1041
1042
1043
1044
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1041

def get_resource_set(params = {}, options = {})
  req = build_request(:get_resource_set, params)
  req.send_request(options)
end

#list_cells(params = {}) ⇒ Types::ListCellsResponse

Returns a collection of Cells.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_cells({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.cells #=> Array
resp.cells[0].cell_arn #=> String
resp.cells[0].cell_name #=> String
resp.cells[0].cells #=> Array
resp.cells[0].cells[0] #=> String
resp.cells[0].parent_readiness_scopes #=> Array
resp.cells[0].parent_readiness_scopes[0] #=> String
resp.cells[0].tags #=> Hash
resp.cells[0].tags["__string"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



1083
1084
1085
1086
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1083

def list_cells(params = {}, options = {})
  req = build_request(:list_cells, params)
  req.send_request(options)
end

#list_cross_account_authorizations(params = {}) ⇒ Types::ListCrossAccountAuthorizationsResponse

Returns a collection of cross account readiness authorizations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp. #=> Array
resp.[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



1118
1119
1120
1121
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1118

def (params = {}, options = {})
  req = build_request(:list_cross_account_authorizations, params)
  req.send_request(options)
end

#list_readiness_checks(params = {}) ⇒ Types::ListReadinessChecksResponse

Returns a collection of Readiness Checks.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_readiness_checks({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.readiness_checks #=> Array
resp.readiness_checks[0].readiness_check_arn #=> String
resp.readiness_checks[0].readiness_check_name #=> String
resp.readiness_checks[0].resource_set #=> String
resp.readiness_checks[0].tags #=> Hash
resp.readiness_checks[0].tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



1157
1158
1159
1160
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1157

def list_readiness_checks(params = {}, options = {})
  req = build_request(:list_readiness_checks, params)
  req.send_request(options)
end

#list_recovery_groups(params = {}) ⇒ Types::ListRecoveryGroupsResponse

Returns a collection of Recovery Groups.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_recovery_groups({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.recovery_groups #=> Array
resp.recovery_groups[0].cells #=> Array
resp.recovery_groups[0].cells[0] #=> String
resp.recovery_groups[0].recovery_group_arn #=> String
resp.recovery_groups[0].recovery_group_name #=> String
resp.recovery_groups[0].tags #=> Hash
resp.recovery_groups[0].tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



1197
1198
1199
1200
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1197

def list_recovery_groups(params = {}, options = {})
  req = build_request(:list_recovery_groups, params)
  req.send_request(options)
end

#list_resource_sets(params = {}) ⇒ Types::ListResourceSetsResponse

Returns a collection of Resource Sets.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_resource_sets({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.resource_sets #=> Array
resp.resource_sets[0].resource_set_arn #=> String
resp.resource_sets[0].resource_set_name #=> String
resp.resource_sets[0].resource_set_type #=> String
resp.resource_sets[0].resources #=> Array
resp.resource_sets[0].resources[0].component_id #=> String
resp.resource_sets[0].resources[0].dns_target_resource.domain_name #=> String
resp.resource_sets[0].resources[0].dns_target_resource.hosted_zone_arn #=> String
resp.resource_sets[0].resources[0].dns_target_resource.record_set_id #=> String
resp.resource_sets[0].resources[0].dns_target_resource.record_type #=> String
resp.resource_sets[0].resources[0].dns_target_resource.target_resource.nlb_resource.arn #=> String
resp.resource_sets[0].resources[0].dns_target_resource.target_resource.r53_resource.domain_name #=> String
resp.resource_sets[0].resources[0].dns_target_resource.target_resource.r53_resource.record_set_id #=> String
resp.resource_sets[0].resources[0].readiness_scopes #=> Array
resp.resource_sets[0].resources[0].readiness_scopes[0] #=> String
resp.resource_sets[0].resources[0].resource_arn #=> String
resp.resource_sets[0].tags #=> Hash
resp.resource_sets[0].tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



1248
1249
1250
1251
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1248

def list_resource_sets(params = {}, options = {})
  req = build_request(:list_resource_sets, params)
  req.send_request(options)
end

#list_rules(params = {}) ⇒ Types::ListRulesResponse

Returns a collection of rules that are applied as part of Readiness Checks.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_rules({
  max_results: 1,
  next_token: "__string",
  resource_type: "__string",
})

Response structure


resp.next_token #=> String
resp.rules #=> Array
resp.rules[0].resource_type #=> String
resp.rules[0].rule_description #=> String
resp.rules[0].rule_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)
  • :resource_type (String)

Returns:

See Also:



1289
1290
1291
1292
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1289

def list_rules(params = {}, options = {})
  req = build_request(:list_rules, params)
  req.send_request(options)
end

#list_tags_for_resources(params = {}) ⇒ Types::ListTagsForResourcesResponse

Returns a list of the tags assigned to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resources({
  resource_arn: "__string", # required
})

Response structure


resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

Returns:

See Also:



1317
1318
1319
1320
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1317

def list_tags_for_resources(params = {}, options = {})
  req = build_request(:list_tags_for_resources, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds tags to the specified resource. You can specify one or more tags to add.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "__string", # required
  tags: { # required
    "__string" => "__string",
  },
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)
  • :tags (required, Hash<String,String>)

    A collection of tags associated with a resource

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1345
1346
1347
1348
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1345

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes tags from the specified resource. You can specify one or more tags to remove.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "__string", # required
  tag_keys: ["__string"], # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)
  • :tag_keys (required, Array<String>)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1370
1371
1372
1373
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1370

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_cell(params = {}) ⇒ Types::UpdateCellResponse

Updates an existing Cell.

Examples:

Request syntax with placeholder values


resp = client.update_cell({
  cell_name: "__string", # required
  cells: ["__string"], # required
})

Response structure


resp.cell_arn #=> String
resp.cell_name #=> String
resp.cells #=> Array
resp.cells[0] #=> String
resp.parent_readiness_scopes #=> Array
resp.parent_readiness_scopes[0] #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cell_name (required, String)
  • :cells (required, Array<String>)

Returns:

See Also:



1411
1412
1413
1414
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1411

def update_cell(params = {}, options = {})
  req = build_request(:update_cell, params)
  req.send_request(options)
end

#update_readiness_check(params = {}) ⇒ Types::UpdateReadinessCheckResponse

Updates an exisiting Readiness Check.

Examples:

Request syntax with placeholder values


resp = client.update_readiness_check({
  readiness_check_name: "__string", # required
  resource_set_name: "__string", # required
})

Response structure


resp.readiness_check_arn #=> String
resp.readiness_check_name #=> String
resp.resource_set #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :readiness_check_name (required, String)
  • :resource_set_name (required, String)

Returns:

See Also:



1448
1449
1450
1451
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1448

def update_readiness_check(params = {}, options = {})
  req = build_request(:update_readiness_check, params)
  req.send_request(options)
end

#update_recovery_group(params = {}) ⇒ Types::UpdateRecoveryGroupResponse

Updates an existing Recovery Group.

Examples:

Request syntax with placeholder values


resp = client.update_recovery_group({
  cells: ["__string"], # required
  recovery_group_name: "__string", # required
})

Response structure


resp.cells #=> Array
resp.cells[0] #=> String
resp.recovery_group_arn #=> String
resp.recovery_group_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cells (required, Array<String>)
  • :recovery_group_name (required, String)

Returns:

See Also:



1486
1487
1488
1489
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1486

def update_recovery_group(params = {}, options = {})
  req = build_request(:update_recovery_group, params)
  req.send_request(options)
end

#update_resource_set(params = {}) ⇒ Types::UpdateResourceSetResponse

Updates an existing Resource Set.

Examples:

Request syntax with placeholder values


resp = client.update_resource_set({
  resource_set_name: "__string", # required
  resource_set_type: "__stringPatternAWSAZaZ09AZaZ09", # required
  resources: [ # required
    {
      component_id: "__string",
      dns_target_resource: {
        domain_name: "__string",
        hosted_zone_arn: "__string",
        record_set_id: "__string",
        record_type: "__string",
        target_resource: {
          nlb_resource: {
            arn: "__string",
          },
          r53_resource: {
            domain_name: "__string",
            record_set_id: "__string",
          },
        },
      },
      readiness_scopes: ["__string"],
      resource_arn: "__string",
    },
  ],
})

Response structure


resp.resource_set_arn #=> String
resp.resource_set_name #=> String
resp.resource_set_type #=> String
resp.resources #=> Array
resp.resources[0].component_id #=> String
resp.resources[0].dns_target_resource.domain_name #=> String
resp.resources[0].dns_target_resource.hosted_zone_arn #=> String
resp.resources[0].dns_target_resource.record_set_id #=> String
resp.resources[0].dns_target_resource.record_type #=> String
resp.resources[0].dns_target_resource.target_resource.nlb_resource.arn #=> String
resp.resources[0].dns_target_resource.target_resource.r53_resource.domain_name #=> String
resp.resources[0].dns_target_resource.target_resource.r53_resource.record_set_id #=> String
resp.resources[0].readiness_scopes #=> Array
resp.resources[0].readiness_scopes[0] #=> String
resp.resources[0].resource_arn #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_set_name (required, String)
  • :resource_set_type (required, String)
  • :resources (required, Array<Types::Resource>)

Returns:

See Also:



1560
1561
1562
1563
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1560

def update_resource_set(params = {}, options = {})
  req = build_request(:update_resource_set, params)
  req.send_request(options)
end