Class: Aws::Route53RecoveryControlConfig::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb

Overview

An API client for Route53RecoveryControlConfig. To construct a client, you need to configure a :region and :credentials.

client = Aws::Route53RecoveryControlConfig::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.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

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

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

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

  • :endpoint_provider (Aws::Route53RecoveryControlConfig::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Route53RecoveryControlConfig::EndpointParameters

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



365
366
367
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 365

def initialize(*args)
  super
end

Instance Method Details

#create_cluster(params = {}) ⇒ Types::CreateClusterResponse

Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane.

Examples:

Request syntax with placeholder values


resp = client.create_cluster({
  client_token: "__stringMin1Max64PatternS",
  cluster_name: "__stringMin1Max64PatternS", # required
  tags: {
    "__string" => "__stringMin0Max256PatternS",
  },
})

Response structure


resp.cluster.cluster_arn #=> String
resp.cluster.cluster_endpoints #=> Array
resp.cluster.cluster_endpoints[0].endpoint #=> String
resp.cluster.cluster_endpoints[0].region #=> String
resp.cluster.name #=> String
resp.cluster.status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :cluster_name (required, String) —

    The name of the cluster.

  • :tags (Hash<String,String>) —

    The tags associated with the cluster.

Returns:

See Also:



419
420
421
422
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 419

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

#create_control_panel(params = {}) ⇒ Types::CreateControlPanelResponse

Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region.

Examples:

Request syntax with placeholder values


resp = client.create_control_panel({
  client_token: "__stringMin1Max64PatternS",
  cluster_arn: "__stringMin1Max256PatternAZaZ09", # required
  control_panel_name: "__stringMin1Max64PatternS", # required
  tags: {
    "__string" => "__stringMin0Max256PatternS",
  },
})

Response structure


resp.control_panel.cluster_arn #=> String
resp.control_panel.control_panel_arn #=> String
resp.control_panel.default_control_panel #=> Boolean
resp.control_panel.name #=> String
resp.control_panel.routing_control_count #=> Integer
resp.control_panel.status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :cluster_arn (required, String) —

    The Amazon Resource Name (ARN) of the cluster for the control panel.

  • :control_panel_name (required, String) —

    The name of the control panel.

  • :tags (Hash<String,String>) —

    The tags associated with the control panel.

Returns:

See Also:



476
477
478
479
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 476

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

#create_routing_control(params = {}) ⇒ Types::CreateRoutingControlResponse

Creates a new routing control.

A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing.

To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

Examples:

Request syntax with placeholder values


resp = client.create_routing_control({
  client_token: "__stringMin1Max64PatternS",
  cluster_arn: "__stringMin1Max256PatternAZaZ09", # required
  control_panel_arn: "__stringMin1Max256PatternAZaZ09",
  routing_control_name: "__stringMin1Max64PatternS", # required
})

Response structure


resp.routing_control.control_panel_arn #=> String
resp.routing_control.name #=> String
resp.routing_control.routing_control_arn #=> String
resp.routing_control.status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :cluster_arn (required, String) —

    The Amazon Resource Name (ARN) of the cluster that includes the routing control.

  • :control_panel_arn (String) —

    The Amazon Resource Name (ARN) of the control panel that includes the routing control.

  • :routing_control_name (required, String) —

    The name of the routing control.

Returns:

See Also:



534
535
536
537
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 534

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

#create_safety_rule(params = {}) ⇒ Types::CreateSafetyRuleResponse

Creates a safety rule in a control panel. Safety rules let you add safeguards around changing routing control states, and for enabling and disabling routing controls, to help prevent unexpected outcomes.

There are two types of safety rules: assertion rules and gating rules.

Assertion rule: An assertion rule enforces that, when you change a routing control state, that a certain criteria is met. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.

Gating rule: A gating rule lets you configure a gating routing control as an overall "on/off" switch for a group of routing controls. Or, you can configure more complex gating scenarios, for example by configuring multiple gating routing controls.

For more information, see Safety rules in the Amazon Route 53 Application Recovery Controller Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_safety_rule({
  assertion_rule: {
    asserted_controls: ["__stringMin1Max256PatternAZaZ09"], # required
    control_panel_arn: "__stringMin1Max256PatternAZaZ09", # required
    name: "__stringMin1Max64PatternS", # required
    rule_config: { # required
      inverted: false, # required
      threshold: 1, # required
      type: "ATLEAST", # required, accepts ATLEAST, AND, OR
    },
    wait_period_ms: 1, # required
  },
  client_token: "__stringMin1Max64PatternS",
  gating_rule: {
    control_panel_arn: "__stringMin1Max256PatternAZaZ09", # required
    gating_controls: ["__stringMin1Max256PatternAZaZ09"], # required
    name: "__stringMin1Max64PatternS", # required
    rule_config: { # required
      inverted: false, # required
      threshold: 1, # required
      type: "ATLEAST", # required, accepts ATLEAST, AND, OR
    },
    target_controls: ["__stringMin1Max256PatternAZaZ09"], # required
    wait_period_ms: 1, # required
  },
  tags: {
    "__string" => "__stringMin0Max256PatternS",
  },
})

Response structure


resp.assertion_rule.asserted_controls #=> Array
resp.assertion_rule.asserted_controls[0] #=> String
resp.assertion_rule.control_panel_arn #=> String
resp.assertion_rule.name #=> String
resp.assertion_rule.rule_config.inverted #=> Boolean
resp.assertion_rule.rule_config.threshold #=> Integer
resp.assertion_rule.rule_config.type #=> String, one of "ATLEAST", "AND", "OR"
resp.assertion_rule.safety_rule_arn #=> String
resp.assertion_rule.status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"
resp.assertion_rule.wait_period_ms #=> Integer
resp.gating_rule.control_panel_arn #=> String
resp.gating_rule.gating_controls #=> Array
resp.gating_rule.gating_controls[0] #=> String
resp.gating_rule.name #=> String
resp.gating_rule.rule_config.inverted #=> Boolean
resp.gating_rule.rule_config.threshold #=> Integer
resp.gating_rule.rule_config.type #=> String, one of "ATLEAST", "AND", "OR"
resp.gating_rule.safety_rule_arn #=> String
resp.gating_rule.status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"
resp.gating_rule.target_controls #=> Array
resp.gating_rule.target_controls[0] #=> String
resp.gating_rule.wait_period_ms #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :assertion_rule (Types::NewAssertionRule) —

    The assertion rule requested.

  • :client_token (String) —

    A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :gating_rule (Types::NewGatingRule) —

    The gating rule requested.

  • :tags (Hash<String,String>) —

    The tags associated with the safety rule.

Returns:

See Also:



647
648
649
650
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 647

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

#delete_cluster(params = {}) ⇒ Struct

Delete a cluster.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :cluster_arn (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



668
669
670
671
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 668

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

#delete_control_panel(params = {}) ⇒ Struct

Deletes a control panel.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :control_panel_arn (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



689
690
691
692
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 689

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

#delete_routing_control(params = {}) ⇒ Struct

Deletes a routing control.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :routing_control_arn (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#delete_safety_rule(params = {}) ⇒ Struct

Deletes a safety rule.

/>

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :safety_rule_arn (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



733
734
735
736
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 733

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

#describe_cluster(params = {}) ⇒ Types::DescribeClusterResponse

Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • cluster_created
  • cluster_deleted

Examples:

Request syntax with placeholder values


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

Response structure


resp.cluster.cluster_arn #=> String
resp.cluster.cluster_endpoints #=> Array
resp.cluster.cluster_endpoints[0].endpoint #=> String
resp.cluster.cluster_endpoints[0].region #=> String
resp.cluster.name #=> String
resp.cluster.status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"

Parameters:

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

    ({})

Options Hash (params):

  • :cluster_arn (required, String)

Returns:

See Also:



772
773
774
775
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 772

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

#describe_control_panel(params = {}) ⇒ Types::DescribeControlPanelResponse

Displays details about a control panel.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • control_panel_created
  • control_panel_deleted

Examples:

Request syntax with placeholder values


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

Response structure


resp.control_panel.cluster_arn #=> String
resp.control_panel.control_panel_arn #=> String
resp.control_panel.default_control_panel #=> Boolean
resp.control_panel.name #=> String
resp.control_panel.routing_control_count #=> Integer
resp.control_panel.status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"

Parameters:

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

    ({})

Options Hash (params):

  • :control_panel_arn (required, String)

Returns:

See Also:



810
811
812
813
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 810

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

#describe_routing_control(params = {}) ⇒ Types::DescribeRoutingControlResponse

Displays details about a routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.

To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • routing_control_created
  • routing_control_deleted

Examples:

Request syntax with placeholder values


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

Response structure


resp.routing_control.control_panel_arn #=> String
resp.routing_control.name #=> String
resp.routing_control.routing_control_arn #=> String
resp.routing_control.status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"

Parameters:

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

    ({})

Options Hash (params):

  • :routing_control_arn (required, String)

Returns:

See Also:



853
854
855
856
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 853

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

#describe_safety_rule(params = {}) ⇒ Types::DescribeSafetyRuleResponse

Returns information about a safety rule.

Examples:

Request syntax with placeholder values


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

Response structure


resp.assertion_rule.asserted_controls #=> Array
resp.assertion_rule.asserted_controls[0] #=> String
resp.assertion_rule.control_panel_arn #=> String
resp.assertion_rule.name #=> String
resp.assertion_rule.rule_config.inverted #=> Boolean
resp.assertion_rule.rule_config.threshold #=> Integer
resp.assertion_rule.rule_config.type #=> String, one of "ATLEAST", "AND", "OR"
resp.assertion_rule.safety_rule_arn #=> String
resp.assertion_rule.status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"
resp.assertion_rule.wait_period_ms #=> Integer
resp.gating_rule.control_panel_arn #=> String
resp.gating_rule.gating_controls #=> Array
resp.gating_rule.gating_controls[0] #=> String
resp.gating_rule.name #=> String
resp.gating_rule.rule_config.inverted #=> Boolean
resp.gating_rule.rule_config.threshold #=> Integer
resp.gating_rule.rule_config.type #=> String, one of "ATLEAST", "AND", "OR"
resp.gating_rule.safety_rule_arn #=> String
resp.gating_rule.status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"
resp.gating_rule.target_controls #=> Array
resp.gating_rule.target_controls[0] #=> String
resp.gating_rule.wait_period_ms #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :safety_rule_arn (required, String)

Returns:

See Also:



902
903
904
905
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 902

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

#list_associated_route_53_health_checks(params = {}) ⇒ Types::ListAssociatedRoute53HealthChecksResponse

Returns an array of all Amazon Route 53 health checks associated with a specific routing control.

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_associated_route_53_health_checks({
  max_results: 1,
  next_token: "__string",
  routing_control_arn: "__string", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



941
942
943
944
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 941

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

#list_clusters(params = {}) ⇒ Types::ListClustersResponse

Returns an array of all the clusters 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_clusters({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.clusters #=> Array
resp.clusters[0].cluster_arn #=> String
resp.clusters[0].cluster_endpoints #=> Array
resp.clusters[0].cluster_endpoints[0].endpoint #=> String
resp.clusters[0].cluster_endpoints[0].region #=> String
resp.clusters[0].name #=> String
resp.clusters[0].status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



981
982
983
984
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 981

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

#list_control_panels(params = {}) ⇒ Types::ListControlPanelsResponse

Returns an array of control panels in an account or in a cluster.

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_control_panels({
  cluster_arn: "__string",
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.control_panels #=> Array
resp.control_panels[0].cluster_arn #=> String
resp.control_panels[0].control_panel_arn #=> String
resp.control_panels[0].default_control_panel #=> Boolean
resp.control_panels[0].name #=> String
resp.control_panels[0].routing_control_count #=> Integer
resp.control_panels[0].status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



1024
1025
1026
1027
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 1024

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

#list_routing_controls(params = {}) ⇒ Types::ListRoutingControlsResponse

Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.

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_routing_controls({
  control_panel_arn: "__string", # required
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.routing_controls #=> Array
resp.routing_controls[0].control_panel_arn #=> String
resp.routing_controls[0].name #=> String
resp.routing_controls[0].routing_control_arn #=> String
resp.routing_controls[0].status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



1069
1070
1071
1072
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 1069

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

#list_safety_rules(params = {}) ⇒ Types::ListSafetyRulesResponse

List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.

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_safety_rules({
  control_panel_arn: "__string", # required
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.next_token #=> String
resp.safety_rules #=> Array
resp.safety_rules[0].assertion.asserted_controls #=> Array
resp.safety_rules[0].assertion.asserted_controls[0] #=> String
resp.safety_rules[0].assertion.control_panel_arn #=> String
resp.safety_rules[0].assertion.name #=> String
resp.safety_rules[0].assertion.rule_config.inverted #=> Boolean
resp.safety_rules[0].assertion.rule_config.threshold #=> Integer
resp.safety_rules[0].assertion.rule_config.type #=> String, one of "ATLEAST", "AND", "OR"
resp.safety_rules[0].assertion.safety_rule_arn #=> String
resp.safety_rules[0].assertion.status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"
resp.safety_rules[0].assertion.wait_period_ms #=> Integer
resp.safety_rules[0].gating.control_panel_arn #=> String
resp.safety_rules[0].gating.gating_controls #=> Array
resp.safety_rules[0].gating.gating_controls[0] #=> String
resp.safety_rules[0].gating.name #=> String
resp.safety_rules[0].gating.rule_config.inverted #=> Boolean
resp.safety_rules[0].gating.rule_config.threshold #=> Integer
resp.safety_rules[0].gating.rule_config.type #=> String, one of "ATLEAST", "AND", "OR"
resp.safety_rules[0].gating.safety_rule_arn #=> String
resp.safety_rules[0].gating.status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"
resp.safety_rules[0].gating.target_controls #=> Array
resp.safety_rules[0].gating.target_controls[0] #=> String
resp.safety_rules[0].gating.wait_period_ms #=> Integer

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



1129
1130
1131
1132
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 1129

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags for a resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  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:



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

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, 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" => "__stringMin0Max256PatternS",
  },
})

Parameters:

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

    ({})

Options Hash (params):

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

    The tags associated with the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1184
1185
1186
1187
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 1184

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:



1208
1209
1210
1211
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 1208

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

#update_control_panel(params = {}) ⇒ Types::UpdateControlPanelResponse

Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.

Examples:

Request syntax with placeholder values


resp = client.update_control_panel({
  control_panel_arn: "__stringMin1Max256PatternAZaZ09", # required
  control_panel_name: "__stringMin1Max64PatternS", # required
})

Response structure


resp.control_panel.cluster_arn #=> String
resp.control_panel.control_panel_arn #=> String
resp.control_panel.default_control_panel #=> Boolean
resp.control_panel.name #=> String
resp.control_panel.routing_control_count #=> Integer
resp.control_panel.status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"

Parameters:

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

    ({})

Options Hash (params):

  • :control_panel_arn (required, String) —

    The Amazon Resource Name (ARN) of the control panel.

  • :control_panel_name (required, String) —

    The name of the control panel.

Returns:

See Also:



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

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

#update_routing_control(params = {}) ⇒ Types::UpdateRoutingControlResponse

Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

Examples:

Request syntax with placeholder values


resp = client.update_routing_control({
  routing_control_arn: "__stringMin1Max256PatternAZaZ09", # required
  routing_control_name: "__stringMin1Max64PatternS", # required
})

Response structure


resp.routing_control.control_panel_arn #=> String
resp.routing_control.name #=> String
resp.routing_control.routing_control_arn #=> String
resp.routing_control.status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"

Parameters:

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

    ({})

Options Hash (params):

  • :routing_control_arn (required, String) —

    The Amazon Resource Name (ARN) of the routing control.

  • :routing_control_name (required, String) —

    The name of the routing control.

Returns:

See Also:



1284
1285
1286
1287
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 1284

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

#update_safety_rule(params = {}) ⇒ Types::UpdateSafetyRuleResponse

Update a safety rule (an assertion rule or gating rule). You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new one.

Examples:

Request syntax with placeholder values


resp = client.update_safety_rule({
  assertion_rule_update: {
    name: "__stringMin1Max64PatternS", # required
    safety_rule_arn: "__stringMin1Max256PatternAZaZ09", # required
    wait_period_ms: 1, # required
  },
  gating_rule_update: {
    name: "__stringMin1Max64PatternS", # required
    safety_rule_arn: "__stringMin1Max256PatternAZaZ09", # required
    wait_period_ms: 1, # required
  },
})

Response structure


resp.assertion_rule.asserted_controls #=> Array
resp.assertion_rule.asserted_controls[0] #=> String
resp.assertion_rule.control_panel_arn #=> String
resp.assertion_rule.name #=> String
resp.assertion_rule.rule_config.inverted #=> Boolean
resp.assertion_rule.rule_config.threshold #=> Integer
resp.assertion_rule.rule_config.type #=> String, one of "ATLEAST", "AND", "OR"
resp.assertion_rule.safety_rule_arn #=> String
resp.assertion_rule.status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"
resp.assertion_rule.wait_period_ms #=> Integer
resp.gating_rule.control_panel_arn #=> String
resp.gating_rule.gating_controls #=> Array
resp.gating_rule.gating_controls[0] #=> String
resp.gating_rule.name #=> String
resp.gating_rule.rule_config.inverted #=> Boolean
resp.gating_rule.rule_config.threshold #=> Integer
resp.gating_rule.rule_config.type #=> String, one of "ATLEAST", "AND", "OR"
resp.gating_rule.safety_rule_arn #=> String
resp.gating_rule.status #=> String, one of "PENDING", "DEPLOYED", "PENDING_DELETION"
resp.gating_rule.target_controls #=> Array
resp.gating_rule.target_controls[0] #=> String
resp.gating_rule.wait_period_ms #=> Integer

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1348
1349
1350
1351
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 1348

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

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
cluster_created #describe_cluster 5 26
cluster_deleted #describe_cluster 5 26
control_panel_created #describe_control_panel 5 26
control_panel_deleted #describe_control_panel 5 26
routing_control_created #describe_routing_control 5 26
routing_control_deleted #describe_routing_control 5 26

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



1463
1464
1465
1466
1467
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/client.rb', line 1463

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end