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. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :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.

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

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :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.

  • :use_dualstack_endpoint (Boolean)

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :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 (Float) — 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.

  • :ssl_timeout (Float) — default: nil

    Sets the SSL timeout in seconds.

  • :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.



348
349
350
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 348

def initialize(*args)
  super
end

Instance Method Details

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

Creates a cell in an account.

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:



396
397
398
399
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 396

def create_cell(params = {}, options = {})
  req = build_request(:create_cell, params)
  req.send_request(options)
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.

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)

    CrossAccountAuthorization

Returns:

See Also:



427
428
429
430
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 427

def (params = {}, options = {})
  req = build_request(:create_cross_account_authorization, params)
  req.send_request(options)
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.

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:



474
475
476
477
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 474

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 recovery group in an account. A recovery group corresponds to an application and includes a list of the cells that make up the application.

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:



520
521
522
523
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 520

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 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.

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:



602
603
604
605
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 602

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

#delete_cell(params = {}) ⇒ Struct

Delete a cell. When successful, the response code is 204, with no response body.

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:



624
625
626
627
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 624

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

#delete_cross_account_authorization(params = {}) ⇒ Struct

Deletes 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:



645
646
647
648
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 645

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

#delete_readiness_check(params = {}) ⇒ Struct

Deletes a 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:



666
667
668
669
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 666

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

#delete_recovery_group(params = {}) ⇒ Struct

Deletes a 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:



687
688
689
690
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 687

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

#delete_resource_set(params = {}) ⇒ Struct

Deletes a 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:



708
709
710
711
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 708

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

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

Gets recommendations about architecture designs for improving resiliency for an application, based on 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:



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

def get_architecture_recommendations(params = {}, options = {})
  req = build_request(:get_architecture_recommendations, params)
  req.send_request(options)
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.

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:



787
788
789
790
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 787

def get_cell(params = {}, options = {})
  req = build_request(:get_cell, params)
  req.send_request(options)
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.

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:



829
830
831
832
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 829

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

Gets details about a readiness check.

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:



863
864
865
866
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 863

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

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.

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:



913
914
915
916
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 913

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

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.

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:



962
963
964
965
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 962

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

Gets details about a recovery group, including a list of the cells that are included in it.

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:



998
999
1000
1001
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 998

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

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.

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:



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

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

Displays the details about a resource set, including a list of the resources in the 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:



1089
1090
1091
1092
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1089

def get_resource_set(params = {}, options = {})
  req = build_request(:get_resource_set, params)
  req.send_request(options)
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.

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:



1131
1132
1133
1134
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1131

def list_cells(params = {}, options = {})
  req = build_request(:list_cells, params)
  req.send_request(options)
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.

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:



1167
1168
1169
1170
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1167

def (params = {}, options = {})
  req = build_request(:list_cross_account_authorizations, params)
  req.send_request(options)
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.

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:



1206
1207
1208
1209
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1206

def list_readiness_checks(params = {}, options = {})
  req = build_request(:list_readiness_checks, params)
  req.send_request(options)
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.

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:



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

def list_recovery_groups(params = {}, options = {})
  req = build_request(:list_recovery_groups, params)
  req.send_request(options)
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.

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:



1297
1298
1299
1300
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1297

def list_resource_sets(params = {}, options = {})
  req = build_request(:list_resource_sets, params)
  req.send_request(options)
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.

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:



1338
1339
1340
1341
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1338

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

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

Lists the tags for a 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:



1366
1367
1368
1369
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1366

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 a tag to a resource.

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:



1393
1394
1395
1396
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1393

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

#untag_resource(params = {}) ⇒ Struct

Removes a tag from a resource.

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:



1417
1418
1419
1420
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1417

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

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

Updates a cell to replace the list of nested cells with a new list of nested cells.

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:



1459
1460
1461
1462
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1459

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

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

Updates a 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:



1496
1497
1498
1499
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1496

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 a 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:



1534
1535
1536
1537
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1534

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 a 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:



1608
1609
1610
1611
# File 'gems/aws-sdk-route53recoveryreadiness/lib/aws-sdk-route53recoveryreadiness/client.rb', line 1608

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