route53recoverycontrolconfig function

AWS Route53 Recovery Control Config

AWS Route53 Recovery Control Config

Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller

route53recoverycontrolconfig( config = list(), credentials = list(), endpoint = NULL, region = NULL )

Arguments

  • config: Optional configuration of credentials, endpoint, and/or region.

    • credentials :

      • creds :

        • access_key_id : AWS access key ID
        • secret_access_key : AWS secret access key
        • session_token : AWS temporary session token
      • profile : The name of a profile to use. If not given, then the default profile is used.

      • anonymous : Set anonymous credentials.

    • endpoint : The complete URL to use for the constructed client.

    • region : The AWS Region used in instantiating the client.

    • close_connection : Immediately close all HTTP connections.

    • timeout : The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

    • s3_force_path_style : Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

    • sts_regional_endpoint : Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

  • credentials: Optional credentials shorthand for the config parameter

    • creds :

      • access_key_id : AWS access key ID
      • secret_access_key : AWS secret access key
      • session_token : AWS temporary session token
    • profile : The name of a profile to use. If not given, then the default profile is used.

    • anonymous : Set anonymous credentials.

  • endpoint: Optional shorthand for complete URL to use for the constructed client.

  • region: Optional shorthand for AWS Region used in instantiating the client.

Returns

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- route53recoverycontrolconfig(
  config = list(
    credentials = list(
 creds = list(
   access_key_id = "string",
   secret_access_key = "string",
   session_token = "string"
 ),
 profile = "string",
 anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
 access_key_id = "string",
 secret_access_key = "string",
 session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

create_clusterCreate a new cluster
create_control_panelCreates a new control panel
create_routing_controlCreates a new routing control
create_safety_ruleCreates a safety rule in a control panel
delete_clusterDelete a cluster
delete_control_panelDeletes a control panel
delete_routing_controlDeletes a routing control
delete_safety_ruleDeletes a safety rule
describe_clusterDisplay the details about a cluster
describe_control_panelDisplays details about a control panel
describe_routing_controlDisplays details about a routing control
describe_safety_ruleReturns information about a safety rule
get_resource_policyGet information about the resource policy for a cluster
list_associated_route_53_health_checksReturns an array of all Amazon Route 53 health checks associated with a specific routing control
list_clustersReturns an array of all the clusters in an account
list_control_panelsReturns an array of control panels in an account or in a cluster
list_routing_controlsReturns an array of routing controls for a control panel
list_safety_rulesList the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel
list_tags_for_resourceLists the tags for a resource
tag_resourceAdds a tag to a resource
untag_resourceRemoves a tag from a resource
update_control_panelUpdates a control panel
update_routing_controlUpdates a routing control
update_safety_ruleUpdate a safety rule (an assertion rule or gating rule)

Examples

## Not run: svc <- route53recoverycontrolconfig() svc$create_cluster( Foo = 123 ) ## End(Not run)
  • Maintainer: Dyfan Jones
  • License: Apache License (>= 2.0)
  • Last published: 2025-03-17

Downloads (last 30 days):