drs function

Elastic Disaster Recovery Service

Elastic Disaster Recovery Service

AWS Elastic Disaster Recovery Service.

drs(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 <- drs(
  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

associate_source_network_stackAssociate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network
create_extended_source_serverCreate an extended source server in the target Account based on the source server in staging account
create_launch_configuration_templateCreates a new Launch Configuration Template
create_replication_configuration_templateCreates a new ReplicationConfigurationTemplate
create_source_networkCreate a new Source Network resource for a provided VPC ID
delete_jobDeletes a single Job by ID
delete_launch_actionDeletes a resource launch action
delete_launch_configuration_templateDeletes a single Launch Configuration Template by ID
delete_recovery_instanceDeletes a single Recovery Instance by ID
delete_replication_configuration_templateDeletes a single Replication Configuration Template by ID
delete_source_networkDelete Source Network resource
delete_source_serverDeletes a single Source Server by ID
describe_job_log_itemsRetrieves a detailed Job log with pagination
describe_jobsReturns a list of Jobs
describe_launch_configuration_templatesLists all Launch Configuration Templates, filtered by Launch Configuration Template IDs
describe_recovery_instancesLists all Recovery Instances or multiple Recovery Instances by ID
describe_recovery_snapshotsLists all Recovery Snapshots for a single Source Server
describe_replication_configuration_templatesLists all ReplicationConfigurationTemplates, filtered by Source Server IDs
describe_source_networksLists all Source Networks or multiple Source Networks filtered by ID
describe_source_serversLists all Source Servers or multiple Source Servers filtered by ID
disconnect_recovery_instanceDisconnect a Recovery Instance from Elastic Disaster Recovery
disconnect_source_serverDisconnects a specific Source Server from Elastic Disaster Recovery
export_source_network_cfn_templateExport the Source Network CloudFormation template to an S3 bucket
get_failback_replication_configurationLists all Failback ReplicationConfigurations, filtered by Recovery Instance ID
get_launch_configurationGets a LaunchConfiguration, filtered by Source Server IDs
get_replication_configurationGets a ReplicationConfiguration, filtered by Source Server ID
initialize_serviceInitialize Elastic Disaster Recovery
list_extensible_source_serversReturns a list of source servers on a staging account that are extensible, which means that: a
list_launch_actionsLists resource launch actions
list_staging_accountsReturns an array of staging accounts for existing extended source servers
list_tags_for_resourceList all tags for your Elastic Disaster Recovery resources
put_launch_actionPuts a resource launch action
retry_data_replicationWARNING: RetryDataReplication is deprecated
reverse_replicationStart replication to origin / target region - applies only to protected instances that originated in EC2
start_failback_launchInitiates a Job for launching the machine that is being failed back to from the specified Recovery Instance
start_recoveryLaunches Recovery Instances for the specified Source Servers
start_replicationStarts replication for a stopped Source Server
start_source_network_recoveryDeploy VPC for the specified Source Network and modify launch templates to use this network
start_source_network_replicationStarts replication for a Source Network
stop_failbackStops the failback process for a specified Recovery Instance
stop_replicationStops replication for a Source Server
stop_source_network_replicationStops replication for a Source Network
tag_resourceAdds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources
terminate_recovery_instancesInitiates a Job for terminating the EC2 resources associated with the specified Recovery Instances, and then will delete the Recovery Instances from the Elastic Disaster Recovery service
untag_resourceDeletes the specified set of tags from the specified set of Elastic Disaster Recovery resources
update_failback_replication_configurationAllows you to update the failback replication configuration of a Recovery Instance by ID
update_launch_configurationUpdates a LaunchConfiguration by Source Server ID
update_launch_configuration_templateUpdates an existing Launch Configuration Template by ID
update_replication_configurationAllows you to update a ReplicationConfiguration by Source Server ID
update_replication_configuration_templateUpdates a ReplicationConfigurationTemplate by ID

Examples

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