View Source AWS.Drs (aws-elixir v0.14.1)

AWS Elastic Disaster Recovery Service.

Summary

Functions

Associate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network.

Create an extended source server in the target Account based on the source server in staging account.

Creates a new Launch Configuration Template.

Creates a new ReplicationConfigurationTemplate.

Create a new Source Network resource for a provided VPC ID.

Deletes a single Job by ID.

Deletes a resource launch action.

Deletes a single Launch Configuration Template by ID.

Deletes a single Recovery Instance by ID.

Deletes a single Replication Configuration Template by ID

Delete Source Network resource.

Deletes a single Source Server by ID.

Retrieves a detailed Job log with pagination.

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs

Lists all Recovery Instances or multiple Recovery Instances by ID.

Lists all Recovery Snapshots for a single Source Server.

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

Lists all Source Networks or multiple Source Networks filtered by ID.

Lists all Source Servers or multiple Source Servers filtered by ID.

Disconnect a Recovery Instance from Elastic Disaster Recovery.

Disconnects a specific Source Server from Elastic Disaster Recovery.

Export the Source Network CloudFormation template to an S3 bucket.

Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.

Gets a LaunchConfiguration, filtered by Source Server IDs.

Gets a ReplicationConfiguration, filtered by Source Server ID.

Initialize Elastic Disaster Recovery.

Returns a list of source servers on a staging account that are extensible, which means that: a.

Lists resource launch actions.

Returns an array of staging accounts for existing extended source servers.

List all tags for your Elastic Disaster Recovery resources.

Puts a resource launch action.

WARNING: RetryDataReplication is deprecated.

Start replication to origin / target region - applies only to protected instances that originated in EC2.

Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance.

Launches Recovery Instances for the specified Source Servers.

Starts replication for a stopped Source Server.

Deploy VPC for the specified Source Network and modify launch templates to use this network.

Starts replication for a Source Network.

Stops the failback process for a specified Recovery Instance.

Stops replication for a Source Server.

Stops replication for a Source Network.

Adds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources.

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

Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.

Allows you to update the failback replication configuration of a Recovery Instance by ID.

Updates a LaunchConfiguration by Source Server ID.

Updates an existing Launch Configuration Template by ID.

Allows you to update a ReplicationConfiguration by Source Server ID.

Updates a ReplicationConfigurationTemplate by ID.

Functions

Link to this function

associate_source_network_stack(client, input, options \\ [])

View Source

Associate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network.

Can be used for reverting to previously deployed CloudFormation stacks.

Link to this function

create_extended_source_server(client, input, options \\ [])

View Source

Create an extended source server in the target Account based on the source server in staging account.

Link to this function

create_launch_configuration_template(client, input, options \\ [])

View Source

Creates a new Launch Configuration Template.

Link to this function

create_replication_configuration_template(client, input, options \\ [])

View Source

Creates a new ReplicationConfigurationTemplate.

Link to this function

create_source_network(client, input, options \\ [])

View Source

Create a new Source Network resource for a provided VPC ID.

Link to this function

delete_job(client, input, options \\ [])

View Source

Deletes a single Job by ID.

Link to this function

delete_launch_action(client, input, options \\ [])

View Source

Deletes a resource launch action.

Link to this function

delete_launch_configuration_template(client, input, options \\ [])

View Source

Deletes a single Launch Configuration Template by ID.

Link to this function

delete_recovery_instance(client, input, options \\ [])

View Source

Deletes a single Recovery Instance by ID.

This deletes the Recovery Instance resource from Elastic Disaster Recovery. The Recovery Instance must be disconnected first in order to delete it.

Link to this function

delete_replication_configuration_template(client, input, options \\ [])

View Source

Deletes a single Replication Configuration Template by ID

Link to this function

delete_source_network(client, input, options \\ [])

View Source

Delete Source Network resource.

Link to this function

delete_source_server(client, input, options \\ [])

View Source

Deletes a single Source Server by ID.

The Source Server must be disconnected first.

Link to this function

describe_job_log_items(client, input, options \\ [])

View Source

Retrieves a detailed Job log with pagination.

Link to this function

describe_jobs(client, input, options \\ [])

View Source

Returns a list of Jobs.

Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to Support and only used in response to relevant support tickets.

Link to this function

describe_launch_configuration_templates(client, input, options \\ [])

View Source

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs

Link to this function

describe_recovery_instances(client, input, options \\ [])

View Source

Lists all Recovery Instances or multiple Recovery Instances by ID.

Link to this function

describe_recovery_snapshots(client, input, options \\ [])

View Source

Lists all Recovery Snapshots for a single Source Server.

Link to this function

describe_replication_configuration_templates(client, input, options \\ [])

View Source

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

Link to this function

describe_source_networks(client, input, options \\ [])

View Source

Lists all Source Networks or multiple Source Networks filtered by ID.

Link to this function

describe_source_servers(client, input, options \\ [])

View Source

Lists all Source Servers or multiple Source Servers filtered by ID.

Link to this function

disconnect_recovery_instance(client, input, options \\ [])

View Source

Disconnect a Recovery Instance from Elastic Disaster Recovery.

Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Recovery Instance will be terminated / deleted within 90 minutes. If the agent on the Recovery Instance has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the Recovery Instance will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

Link to this function

disconnect_source_server(client, input, options \\ [])

View Source

Disconnects a specific Source Server from Elastic Disaster Recovery.

Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Source Server will be terminated / deleted within 90 minutes. You cannot disconnect a Source Server if it has a Recovery Instance. If the agent on the Source Server has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

Link to this function

export_source_network_cfn_template(client, input, options \\ [])

View Source

Export the Source Network CloudFormation template to an S3 bucket.

Link to this function

get_failback_replication_configuration(client, input, options \\ [])

View Source

Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.

Link to this function

get_launch_configuration(client, input, options \\ [])

View Source

Gets a LaunchConfiguration, filtered by Source Server IDs.

Link to this function

get_replication_configuration(client, input, options \\ [])

View Source

Gets a ReplicationConfiguration, filtered by Source Server ID.

Link to this function

initialize_service(client, input, options \\ [])

View Source

Initialize Elastic Disaster Recovery.

Link to this function

list_extensible_source_servers(client, input, options \\ [])

View Source

Returns a list of source servers on a staging account that are extensible, which means that: a.

The source server is not already extended into this Account. b. The source server on the Account we’re reading from is not an extension of another source server.

Link to this function

list_launch_actions(client, input, options \\ [])

View Source

Lists resource launch actions.

Link to this function

list_staging_accounts(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns an array of staging accounts for existing extended source servers.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

List all tags for your Elastic Disaster Recovery resources.

Link to this function

put_launch_action(client, input, options \\ [])

View Source

Puts a resource launch action.

Link to this function

retry_data_replication(client, input, options \\ [])

View Source

WARNING: RetryDataReplication is deprecated.

Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state.

Link to this function

reverse_replication(client, input, options \\ [])

View Source

Start replication to origin / target region - applies only to protected instances that originated in EC2.

For recovery instances on target region - starts replication back to origin region. For failback instances on origin region - starts replication to target region to re-protect them.

Link to this function

start_failback_launch(client, input, options \\ [])

View Source

Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance.

This will run conversion on the failback client and will reboot your machine, thus completing the failback process.

Link to this function

start_recovery(client, input, options \\ [])

View Source

Launches Recovery Instances for the specified Source Servers.

For each Source Server you may choose a point in time snapshot to launch from, or use an on demand snapshot.

Link to this function

start_replication(client, input, options \\ [])

View Source

Starts replication for a stopped Source Server.

This action would make the Source Server protected again and restart billing for it.

Link to this function

start_source_network_recovery(client, input, options \\ [])

View Source

Deploy VPC for the specified Source Network and modify launch templates to use this network.

The VPC will be deployed using a dedicated CloudFormation stack.

Link to this function

start_source_network_replication(client, input, options \\ [])

View Source

Starts replication for a Source Network.

This action would make the Source Network protected.

Link to this function

stop_failback(client, input, options \\ [])

View Source

Stops the failback process for a specified Recovery Instance.

This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED.

Link to this function

stop_replication(client, input, options \\ [])

View Source

Stops replication for a Source Server.

This action would make the Source Server unprotected, delete its existing snapshots and stop billing for it.

Link to this function

stop_source_network_replication(client, input, options \\ [])

View Source

Stops replication for a Source Network.

This action would make the Source Network unprotected.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources.

When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.

Link to this function

terminate_recovery_instances(client, input, options \\ [])

View Source

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

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.

Link to this function

update_failback_replication_configuration(client, input, options \\ [])

View Source

Allows you to update the failback replication configuration of a Recovery Instance by ID.

Link to this function

update_launch_configuration(client, input, options \\ [])

View Source

Updates a LaunchConfiguration by Source Server ID.

Link to this function

update_launch_configuration_template(client, input, options \\ [])

View Source

Updates an existing Launch Configuration Template by ID.

Link to this function

update_replication_configuration(client, input, options \\ [])

View Source

Allows you to update a ReplicationConfiguration by Source Server ID.

Link to this function

update_replication_configuration_template(client, input, options \\ [])

View Source

Updates a ReplicationConfigurationTemplate by ID.