You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Drs

Inherits:
AWS.Service show all
Identifier:
drs
API Version:
2020-02-26
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

AWS Elastic Disaster Recovery Service.

Sending a Request Using Drs

var drs = new AWS.Drs();
drs.createExtendedSourceServer(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Drs object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var drs = new AWS.Drs({apiVersion: '2020-02-26'});

You can also set the API version globally in AWS.config.apiVersions using the drs service identifier:

AWS.config.apiVersions = {
  drs: '2020-02-26',
  // other service API versions
};

var drs = new AWS.Drs();

Version:

  • 2020-02-26

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Drs(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Drs object

var drs = new AWS.Drs({apiVersion: '2020-02-26'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Drs.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Drs.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Drs.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createExtendedSourceServer(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the createExtendedSourceServer operation

var params = {
  sourceServerArn: 'STRING_VALUE', /* required */
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
drs.createExtendedSourceServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • sourceServerArn — (String)

      This defines the ARN of the source server in staging Account based on which you want to create an extended source server.

    • tags — (map<String>)

      A list of tags associated with the extended source server.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • sourceServer — (map)

        Created extended source server.

        • arn — (String)

          The ARN of the Source Server.

        • dataReplicationInfo — (map)

          The Data Replication Info of the Source Server.

          • dataReplicationError — (map)

            Error in data replication.

            • error — (String)

              Error in data replication.

              Possible values include:
              • "AGENT_NOT_SEEN"
              • "SNAPSHOTS_FAILURE"
              • "NOT_CONVERGING"
              • "UNSTABLE_NETWORK"
              • "FAILED_TO_CREATE_SECURITY_GROUP"
              • "FAILED_TO_LAUNCH_REPLICATION_SERVER"
              • "FAILED_TO_BOOT_REPLICATION_SERVER"
              • "FAILED_TO_AUTHENTICATE_WITH_SERVICE"
              • "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE"
              • "FAILED_TO_CREATE_STAGING_DISKS"
              • "FAILED_TO_ATTACH_STAGING_DISKS"
              • "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT"
              • "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER"
              • "FAILED_TO_START_DATA_TRANSFER"
            • rawError — (String)

              Error in data replication.

          • dataReplicationInitiation — (map)

            Information about whether the data replication has been initiated.

            • nextAttemptDateTime — (String)

              The date and time of the next attempt to initiate data replication.

            • startDateTime — (String)

              The date and time of the current attempt to initiate data replication.

            • steps — (Array<map>)

              The steps of the current attempt to initiate data replication.

              • name — (String)

                The name of the step.

                Possible values include:
                • "WAIT"
                • "CREATE_SECURITY_GROUP"
                • "LAUNCH_REPLICATION_SERVER"
                • "BOOT_REPLICATION_SERVER"
                • "AUTHENTICATE_WITH_SERVICE"
                • "DOWNLOAD_REPLICATION_SOFTWARE"
                • "CREATE_STAGING_DISKS"
                • "ATTACH_STAGING_DISKS"
                • "PAIR_REPLICATION_SERVER_WITH_AGENT"
                • "CONNECT_AGENT_TO_REPLICATION_SERVER"
                • "START_DATA_TRANSFER"
              • status — (String)

                The status of the step.

                Possible values include:
                • "NOT_STARTED"
                • "IN_PROGRESS"
                • "SUCCEEDED"
                • "FAILED"
                • "SKIPPED"
          • dataReplicationState — (String)

            The state of the data replication.

            Possible values include:
            • "STOPPED"
            • "INITIATING"
            • "INITIAL_SYNC"
            • "BACKLOG"
            • "CREATING_SNAPSHOT"
            • "CONTINUOUS"
            • "PAUSED"
            • "RESCAN"
            • "STALLED"
            • "DISCONNECTED"
          • etaDateTime — (String)

            An estimate of when the data replication will be completed.

          • lagDuration — (String)

            Data replication lag duration.

          • replicatedDisks — (Array<map>)

            The disks that should be replicated.

            • backloggedStorageBytes — (Integer)

              The size of the replication backlog in bytes.

            • deviceName — (String)

              The name of the device.

            • replicatedStorageBytes — (Integer)

              The amount of data replicated so far in bytes.

            • rescannedStorageBytes — (Integer)

              The amount of data to be rescanned in bytes.

            • totalStorageBytes — (Integer)

              The total amount of data to be replicated in bytes.

        • lastLaunchResult — (String)

          The status of the last recovery launch of this Source Server.

          Possible values include:
          • "NOT_STARTED"
          • "PENDING"
          • "SUCCEEDED"
          • "FAILED"
        • lifeCycle — (map)

          The lifecycle information of this Source Server.

          • addedToServiceDateTime — (String)

            The date and time of when the Source Server was added to the service.

          • elapsedReplicationDuration — (String)

            The amount of time that the Source Server has been replicating for.

          • firstByteDateTime — (String)

            The date and time of the first byte that was replicated from the Source Server.

          • lastLaunch — (map)

            An object containing information regarding the last launch of the Source Server.

            • initiated — (map)

              An object containing information regarding the initiation of the last launch of a Source Server.

              • apiCallDateTime — (String)

                The date and time the last Source Server launch was initiated.

              • jobID — (String)

                The ID of the Job that was used to last launch the Source Server.

              • type — (String)

                The Job type that was used to last launch the Source Server.

                Possible values include:
                • "RECOVERY"
                • "DRILL"
          • lastSeenByServiceDateTime — (String)

            The date and time this Source Server was last seen by the service.

        • recoveryInstanceId — (String)

          The ID of the Recovery Instance associated with this Source Server.

        • sourceProperties — (map)

          The source properties of the Source Server.

          • cpus — (Array<map>)

            An array of CPUs.

            • cores — (Integer)

              The number of CPU cores.

            • modelName — (String)

              The model name of the CPU.

          • disks — (Array<map>)

            An array of disks.

            • bytes — (Integer)

              The amount of storage on the disk in bytes.

            • deviceName — (String)

              The disk or device name.

          • identificationHints — (map)

            Hints used to uniquely identify a machine.

            • awsInstanceID — (String)

              AWS Instance ID identification hint.

            • fqdn — (String)

              Fully Qualified Domain Name identification hint.

            • hostname — (String)

              Hostname identification hint.

            • vmWareUuid — (String)

              vCenter VM path identification hint.

          • lastUpdatedDateTime — (String)

            The date and time the Source Properties were last updated on.

          • networkInterfaces — (Array<map>)

            An array of network interfaces.

            • ips — (Array<String>)

              Network interface IPs.

            • isPrimary — (Boolean)

              Whether this is the primary network interface.

            • macAddress — (String)

              The MAC address of the network interface.

          • os — (map)

            Operating system.

            • fullString — (String)

              The long name of the Operating System.

          • ramBytes — (Integer)

            The amount of RAM in bytes.

          • recommendedInstanceType — (String)

            The recommended EC2 instance type that will be used when recovering the Source Server.

        • sourceServerID — (String)

          The ID of the Source Server.

        • stagingArea — (map)

          The staging area of the source server.

          • errorMessage — (String)

            Shows an error message that occurred when DRS tried to access the staging source server. In this case StagingArea$status will have value EXTENSION_ERROR

          • stagingAccountID — (String)

            Account ID of the account to which source server belongs. If this source server is extended - shows Account ID of staging source server.

          • stagingSourceServerArn — (String)

            Arn of the staging source server if this source server is extended

          • status — (String)

            Status of Source server extension. Possible values: (a) NOT_EXTENDED - This is a source server that is replicating in the current account. (b) EXTENDED - Source server is extended from a staging source server. In this case, the value of stagingSourceServerArn is pointing to the Arn of the source server in the staging account. (c) EXTENSION_ERROR - Some issue occurred when accessing staging source server. In this case, errorMessage field will contain an error message that explains what happened.

            Possible values include:
            • "EXTENDED"
            • "EXTENSION_ERROR"
            • "NOT_EXTENDED"
        • tags — (map<String>)

          The tags associated with the Source Server.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createReplicationConfigurationTemplate(params = {}, callback) ⇒ AWS.Request

Creates a new ReplicationConfigurationTemplate.

Examples:

Calling the createReplicationConfigurationTemplate operation

var params = {
  associateDefaultSecurityGroup: true || false, /* required */
  bandwidthThrottling: 'NUMBER_VALUE', /* required */
  createPublicIP: true || false, /* required */
  dataPlaneRouting: PRIVATE_IP | PUBLIC_IP, /* required */
  defaultLargeStagingDiskType: GP2 | GP3 | ST1 | AUTO, /* required */
  ebsEncryption: DEFAULT | CUSTOM, /* required */
  pitPolicy: [ /* required */
    {
      interval: 'NUMBER_VALUE', /* required */
      retentionDuration: 'NUMBER_VALUE', /* required */
      units: MINUTE | HOUR | DAY, /* required */
      enabled: true || false,
      ruleID: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  replicationServerInstanceType: 'STRING_VALUE', /* required */
  replicationServersSecurityGroupsIDs: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  stagingAreaSubnetId: 'STRING_VALUE', /* required */
  stagingAreaTags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  useDedicatedReplicationServer: true || false, /* required */
  ebsEncryptionKeyArn: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
drs.createReplicationConfigurationTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • associateDefaultSecurityGroup — (Boolean)

      Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

    • bandwidthThrottling — (Integer)

      Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

    • createPublicIP — (Boolean)

      Whether to create a Public IP for the Recovery Instance by default.

    • dataPlaneRouting — (String)

      The data plane routing mechanism that will be used for replication.

      Possible values include:
      • "PRIVATE_IP"
      • "PUBLIC_IP"
    • defaultLargeStagingDiskType — (String)

      The Staging Disk EBS volume type to be used during replication.

      Possible values include:
      • "GP2"
      • "GP3"
      • "ST1"
      • "AUTO"
    • ebsEncryption — (String)

      The type of EBS encryption to be used during replication.

      Possible values include:
      • "DEFAULT"
      • "CUSTOM"
    • ebsEncryptionKeyArn — (String)

      The ARN of the EBS encryption key to be used during replication.

    • pitPolicy — (Array<map>)

      The Point in time (PIT) policy to manage snapshots taken during replication.

      • enabled — (Boolean)

        Whether this rule is enabled or not.

      • intervalrequired — (Integer)

        How often, in the chosen units, a snapshot should be taken.

      • retentionDurationrequired — (Integer)

        The duration to retain a snapshot for, in the chosen units.

      • ruleID — (Integer)

        The ID of the rule.

      • unitsrequired — (String)

        The units used to measure the interval and retentionDuration.

        Possible values include:
        • "MINUTE"
        • "HOUR"
        • "DAY"
    • replicationServerInstanceType — (String)

      The instance type to be used for the replication server.

    • replicationServersSecurityGroupsIDs — (Array<String>)

      The security group IDs that will be used by the replication server.

    • stagingAreaSubnetId — (String)

      The subnet to be used by the replication staging area.

    • stagingAreaTags — (map<String>)

      A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

    • tags — (map<String>)

      A set of tags to be associated with the Replication Configuration Template resource.

    • useDedicatedReplicationServer — (Boolean)

      Whether to use a dedicated Replication Server in the replication staging area.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • arn — (String)

        The Replication Configuration Template ARN.

      • associateDefaultSecurityGroup — (Boolean)

        Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

      • bandwidthThrottling — (Integer)

        Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

      • createPublicIP — (Boolean)

        Whether to create a Public IP for the Recovery Instance by default.

      • dataPlaneRouting — (String)

        The data plane routing mechanism that will be used for replication.

        Possible values include:
        • "PRIVATE_IP"
        • "PUBLIC_IP"
      • defaultLargeStagingDiskType — (String)

        The Staging Disk EBS volume type to be used during replication.

        Possible values include:
        • "GP2"
        • "GP3"
        • "ST1"
        • "AUTO"
      • ebsEncryption — (String)

        The type of EBS encryption to be used during replication.

        Possible values include:
        • "DEFAULT"
        • "CUSTOM"
      • ebsEncryptionKeyArn — (String)

        The ARN of the EBS encryption key to be used during replication.

      • pitPolicy — (Array<map>)

        The Point in time (PIT) policy to manage snapshots taken during replication.

        • enabled — (Boolean)

          Whether this rule is enabled or not.

        • intervalrequired — (Integer)

          How often, in the chosen units, a snapshot should be taken.

        • retentionDurationrequired — (Integer)

          The duration to retain a snapshot for, in the chosen units.

        • ruleID — (Integer)

          The ID of the rule.

        • unitsrequired — (String)

          The units used to measure the interval and retentionDuration.

          Possible values include:
          • "MINUTE"
          • "HOUR"
          • "DAY"
      • replicationConfigurationTemplateID — (String)

        The Replication Configuration Template ID.

      • replicationServerInstanceType — (String)

        The instance type to be used for the replication server.

      • replicationServersSecurityGroupsIDs — (Array<String>)

        The security group IDs that will be used by the replication server.

      • stagingAreaSubnetId — (String)

        The subnet to be used by the replication staging area.

      • stagingAreaTags — (map<String>)

        A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

      • tags — (map<String>)

        A set of tags to be associated with the Replication Configuration Template resource.

      • useDedicatedReplicationServer — (Boolean)

        Whether to use a dedicated Replication Server in the replication staging area.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteJob(params = {}, callback) ⇒ AWS.Request

Deletes a single Job by ID.

Service Reference:

Examples:

Calling the deleteJob operation

var params = {
  jobID: 'STRING_VALUE' /* required */
};
drs.deleteJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • jobID — (String)

      The ID of the Job to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteRecoveryInstance(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteRecoveryInstance operation

var params = {
  recoveryInstanceID: 'STRING_VALUE' /* required */
};
drs.deleteRecoveryInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • recoveryInstanceID — (String)

      The ID of the Recovery Instance to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteReplicationConfigurationTemplate(params = {}, callback) ⇒ AWS.Request

Deletes a single Replication Configuration Template by ID

Examples:

Calling the deleteReplicationConfigurationTemplate operation

var params = {
  replicationConfigurationTemplateID: 'STRING_VALUE' /* required */
};
drs.deleteReplicationConfigurationTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • replicationConfigurationTemplateID — (String)

      The ID of the Replication Configuration Template to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteSourceServer(params = {}, callback) ⇒ AWS.Request

Deletes a single Source Server by ID. The Source Server must be disconnected first.

Service Reference:

Examples:

Calling the deleteSourceServer operation

var params = {
  sourceServerID: 'STRING_VALUE' /* required */
};
drs.deleteSourceServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • sourceServerID — (String)

      The ID of the Source Server to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeJobLogItems(params = {}, callback) ⇒ AWS.Request

Retrieves a detailed Job log with pagination.

Service Reference:

Examples:

Calling the describeJobLogItems operation

var params = {
  jobID: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
drs.describeJobLogItems(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • jobID — (String)

      The ID of the Job for which Job log items will be retrieved.

    • maxResults — (Integer)

      Maximum number of Job log items to retrieve.

    • nextToken — (String)

      The token of the next Job log items to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • items — (Array<map>)

        An array of Job log items.

        • event — (String)

          The event represents the type of a log.

          Possible values include:
          • "JOB_START"
          • "SERVER_SKIPPED"
          • "CLEANUP_START"
          • "CLEANUP_END"
          • "CLEANUP_FAIL"
          • "SNAPSHOT_START"
          • "SNAPSHOT_END"
          • "SNAPSHOT_FAIL"
          • "USING_PREVIOUS_SNAPSHOT"
          • "USING_PREVIOUS_SNAPSHOT_FAILED"
          • "CONVERSION_START"
          • "CONVERSION_END"
          • "CONVERSION_FAIL"
          • "LAUNCH_START"
          • "LAUNCH_FAILED"
          • "JOB_CANCEL"
          • "JOB_END"
        • eventData — (map)

          Metadata associated with a Job log.

          • conversionProperties — (map)

            Properties of a conversion job

            • dataTimestamp — (String)

              The timestamp of when the snapshot being converted was taken

            • forceUefi — (Boolean)

              Whether the volume being converted uses UEFI or not

            • rootVolumeName — (String)

              The root volume name of a conversion job

            • volumeToConversionMap — (map<map<String>>)

              A mapping between the volumes being converted and the converted snapshot ids

            • volumeToVolumeSize — (map<Integer>)

              A mapping between the volumes and their sizes

          • conversionServerID — (String)

            The ID of a conversion server.

          • rawError — (String)

            A string representing a job error.

          • sourceServerID — (String)

            The ID of a Source Server.

          • targetInstanceID — (String)

            The ID of a Recovery Instance.

        • logDateTime — (String)

          The date and time the log was taken.

      • nextToken — (String)

        The token of the next Job log items to retrieve.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeJobs(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeJobs operation

var params = {
  filters: {
    fromDate: 'STRING_VALUE',
    jobIDs: [
      'STRING_VALUE',
      /* more items */
    ],
    toDate: 'STRING_VALUE'
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
drs.describeJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filters — (map)

      A set of filters by which to return Jobs.

      • fromDate — (String)

        The start date in a date range query.

      • jobIDs — (Array<String>)

        An array of Job IDs that should be returned. An empty array means all jobs.

      • toDate — (String)

        The end date in a date range query.

    • maxResults — (Integer)

      Maximum number of Jobs to retrieve.

    • nextToken — (String)

      The token of the next Job to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • items — (Array<map>)

        An array of Jobs.

        • arn — (String)

          The ARN of a Job.

        • creationDateTime — (String)

          The date and time of when the Job was created.

        • endDateTime — (String)

          The date and time of when the Job ended.

        • initiatedBy — (String)

          A string representing who initiated the Job.

          Possible values include:
          • "START_RECOVERY"
          • "START_DRILL"
          • "FAILBACK"
          • "DIAGNOSTIC"
          • "TERMINATE_RECOVERY_INSTANCES"
          • "TARGET_ACCOUNT"
        • jobIDrequired — (String)

          The ID of the Job.

        • participatingServers — (Array<map>)

          A list of servers that the Job is acting upon.

          • launchStatus — (String)

            The launch status of a participating server.

            Possible values include:
            • "PENDING"
            • "IN_PROGRESS"
            • "LAUNCHED"
            • "FAILED"
            • "TERMINATED"
          • recoveryInstanceID — (String)

            The Recovery Instance ID of a participating server.

          • sourceServerID — (String)

            The Source Server ID of a participating server.

        • status — (String)

          The status of the Job.

          Possible values include:
          • "PENDING"
          • "STARTED"
          • "COMPLETED"
        • tags — (map<String>)

          A list of tags associated with the Job.

        • type — (String)

          The type of the Job.

          Possible values include:
          • "LAUNCH"
          • "TERMINATE"
          • "CREATE_CONVERTED_SNAPSHOT"
      • nextToken — (String)

        The token of the next Job to retrieve.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeRecoveryInstances(params = {}, callback) ⇒ AWS.Request

Lists all Recovery Instances or multiple Recovery Instances by ID.

Service Reference:

Examples:

Calling the describeRecoveryInstances operation

var params = {
  filters: {
    recoveryInstanceIDs: [
      'STRING_VALUE',
      /* more items */
    ],
    sourceServerIDs: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
drs.describeRecoveryInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filters — (map)

      A set of filters by which to return Recovery Instances.

      • recoveryInstanceIDs — (Array<String>)

        An array of Recovery Instance IDs that should be returned. An empty array means all Recovery Instances.

      • sourceServerIDs — (Array<String>)

        An array of Source Server IDs for which associated Recovery Instances should be returned.

    • maxResults — (Integer)

      Maximum number of Recovery Instances to retrieve.

    • nextToken — (String)

      The token of the next Recovery Instance to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • items — (Array<map>)

        An array of Recovery Instances.

        • arn — (String)

          The ARN of the Recovery Instance.

        • dataReplicationInfo — (map)

          The Data Replication Info of the Recovery Instance.

          • dataReplicationError — (map)

            Information about Data Replication

            • error — (String)

              Error in data replication.

              Possible values include:
              • "AGENT_NOT_SEEN"
              • "FAILBACK_CLIENT_NOT_SEEN"
              • "NOT_CONVERGING"
              • "UNSTABLE_NETWORK"
              • "FAILED_TO_ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION"
              • "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT"
              • "FAILED_TO_CONFIGURE_REPLICATION_SOFTWARE"
              • "FAILED_TO_PAIR_AGENT_WITH_REPLICATION_SOFTWARE"
              • "FAILED_TO_ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION"
            • rawError — (String)

              Error in data replication.

          • dataReplicationInitiation — (map)

            Information about whether the data replication has been initiated.

            • startDateTime — (String)

              The date and time of the current attempt to initiate data replication.

            • steps — (Array<map>)

              The steps of the current attempt to initiate data replication.

              • name — (String)

                The name of the step.

                Possible values include:
                • "LINK_FAILBACK_CLIENT_WITH_RECOVERY_INSTANCE"
                • "COMPLETE_VOLUME_MAPPING"
                • "ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION"
                • "DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT"
                • "CONFIGURE_REPLICATION_SOFTWARE"
                • "PAIR_AGENT_WITH_REPLICATION_SOFTWARE"
                • "ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION"
              • status — (String)

                The status of the step.

                Possible values include:
                • "NOT_STARTED"
                • "IN_PROGRESS"
                • "SUCCEEDED"
                • "FAILED"
                • "SKIPPED"
          • dataReplicationState — (String)

            The state of the data replication.

            Possible values include:
            • "STOPPED"
            • "INITIATING"
            • "INITIAL_SYNC"
            • "BACKLOG"
            • "CREATING_SNAPSHOT"
            • "CONTINUOUS"
            • "PAUSED"
            • "RESCAN"
            • "STALLED"
            • "DISCONNECTED"
          • etaDateTime — (String)

            An estimate of when the data replication will be completed.

          • lagDuration — (String)

            Data replication lag duration.

          • replicatedDisks — (Array<map>)

            The disks that should be replicated.

            • backloggedStorageBytes — (Integer)

              The size of the replication backlog in bytes.

            • deviceName — (String)

              The name of the device.

            • replicatedStorageBytes — (Integer)

              The amount of data replicated so far in bytes.

            • rescannedStorageBytes — (Integer)

              The amount of data to be rescanned in bytes.

            • totalStorageBytes — (Integer)

              The total amount of data to be replicated in bytes.

        • ec2InstanceID — (String)

          The EC2 instance ID of the Recovery Instance.

        • ec2InstanceState — (String)

          The state of the EC2 instance for this Recovery Instance.

          Possible values include:
          • "PENDING"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
          • "SHUTTING-DOWN"
          • "TERMINATED"
          • "NOT_FOUND"
        • failback — (map)

          An object representing failback related information of the Recovery Instance.

          • agentLastSeenByServiceDateTime — (String)

            The date and time the agent on the Recovery Instance was last seen by the service.

          • elapsedReplicationDuration — (String)

            The amount of time that the Recovery Instance has been replicating for.

          • failbackClientID — (String)

            The ID of the failback client that this Recovery Instance is associated with.

          • failbackClientLastSeenByServiceDateTime — (String)

            The date and time that the failback client was last seen by the service.

          • failbackInitiationTime — (String)

            The date and time that the failback initiation started.

          • failbackJobID — (String)

            The Job ID of the last failback log for this Recovery Instance.

          • failbackToOriginalServer — (Boolean)

            Whether we are failing back to the original Source Server for this Recovery Instance.

          • firstByteDateTime — (String)

            The date and time of the first byte that was replicated from the Recovery Instance.

          • state — (String)

            The state of the failback process that this Recovery Instance is in.

            Possible values include:
            • "FAILBACK_NOT_STARTED"
            • "FAILBACK_IN_PROGRESS"
            • "FAILBACK_READY_FOR_LAUNCH"
            • "FAILBACK_COMPLETED"
            • "FAILBACK_ERROR"
        • isDrill — (Boolean)

          Whether this Recovery Instance was created for a drill or for an actual Recovery event.

        • jobID — (String)

          The ID of the Job that created the Recovery Instance.

        • pointInTimeSnapshotDateTime — (String)

          The date and time of the Point in Time (PIT) snapshot that this Recovery Instance was launched from.

        • recoveryInstanceID — (String)

          The ID of the Recovery Instance.

        • recoveryInstanceProperties — (map)

          Properties of the Recovery Instance machine.

          • cpus — (Array<map>)

            An array of CPUs.

            • cores — (Integer)

              The number of CPU cores.

            • modelName — (String)

              The model name of the CPU.

          • disks — (Array<map>)

            An array of disks.

            • bytes — (Integer)

              The amount of storage on the disk in bytes.

            • ebsVolumeID — (String)

              The EBS Volume ID of this disk.

            • internalDeviceName — (String)

              The internal device name of this disk. This is the name that is visible on the machine itself and not from the EC2 console.

          • identificationHints — (map)

            Hints used to uniquely identify a machine.

            • awsInstanceID — (String)

              AWS Instance ID identification hint.

            • fqdn — (String)

              Fully Qualified Domain Name identification hint.

            • hostname — (String)

              Hostname identification hint.

            • vmWareUuid — (String)

              vCenter VM path identification hint.

          • lastUpdatedDateTime — (String)

            The date and time the Recovery Instance properties were last updated on.

          • networkInterfaces — (Array<map>)

            An array of network interfaces.

            • ips — (Array<String>)

              Network interface IPs.

            • isPrimary — (Boolean)

              Whether this is the primary network interface.

            • macAddress — (String)

              The MAC address of the network interface.

          • os — (map)

            Operating system.

            • fullString — (String)

              The long name of the Operating System.

          • ramBytes — (Integer)

            The amount of RAM in bytes.

        • sourceServerID — (String)

          The Source Server ID that this Recovery Instance is associated with.

        • tags — (map<String>)

          An array of tags that are associated with the Recovery Instance.

      • nextToken — (String)

        The token of the next Recovery Instance to retrieve.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeRecoverySnapshots(params = {}, callback) ⇒ AWS.Request

Lists all Recovery Snapshots for a single Source Server.

Service Reference:

Examples:

Calling the describeRecoverySnapshots operation

var params = {
  sourceServerID: 'STRING_VALUE', /* required */
  filters: {
    fromDateTime: 'STRING_VALUE',
    toDateTime: 'STRING_VALUE'
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  order: ASC | DESC
};
drs.describeRecoverySnapshots(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filters — (map)

      A set of filters by which to return Recovery Snapshots.

      • fromDateTime — (String)

        The start date in a date range query.

      • toDateTime — (String)

        The end date in a date range query.

    • maxResults — (Integer)

      Maximum number of Recovery Snapshots to retrieve.

    • nextToken — (String)

      The token of the next Recovery Snapshot to retrieve.

    • order — (String)

      The sorted ordering by which to return Recovery Snapshots.

      Possible values include:
      • "ASC"
      • "DESC"
    • sourceServerID — (String)

      Filter Recovery Snapshots by Source Server ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • items — (Array<map>)

        An array of Recovery Snapshots.

        • ebsSnapshots — (Array<String>)

          A list of EBS snapshots.

        • expectedTimestamprequired — (String)

          The timestamp of when we expect the snapshot to be taken.

        • snapshotIDrequired — (String)

          The ID of the Recovery Snapshot.

        • sourceServerIDrequired — (String)

          The ID of the Source Server that the snapshot was taken for.

        • timestamp — (String)

          The actual timestamp that the snapshot was taken.

      • nextToken — (String)

        The token of the next Recovery Snapshot to retrieve.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeReplicationConfigurationTemplates(params = {}, callback) ⇒ AWS.Request

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

Examples:

Calling the describeReplicationConfigurationTemplates operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  replicationConfigurationTemplateIDs: [
    'STRING_VALUE',
    /* more items */
  ]
};
drs.describeReplicationConfigurationTemplates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      Maximum number of Replication Configuration Templates to retrieve.

    • nextToken — (String)

      The token of the next Replication Configuration Template to retrieve.

    • replicationConfigurationTemplateIDs — (Array<String>)

      The IDs of the Replication Configuration Templates to retrieve. An empty list means all Replication Configuration Templates.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • items — (Array<map>)

        An array of Replication Configuration Templates.

        • arn — (String)

          The Replication Configuration Template ARN.

        • associateDefaultSecurityGroup — (Boolean)

          Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

        • bandwidthThrottling — (Integer)

          Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

        • createPublicIP — (Boolean)

          Whether to create a Public IP for the Recovery Instance by default.

        • dataPlaneRouting — (String)

          The data plane routing mechanism that will be used for replication.

          Possible values include:
          • "PRIVATE_IP"
          • "PUBLIC_IP"
        • defaultLargeStagingDiskType — (String)

          The Staging Disk EBS volume type to be used during replication.

          Possible values include:
          • "GP2"
          • "GP3"
          • "ST1"
          • "AUTO"
        • ebsEncryption — (String)

          The type of EBS encryption to be used during replication.

          Possible values include:
          • "DEFAULT"
          • "CUSTOM"
        • ebsEncryptionKeyArn — (String)

          The ARN of the EBS encryption key to be used during replication.

        • pitPolicy — (Array<map>)

          The Point in time (PIT) policy to manage snapshots taken during replication.

          • enabled — (Boolean)

            Whether this rule is enabled or not.

          • intervalrequired — (Integer)

            How often, in the chosen units, a snapshot should be taken.

          • retentionDurationrequired — (Integer)

            The duration to retain a snapshot for, in the chosen units.

          • ruleID — (Integer)

            The ID of the rule.

          • unitsrequired — (String)

            The units used to measure the interval and retentionDuration.

            Possible values include:
            • "MINUTE"
            • "HOUR"
            • "DAY"
        • replicationConfigurationTemplateIDrequired — (String)

          The Replication Configuration Template ID.

        • replicationServerInstanceType — (String)

          The instance type to be used for the replication server.

        • replicationServersSecurityGroupsIDs — (Array<String>)

          The security group IDs that will be used by the replication server.

        • stagingAreaSubnetId — (String)

          The subnet to be used by the replication staging area.

        • stagingAreaTags — (map<String>)

          A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

        • tags — (map<String>)

          A set of tags to be associated with the Replication Configuration Template resource.

        • useDedicatedReplicationServer — (Boolean)

          Whether to use a dedicated Replication Server in the replication staging area.

      • nextToken — (String)

        The token of the next Replication Configuration Template to retrieve.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeSourceServers(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeSourceServers operation

var params = {
  filters: {
    hardwareId: 'STRING_VALUE',
    sourceServerIDs: [
      'STRING_VALUE',
      /* more items */
    ],
    stagingAccountIDs: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
drs.describeSourceServers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filters — (map)

      A set of filters by which to return Source Servers.

      • hardwareId — (String)

        An ID that describes the hardware of the Source Server. This is either an EC2 instance id, a VMware uuid or a mac address.

      • sourceServerIDs — (Array<String>)

        An array of Source Servers IDs that should be returned. An empty array means all Source Servers.

      • stagingAccountIDs — (Array<String>)

        An array of staging account IDs that extended source servers belong to. An empty array means all source servers will be shown.

    • maxResults — (Integer)

      Maximum number of Source Servers to retrieve.

    • nextToken — (String)

      The token of the next Source Server to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • items — (Array<map>)

        An array of Source Servers.

        • arn — (String)

          The ARN of the Source Server.

        • dataReplicationInfo — (map)

          The Data Replication Info of the Source Server.

          • dataReplicationError — (map)

            Error in data replication.

            • error — (String)

              Error in data replication.

              Possible values include:
              • "AGENT_NOT_SEEN"
              • "SNAPSHOTS_FAILURE"
              • "NOT_CONVERGING"
              • "UNSTABLE_NETWORK"
              • "FAILED_TO_CREATE_SECURITY_GROUP"
              • "FAILED_TO_LAUNCH_REPLICATION_SERVER"
              • "FAILED_TO_BOOT_REPLICATION_SERVER"
              • "FAILED_TO_AUTHENTICATE_WITH_SERVICE"
              • "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE"
              • "FAILED_TO_CREATE_STAGING_DISKS"
              • "FAILED_TO_ATTACH_STAGING_DISKS"
              • "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT"
              • "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER"
              • "FAILED_TO_START_DATA_TRANSFER"
            • rawError — (String)

              Error in data replication.

          • dataReplicationInitiation — (map)

            Information about whether the data replication has been initiated.

            • nextAttemptDateTime — (String)

              The date and time of the next attempt to initiate data replication.

            • startDateTime — (String)

              The date and time of the current attempt to initiate data replication.

            • steps — (Array<map>)

              The steps of the current attempt to initiate data replication.

              • name — (String)

                The name of the step.

                Possible values include:
                • "WAIT"
                • "CREATE_SECURITY_GROUP"
                • "LAUNCH_REPLICATION_SERVER"
                • "BOOT_REPLICATION_SERVER"
                • "AUTHENTICATE_WITH_SERVICE"
                • "DOWNLOAD_REPLICATION_SOFTWARE"
                • "CREATE_STAGING_DISKS"
                • "ATTACH_STAGING_DISKS"
                • "PAIR_REPLICATION_SERVER_WITH_AGENT"
                • "CONNECT_AGENT_TO_REPLICATION_SERVER"
                • "START_DATA_TRANSFER"
              • status — (String)

                The status of the step.

                Possible values include:
                • "NOT_STARTED"
                • "IN_PROGRESS"
                • "SUCCEEDED"
                • "FAILED"
                • "SKIPPED"
          • dataReplicationState — (String)

            The state of the data replication.

            Possible values include:
            • "STOPPED"
            • "INITIATING"
            • "INITIAL_SYNC"
            • "BACKLOG"
            • "CREATING_SNAPSHOT"
            • "CONTINUOUS"
            • "PAUSED"
            • "RESCAN"
            • "STALLED"
            • "DISCONNECTED"
          • etaDateTime — (String)

            An estimate of when the data replication will be completed.

          • lagDuration — (String)

            Data replication lag duration.

          • replicatedDisks — (Array<map>)

            The disks that should be replicated.

            • backloggedStorageBytes — (Integer)

              The size of the replication backlog in bytes.

            • deviceName — (String)

              The name of the device.

            • replicatedStorageBytes — (Integer)

              The amount of data replicated so far in bytes.

            • rescannedStorageBytes — (Integer)

              The amount of data to be rescanned in bytes.

            • totalStorageBytes — (Integer)

              The total amount of data to be replicated in bytes.

        • lastLaunchResult — (String)

          The status of the last recovery launch of this Source Server.

          Possible values include:
          • "NOT_STARTED"
          • "PENDING"
          • "SUCCEEDED"
          • "FAILED"
        • lifeCycle — (map)

          The lifecycle information of this Source Server.

          • addedToServiceDateTime — (String)

            The date and time of when the Source Server was added to the service.

          • elapsedReplicationDuration — (String)

            The amount of time that the Source Server has been replicating for.

          • firstByteDateTime — (String)

            The date and time of the first byte that was replicated from the Source Server.

          • lastLaunch — (map)

            An object containing information regarding the last launch of the Source Server.

            • initiated — (map)

              An object containing information regarding the initiation of the last launch of a Source Server.

              • apiCallDateTime — (String)

                The date and time the last Source Server launch was initiated.

              • jobID — (String)

                The ID of the Job that was used to last launch the Source Server.

              • type — (String)

                The Job type that was used to last launch the Source Server.

                Possible values include:
                • "RECOVERY"
                • "DRILL"
          • lastSeenByServiceDateTime — (String)

            The date and time this Source Server was last seen by the service.

        • recoveryInstanceId — (String)

          The ID of the Recovery Instance associated with this Source Server.

        • sourceProperties — (map)

          The source properties of the Source Server.

          • cpus — (Array<map>)

            An array of CPUs.

            • cores — (Integer)

              The number of CPU cores.

            • modelName — (String)

              The model name of the CPU.

          • disks — (Array<map>)

            An array of disks.

            • bytes — (Integer)

              The amount of storage on the disk in bytes.

            • deviceName — (String)

              The disk or device name.

          • identificationHints — (map)

            Hints used to uniquely identify a machine.

            • awsInstanceID — (String)

              AWS Instance ID identification hint.

            • fqdn — (String)

              Fully Qualified Domain Name identification hint.

            • hostname — (String)

              Hostname identification hint.

            • vmWareUuid — (String)

              vCenter VM path identification hint.

          • lastUpdatedDateTime — (String)

            The date and time the Source Properties were last updated on.

          • networkInterfaces — (Array<map>)

            An array of network interfaces.

            • ips — (Array<String>)

              Network interface IPs.

            • isPrimary — (Boolean)

              Whether this is the primary network interface.

            • macAddress — (String)

              The MAC address of the network interface.

          • os — (map)

            Operating system.

            • fullString — (String)

              The long name of the Operating System.

          • ramBytes — (Integer)

            The amount of RAM in bytes.

          • recommendedInstanceType — (String)

            The recommended EC2 instance type that will be used when recovering the Source Server.

        • sourceServerID — (String)

          The ID of the Source Server.

        • stagingArea — (map)

          The staging area of the source server.

          • errorMessage — (String)

            Shows an error message that occurred when DRS tried to access the staging source server. In this case StagingArea$status will have value EXTENSION_ERROR

          • stagingAccountID — (String)

            Account ID of the account to which source server belongs. If this source server is extended - shows Account ID of staging source server.

          • stagingSourceServerArn — (String)

            Arn of the staging source server if this source server is extended

          • status — (String)

            Status of Source server extension. Possible values: (a) NOT_EXTENDED - This is a source server that is replicating in the current account. (b) EXTENDED - Source server is extended from a staging source server. In this case, the value of stagingSourceServerArn is pointing to the Arn of the source server in the staging account. (c) EXTENSION_ERROR - Some issue occurred when accessing staging source server. In this case, errorMessage field will contain an error message that explains what happened.

            Possible values include:
            • "EXTENDED"
            • "EXTENSION_ERROR"
            • "NOT_EXTENDED"
        • tags — (map<String>)

          The tags associated with the Source Server.

      • nextToken — (String)

        The token of the next Source Server to retrieve.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disconnectRecoveryInstance(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the disconnectRecoveryInstance operation

var params = {
  recoveryInstanceID: 'STRING_VALUE' /* required */
};
drs.disconnectRecoveryInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • recoveryInstanceID — (String)

      The ID of the Recovery Instance to disconnect.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disconnectSourceServer(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the disconnectSourceServer operation

var params = {
  sourceServerID: 'STRING_VALUE' /* required */
};
drs.disconnectSourceServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • sourceServerID — (String)

      The ID of the Source Server to disconnect.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • arn — (String)

        The ARN of the Source Server.

      • dataReplicationInfo — (map)

        The Data Replication Info of the Source Server.

        • dataReplicationError — (map)

          Error in data replication.

          • error — (String)

            Error in data replication.

            Possible values include:
            • "AGENT_NOT_SEEN"
            • "SNAPSHOTS_FAILURE"
            • "NOT_CONVERGING"
            • "UNSTABLE_NETWORK"
            • "FAILED_TO_CREATE_SECURITY_GROUP"
            • "FAILED_TO_LAUNCH_REPLICATION_SERVER"
            • "FAILED_TO_BOOT_REPLICATION_SERVER"
            • "FAILED_TO_AUTHENTICATE_WITH_SERVICE"
            • "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE"
            • "FAILED_TO_CREATE_STAGING_DISKS"
            • "FAILED_TO_ATTACH_STAGING_DISKS"
            • "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT"
            • "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER"
            • "FAILED_TO_START_DATA_TRANSFER"
          • rawError — (String)

            Error in data replication.

        • dataReplicationInitiation — (map)

          Information about whether the data replication has been initiated.

          • nextAttemptDateTime — (String)

            The date and time of the next attempt to initiate data replication.

          • startDateTime — (String)

            The date and time of the current attempt to initiate data replication.

          • steps — (Array<map>)

            The steps of the current attempt to initiate data replication.

            • name — (String)

              The name of the step.

              Possible values include:
              • "WAIT"
              • "CREATE_SECURITY_GROUP"
              • "LAUNCH_REPLICATION_SERVER"
              • "BOOT_REPLICATION_SERVER"
              • "AUTHENTICATE_WITH_SERVICE"
              • "DOWNLOAD_REPLICATION_SOFTWARE"
              • "CREATE_STAGING_DISKS"
              • "ATTACH_STAGING_DISKS"
              • "PAIR_REPLICATION_SERVER_WITH_AGENT"
              • "CONNECT_AGENT_TO_REPLICATION_SERVER"
              • "START_DATA_TRANSFER"
            • status — (String)

              The status of the step.

              Possible values include:
              • "NOT_STARTED"
              • "IN_PROGRESS"
              • "SUCCEEDED"
              • "FAILED"
              • "SKIPPED"
        • dataReplicationState — (String)

          The state of the data replication.

          Possible values include:
          • "STOPPED"
          • "INITIATING"
          • "INITIAL_SYNC"
          • "BACKLOG"
          • "CREATING_SNAPSHOT"
          • "CONTINUOUS"
          • "PAUSED"
          • "RESCAN"
          • "STALLED"
          • "DISCONNECTED"
        • etaDateTime — (String)

          An estimate of when the data replication will be completed.

        • lagDuration — (String)

          Data replication lag duration.

        • replicatedDisks — (Array<map>)

          The disks that should be replicated.

          • backloggedStorageBytes — (Integer)

            The size of the replication backlog in bytes.

          • deviceName — (String)

            The name of the device.

          • replicatedStorageBytes — (Integer)

            The amount of data replicated so far in bytes.

          • rescannedStorageBytes — (Integer)

            The amount of data to be rescanned in bytes.

          • totalStorageBytes — (Integer)

            The total amount of data to be replicated in bytes.

      • lastLaunchResult — (String)

        The status of the last recovery launch of this Source Server.

        Possible values include:
        • "NOT_STARTED"
        • "PENDING"
        • "SUCCEEDED"
        • "FAILED"
      • lifeCycle — (map)

        The lifecycle information of this Source Server.

        • addedToServiceDateTime — (String)

          The date and time of when the Source Server was added to the service.

        • elapsedReplicationDuration — (String)

          The amount of time that the Source Server has been replicating for.

        • firstByteDateTime — (String)

          The date and time of the first byte that was replicated from the Source Server.

        • lastLaunch — (map)

          An object containing information regarding the last launch of the Source Server.

          • initiated — (map)

            An object containing information regarding the initiation of the last launch of a Source Server.

            • apiCallDateTime — (String)

              The date and time the last Source Server launch was initiated.

            • jobID — (String)

              The ID of the Job that was used to last launch the Source Server.

            • type — (String)

              The Job type that was used to last launch the Source Server.

              Possible values include:
              • "RECOVERY"
              • "DRILL"
        • lastSeenByServiceDateTime — (String)

          The date and time this Source Server was last seen by the service.

      • recoveryInstanceId — (String)

        The ID of the Recovery Instance associated with this Source Server.

      • sourceProperties — (map)

        The source properties of the Source Server.

        • cpus — (Array<map>)

          An array of CPUs.

          • cores — (Integer)

            The number of CPU cores.

          • modelName — (String)

            The model name of the CPU.

        • disks — (Array<map>)

          An array of disks.

          • bytes — (Integer)

            The amount of storage on the disk in bytes.

          • deviceName — (String)

            The disk or device name.

        • identificationHints — (map)

          Hints used to uniquely identify a machine.

          • awsInstanceID — (String)

            AWS Instance ID identification hint.

          • fqdn — (String)

            Fully Qualified Domain Name identification hint.

          • hostname — (String)

            Hostname identification hint.

          • vmWareUuid — (String)

            vCenter VM path identification hint.

        • lastUpdatedDateTime — (String)

          The date and time the Source Properties were last updated on.

        • networkInterfaces — (Array<map>)

          An array of network interfaces.

          • ips — (Array<String>)

            Network interface IPs.

          • isPrimary — (Boolean)

            Whether this is the primary network interface.

          • macAddress — (String)

            The MAC address of the network interface.

        • os — (map)

          Operating system.

          • fullString — (String)

            The long name of the Operating System.

        • ramBytes — (Integer)

          The amount of RAM in bytes.

        • recommendedInstanceType — (String)

          The recommended EC2 instance type that will be used when recovering the Source Server.

      • sourceServerID — (String)

        The ID of the Source Server.

      • stagingArea — (map)

        The staging area of the source server.

        • errorMessage — (String)

          Shows an error message that occurred when DRS tried to access the staging source server. In this case StagingArea$status will have value EXTENSION_ERROR

        • stagingAccountID — (String)

          Account ID of the account to which source server belongs. If this source server is extended - shows Account ID of staging source server.

        • stagingSourceServerArn — (String)

          Arn of the staging source server if this source server is extended

        • status — (String)

          Status of Source server extension. Possible values: (a) NOT_EXTENDED - This is a source server that is replicating in the current account. (b) EXTENDED - Source server is extended from a staging source server. In this case, the value of stagingSourceServerArn is pointing to the Arn of the source server in the staging account. (c) EXTENSION_ERROR - Some issue occurred when accessing staging source server. In this case, errorMessage field will contain an error message that explains what happened.

          Possible values include:
          • "EXTENDED"
          • "EXTENSION_ERROR"
          • "NOT_EXTENDED"
      • tags — (map<String>)

        The tags associated with the Source Server.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getFailbackReplicationConfiguration(params = {}, callback) ⇒ AWS.Request

Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.

Examples:

Calling the getFailbackReplicationConfiguration operation

var params = {
  recoveryInstanceID: 'STRING_VALUE' /* required */
};
drs.getFailbackReplicationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • recoveryInstanceID — (String)

      The ID of the Recovery Instance whose failback replication configuration should be returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • bandwidthThrottling — (Integer)

        Configure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.

      • name — (String)

        The name of the Failback Replication Configuration.

      • recoveryInstanceID — (String)

        The ID of the Recovery Instance.

      • usePrivateIP — (Boolean)

        Whether to use Private IP for the failback replication of the Recovery Instance.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getLaunchConfiguration(params = {}, callback) ⇒ AWS.Request

Gets a LaunchConfiguration, filtered by Source Server IDs.

Service Reference:

Examples:

Calling the getLaunchConfiguration operation

var params = {
  sourceServerID: 'STRING_VALUE' /* required */
};
drs.getLaunchConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • sourceServerID — (String)

      The ID of the Source Server that we want to retrieve a Launch Configuration for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • copyPrivateIp — (Boolean)

        Whether we should copy the Private IP of the Source Server to the Recovery Instance.

      • copyTags — (Boolean)

        Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.

      • ec2LaunchTemplateID — (String)

        The EC2 launch template ID of this launch configuration.

      • launchDisposition — (String)

        The state of the Recovery Instance in EC2 after the recovery operation.

        Possible values include:
        • "STOPPED"
        • "STARTED"
      • licensing — (map)

        The licensing configuration to be used for this launch configuration.

        • osByol — (Boolean)

          Whether to enable "Bring your own license" or not.

      • name — (String)

        The name of the launch configuration.

      • sourceServerID — (String)

        The ID of the Source Server for this launch configuration.

      • targetInstanceTypeRightSizingMethod — (String)

        Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.

        Possible values include:
        • "NONE"
        • "BASIC"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getReplicationConfiguration(params = {}, callback) ⇒ AWS.Request

Gets a ReplicationConfiguration, filtered by Source Server ID.

Service Reference:

Examples:

Calling the getReplicationConfiguration operation

var params = {
  sourceServerID: 'STRING_VALUE' /* required */
};
drs.getReplicationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • sourceServerID — (String)

      The ID of the Source Serve for this Replication Configuration.r

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • associateDefaultSecurityGroup — (Boolean)

        Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.

      • bandwidthThrottling — (Integer)

        Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

      • createPublicIP — (Boolean)

        Whether to create a Public IP for the Recovery Instance by default.

      • dataPlaneRouting — (String)

        The data plane routing mechanism that will be used for replication.

        Possible values include:
        • "PRIVATE_IP"
        • "PUBLIC_IP"
      • defaultLargeStagingDiskType — (String)

        The Staging Disk EBS volume type to be used during replication.

        Possible values include:
        • "GP2"
        • "GP3"
        • "ST1"
        • "AUTO"
      • ebsEncryption — (String)

        The type of EBS encryption to be used during replication.

        Possible values include:
        • "DEFAULT"
        • "CUSTOM"
      • ebsEncryptionKeyArn — (String)

        The ARN of the EBS encryption key to be used during replication.

      • name — (String)

        The name of the Replication Configuration.

      • pitPolicy — (Array<map>)

        The Point in time (PIT) policy to manage snapshots taken during replication.

        • enabled — (Boolean)

          Whether this rule is enabled or not.

        • intervalrequired — (Integer)

          How often, in the chosen units, a snapshot should be taken.

        • retentionDurationrequired — (Integer)

          The duration to retain a snapshot for, in the chosen units.

        • ruleID — (Integer)

          The ID of the rule.

        • unitsrequired — (String)

          The units used to measure the interval and retentionDuration.

          Possible values include:
          • "MINUTE"
          • "HOUR"
          • "DAY"
      • replicatedDisks — (Array<map>)

        The configuration of the disks of the Source Server to be replicated.

        • deviceName — (String)

          The name of the device.

        • iops — (Integer)

          The requested number of I/O operations per second (IOPS).

        • isBootDisk — (Boolean)

          Whether to boot from this disk or not.

        • optimizedStagingDiskType — (String)

          The Staging Disk EBS volume type to be used during replication when stagingDiskType is set to Auto. This is a read-only field.

          Possible values include:
          • "AUTO"
          • "GP2"
          • "GP3"
          • "IO1"
          • "SC1"
          • "ST1"
          • "STANDARD"
        • stagingDiskType — (String)

          The Staging Disk EBS volume type to be used during replication.

          Possible values include:
          • "AUTO"
          • "GP2"
          • "GP3"
          • "IO1"
          • "SC1"
          • "ST1"
          • "STANDARD"
        • throughput — (Integer)

          The throughput to use for the EBS volume in MiB/s. This parameter is valid only for gp3 volumes.

      • replicationServerInstanceType — (String)

        The instance type to be used for the replication server.

      • replicationServersSecurityGroupsIDs — (Array<String>)

        The security group IDs that will be used by the replication server.

      • sourceServerID — (String)

        The ID of the Source Server for this Replication Configuration.

      • stagingAreaSubnetId — (String)

        The subnet to be used by the replication staging area.

      • stagingAreaTags — (map<String>)

        A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

      • useDedicatedReplicationServer — (Boolean)

        Whether to use a dedicated Replication Server in the replication staging area.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

initializeService(params = {}, callback) ⇒ AWS.Request

Initialize Elastic Disaster Recovery.

Service Reference:

Examples:

Calling the initializeService operation

var params = {
};
drs.initializeService(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listExtensibleSourceServers(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listExtensibleSourceServers operation

var params = {
  stagingAccountID: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
drs.listExtensibleSourceServers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of extensible source servers to retrieve.

    • nextToken — (String)

      The token of the next extensible source server to retrieve.

    • stagingAccountID — (String)

      The Id of the staging Account to retrieve extensible source servers from.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • items — (Array<map>)

        A list of source servers on a staging Account that are extensible.

        • arn — (String)

          The ARN of the source server.

        • hostname — (String)

          Hostname of staging source server.

        • tags — (map<String>)

          A list of tags associated with the staging source server.

      • nextToken — (String)

        The token of the next extensible source server to retrieve.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listStagingAccounts(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listStagingAccounts operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
drs.listStagingAccounts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of staging Accounts to retrieve.

    • nextToken — (String)

      The token of the next staging Account to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accounts — (Array<map>)

        An array of staging AWS Accounts.

        • accountID — (String)

          Account ID of AWS account.

      • nextToken — (String)

        The token of the next staging Account to retrieve.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

List all tags for your Elastic Disaster Recovery resources.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
drs.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The ARN of the resource whose tags should be returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        The tags of the requested resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

retryDataReplication(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the retryDataReplication operation

var params = {
  sourceServerID: 'STRING_VALUE' /* required */
};
drs.retryDataReplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • sourceServerID — (String)

      The ID of the Source Server whose data replication should be retried.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • arn — (String)

        The ARN of the Source Server.

      • dataReplicationInfo — (map)

        The Data Replication Info of the Source Server.

        • dataReplicationError — (map)

          Error in data replication.

          • error — (String)

            Error in data replication.

            Possible values include:
            • "AGENT_NOT_SEEN"
            • "SNAPSHOTS_FAILURE"
            • "NOT_CONVERGING"
            • "UNSTABLE_NETWORK"
            • "FAILED_TO_CREATE_SECURITY_GROUP"
            • "FAILED_TO_LAUNCH_REPLICATION_SERVER"
            • "FAILED_TO_BOOT_REPLICATION_SERVER"
            • "FAILED_TO_AUTHENTICATE_WITH_SERVICE"
            • "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE"
            • "FAILED_TO_CREATE_STAGING_DISKS"
            • "FAILED_TO_ATTACH_STAGING_DISKS"
            • "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT"
            • "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER"
            • "FAILED_TO_START_DATA_TRANSFER"
          • rawError — (String)

            Error in data replication.

        • dataReplicationInitiation — (map)

          Information about whether the data replication has been initiated.

          • nextAttemptDateTime — (String)

            The date and time of the next attempt to initiate data replication.

          • startDateTime — (String)

            The date and time of the current attempt to initiate data replication.

          • steps — (Array<map>)

            The steps of the current attempt to initiate data replication.

            • name — (String)

              The name of the step.

              Possible values include:
              • "WAIT"
              • "CREATE_SECURITY_GROUP"
              • "LAUNCH_REPLICATION_SERVER"
              • "BOOT_REPLICATION_SERVER"
              • "AUTHENTICATE_WITH_SERVICE"
              • "DOWNLOAD_REPLICATION_SOFTWARE"
              • "CREATE_STAGING_DISKS"
              • "ATTACH_STAGING_DISKS"
              • "PAIR_REPLICATION_SERVER_WITH_AGENT"
              • "CONNECT_AGENT_TO_REPLICATION_SERVER"
              • "START_DATA_TRANSFER"
            • status — (String)

              The status of the step.

              Possible values include:
              • "NOT_STARTED"
              • "IN_PROGRESS"
              • "SUCCEEDED"
              • "FAILED"
              • "SKIPPED"
        • dataReplicationState — (String)

          The state of the data replication.

          Possible values include:
          • "STOPPED"
          • "INITIATING"
          • "INITIAL_SYNC"
          • "BACKLOG"
          • "CREATING_SNAPSHOT"
          • "CONTINUOUS"
          • "PAUSED"
          • "RESCAN"
          • "STALLED"
          • "DISCONNECTED"
        • etaDateTime — (String)

          An estimate of when the data replication will be completed.

        • lagDuration — (String)

          Data replication lag duration.

        • replicatedDisks — (Array<map>)

          The disks that should be replicated.

          • backloggedStorageBytes — (Integer)

            The size of the replication backlog in bytes.

          • deviceName — (String)

            The name of the device.

          • replicatedStorageBytes — (Integer)

            The amount of data replicated so far in bytes.

          • rescannedStorageBytes — (Integer)

            The amount of data to be rescanned in bytes.

          • totalStorageBytes — (Integer)

            The total amount of data to be replicated in bytes.

      • lastLaunchResult — (String)

        The status of the last recovery launch of this Source Server.

        Possible values include:
        • "NOT_STARTED"
        • "PENDING"
        • "SUCCEEDED"
        • "FAILED"
      • lifeCycle — (map)

        The lifecycle information of this Source Server.

        • addedToServiceDateTime — (String)

          The date and time of when the Source Server was added to the service.

        • elapsedReplicationDuration — (String)

          The amount of time that the Source Server has been replicating for.

        • firstByteDateTime — (String)

          The date and time of the first byte that was replicated from the Source Server.

        • lastLaunch — (map)

          An object containing information regarding the last launch of the Source Server.

          • initiated — (map)

            An object containing information regarding the initiation of the last launch of a Source Server.

            • apiCallDateTime — (String)

              The date and time the last Source Server launch was initiated.

            • jobID — (String)

              The ID of the Job that was used to last launch the Source Server.

            • type — (String)

              The Job type that was used to last launch the Source Server.

              Possible values include:
              • "RECOVERY"
              • "DRILL"
        • lastSeenByServiceDateTime — (String)

          The date and time this Source Server was last seen by the service.

      • recoveryInstanceId — (String)

        The ID of the Recovery Instance associated with this Source Server.

      • sourceProperties — (map)

        The source properties of the Source Server.

        • cpus — (Array<map>)

          An array of CPUs.

          • cores — (Integer)

            The number of CPU cores.

          • modelName — (String)

            The model name of the CPU.

        • disks — (Array<map>)

          An array of disks.

          • bytes — (Integer)

            The amount of storage on the disk in bytes.

          • deviceName — (String)

            The disk or device name.

        • identificationHints — (map)

          Hints used to uniquely identify a machine.

          • awsInstanceID — (String)

            AWS Instance ID identification hint.

          • fqdn — (String)

            Fully Qualified Domain Name identification hint.

          • hostname — (String)

            Hostname identification hint.

          • vmWareUuid — (String)

            vCenter VM path identification hint.

        • lastUpdatedDateTime — (String)

          The date and time the Source Properties were last updated on.

        • networkInterfaces — (Array<map>)

          An array of network interfaces.

          • ips — (Array<String>)

            Network interface IPs.

          • isPrimary — (Boolean)

            Whether this is the primary network interface.

          • macAddress — (String)

            The MAC address of the network interface.

        • os — (map)

          Operating system.

          • fullString — (String)

            The long name of the Operating System.

        • ramBytes — (Integer)

          The amount of RAM in bytes.

        • recommendedInstanceType — (String)

          The recommended EC2 instance type that will be used when recovering the Source Server.

      • sourceServerID — (String)

        The ID of the Source Server.

      • stagingArea — (map)

        The staging area of the source server.

        • errorMessage — (String)

          Shows an error message that occurred when DRS tried to access the staging source server. In this case StagingArea$status will have value EXTENSION_ERROR

        • stagingAccountID — (String)

          Account ID of the account to which source server belongs. If this source server is extended - shows Account ID of staging source server.

        • stagingSourceServerArn — (String)

          Arn of the staging source server if this source server is extended

        • status — (String)

          Status of Source server extension. Possible values: (a) NOT_EXTENDED - This is a source server that is replicating in the current account. (b) EXTENDED - Source server is extended from a staging source server. In this case, the value of stagingSourceServerArn is pointing to the Arn of the source server in the staging account. (c) EXTENSION_ERROR - Some issue occurred when accessing staging source server. In this case, errorMessage field will contain an error message that explains what happened.

          Possible values include:
          • "EXTENDED"
          • "EXTENSION_ERROR"
          • "NOT_EXTENDED"
      • tags — (map<String>)

        The tags associated with the Source Server.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startFailbackLaunch(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the startFailbackLaunch operation

var params = {
  recoveryInstanceIDs: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
drs.startFailbackLaunch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • recoveryInstanceIDs — (Array<String>)

      The IDs of the Recovery Instance whose failback launch we want to request.

    • tags — (map<String>)

      The tags to be associated with the failback launch Job.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • job — (map)

        The failback launch Job.

        • arn — (String)

          The ARN of a Job.

        • creationDateTime — (String)

          The date and time of when the Job was created.

        • endDateTime — (String)

          The date and time of when the Job ended.

        • initiatedBy — (String)

          A string representing who initiated the Job.

          Possible values include:
          • "START_RECOVERY"
          • "START_DRILL"
          • "FAILBACK"
          • "DIAGNOSTIC"
          • "TERMINATE_RECOVERY_INSTANCES"
          • "TARGET_ACCOUNT"
        • jobIDrequired — (String)

          The ID of the Job.

        • participatingServers — (Array<map>)

          A list of servers that the Job is acting upon.

          • launchStatus — (String)

            The launch status of a participating server.

            Possible values include:
            • "PENDING"
            • "IN_PROGRESS"
            • "LAUNCHED"
            • "FAILED"
            • "TERMINATED"
          • recoveryInstanceID — (String)

            The Recovery Instance ID of a participating server.

          • sourceServerID — (String)

            The Source Server ID of a participating server.

        • status — (String)

          The status of the Job.

          Possible values include:
          • "PENDING"
          • "STARTED"
          • "COMPLETED"
        • tags — (map<String>)

          A list of tags associated with the Job.

        • type — (String)

          The type of the Job.

          Possible values include:
          • "LAUNCH"
          • "TERMINATE"
          • "CREATE_CONVERTED_SNAPSHOT"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startRecovery(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the startRecovery operation

var params = {
  sourceServers: [ /* required */
    {
      sourceServerID: 'STRING_VALUE', /* required */
      recoverySnapshotID: 'STRING_VALUE'
    },
    /* more items */
  ],
  isDrill: true || false,
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
drs.startRecovery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • isDrill — (Boolean)

      Whether this Source Server Recovery operation is a drill or not.

    • sourceServers — (Array<map>)

      The Source Servers that we want to start a Recovery Job for.

      • recoverySnapshotID — (String)

        The ID of a Recovery Snapshot we want to recover from. Omit this field to launch from the latest data by taking an on-demand snapshot.

      • sourceServerIDrequired — (String)

        The ID of the Source Server you want to recover.

    • tags — (map<String>)

      The tags to be associated with the Recovery Job.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • job — (map)

        The Recovery Job.

        • arn — (String)

          The ARN of a Job.

        • creationDateTime — (String)

          The date and time of when the Job was created.

        • endDateTime — (String)

          The date and time of when the Job ended.

        • initiatedBy — (String)

          A string representing who initiated the Job.

          Possible values include:
          • "START_RECOVERY"
          • "START_DRILL"
          • "FAILBACK"
          • "DIAGNOSTIC"
          • "TERMINATE_RECOVERY_INSTANCES"
          • "TARGET_ACCOUNT"
        • jobIDrequired — (String)

          The ID of the Job.

        • participatingServers — (Array<map>)

          A list of servers that the Job is acting upon.

          • launchStatus — (String)

            The launch status of a participating server.

            Possible values include:
            • "PENDING"
            • "IN_PROGRESS"
            • "LAUNCHED"
            • "FAILED"
            • "TERMINATED"
          • recoveryInstanceID — (String)

            The Recovery Instance ID of a participating server.

          • sourceServerID — (String)

            The Source Server ID of a participating server.

        • status — (String)

          The status of the Job.

          Possible values include:
          • "PENDING"
          • "STARTED"
          • "COMPLETED"
        • tags — (map<String>)

          A list of tags associated with the Job.

        • type — (String)

          The type of the Job.

          Possible values include:
          • "LAUNCH"
          • "TERMINATE"
          • "CREATE_CONVERTED_SNAPSHOT"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopFailback(params = {}, callback) ⇒ AWS.Request

Stops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED.

Service Reference:

Examples:

Calling the stopFailback operation

var params = {
  recoveryInstanceID: 'STRING_VALUE' /* required */
};
drs.stopFailback(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • recoveryInstanceID — (String)

      The ID of the Recovery Instance we want to stop failback for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
drs.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      ARN of the resource for which tags are to be added or updated.

    • tags — (map<String>)

      Array of tags to be added or updated.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

terminateRecoveryInstances(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the terminateRecoveryInstances operation

var params = {
  recoveryInstanceIDs: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
drs.terminateRecoveryInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • recoveryInstanceIDs — (Array<String>)

      The IDs of the Recovery Instances that should be terminated.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • job — (map)

        The Job for terminating the Recovery Instances.

        • arn — (String)

          The ARN of a Job.

        • creationDateTime — (String)

          The date and time of when the Job was created.

        • endDateTime — (String)

          The date and time of when the Job ended.

        • initiatedBy — (String)

          A string representing who initiated the Job.

          Possible values include:
          • "START_RECOVERY"
          • "START_DRILL"
          • "FAILBACK"
          • "DIAGNOSTIC"
          • "TERMINATE_RECOVERY_INSTANCES"
          • "TARGET_ACCOUNT"
        • jobIDrequired — (String)

          The ID of the Job.

        • participatingServers — (Array<map>)

          A list of servers that the Job is acting upon.

          • launchStatus — (String)

            The launch status of a participating server.

            Possible values include:
            • "PENDING"
            • "IN_PROGRESS"
            • "LAUNCHED"
            • "FAILED"
            • "TERMINATED"
          • recoveryInstanceID — (String)

            The Recovery Instance ID of a participating server.

          • sourceServerID — (String)

            The Source Server ID of a participating server.

        • status — (String)

          The status of the Job.

          Possible values include:
          • "PENDING"
          • "STARTED"
          • "COMPLETED"
        • tags — (map<String>)

          A list of tags associated with the Job.

        • type — (String)

          The type of the Job.

          Possible values include:
          • "LAUNCH"
          • "TERMINATE"
          • "CREATE_CONVERTED_SNAPSHOT"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
drs.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      ARN of the resource for which tags are to be removed.

    • tagKeys — (Array<String>)

      Array of tags to be removed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateFailbackReplicationConfiguration(params = {}, callback) ⇒ AWS.Request

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

Examples:

Calling the updateFailbackReplicationConfiguration operation

var params = {
  recoveryInstanceID: 'STRING_VALUE', /* required */
  bandwidthThrottling: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  usePrivateIP: true || false
};
drs.updateFailbackReplicationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • bandwidthThrottling — (Integer)

      Configure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.

    • name — (String)

      The name of the Failback Replication Configuration.

    • recoveryInstanceID — (String)

      The ID of the Recovery Instance.

    • usePrivateIP — (Boolean)

      Whether to use Private IP for the failback replication of the Recovery Instance.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateLaunchConfiguration(params = {}, callback) ⇒ AWS.Request

Updates a LaunchConfiguration by Source Server ID.

Service Reference:

Examples:

Calling the updateLaunchConfiguration operation

var params = {
  sourceServerID: 'STRING_VALUE', /* required */
  copyPrivateIp: true || false,
  copyTags: true || false,
  launchDisposition: STOPPED | STARTED,
  licensing: {
    osByol: true || false
  },
  name: 'STRING_VALUE',
  targetInstanceTypeRightSizingMethod: NONE | BASIC
};
drs.updateLaunchConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • copyPrivateIp — (Boolean)

      Whether we should copy the Private IP of the Source Server to the Recovery Instance.

    • copyTags — (Boolean)

      Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.

    • launchDisposition — (String)

      The state of the Recovery Instance in EC2 after the recovery operation.

      Possible values include:
      • "STOPPED"
      • "STARTED"
    • licensing — (map)

      The licensing configuration to be used for this launch configuration.

      • osByol — (Boolean)

        Whether to enable "Bring your own license" or not.

    • name — (String)

      The name of the launch configuration.

    • sourceServerID — (String)

      The ID of the Source Server that we want to retrieve a Launch Configuration for.

    • targetInstanceTypeRightSizingMethod — (String)

      Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.

      Possible values include:
      • "NONE"
      • "BASIC"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • copyPrivateIp — (Boolean)

        Whether we should copy the Private IP of the Source Server to the Recovery Instance.

      • copyTags — (Boolean)

        Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.

      • ec2LaunchTemplateID — (String)

        The EC2 launch template ID of this launch configuration.

      • launchDisposition — (String)

        The state of the Recovery Instance in EC2 after the recovery operation.

        Possible values include:
        • "STOPPED"
        • "STARTED"
      • licensing — (map)

        The licensing configuration to be used for this launch configuration.

        • osByol — (Boolean)

          Whether to enable "Bring your own license" or not.

      • name — (String)

        The name of the launch configuration.

      • sourceServerID — (String)

        The ID of the Source Server for this launch configuration.

      • targetInstanceTypeRightSizingMethod — (String)

        Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.

        Possible values include:
        • "NONE"
        • "BASIC"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateReplicationConfiguration(params = {}, callback) ⇒ AWS.Request

Allows you to update a ReplicationConfiguration by Source Server ID.

Service Reference:

Examples:

Calling the updateReplicationConfiguration operation

var params = {
  sourceServerID: 'STRING_VALUE', /* required */
  associateDefaultSecurityGroup: true || false,
  bandwidthThrottling: 'NUMBER_VALUE',
  createPublicIP: true || false,
  dataPlaneRouting: PRIVATE_IP | PUBLIC_IP,
  defaultLargeStagingDiskType: GP2 | GP3 | ST1 | AUTO,
  ebsEncryption: DEFAULT | CUSTOM,
  ebsEncryptionKeyArn: 'STRING_VALUE',
  name: 'STRING_VALUE',
  pitPolicy: [
    {
      interval: 'NUMBER_VALUE', /* required */
      retentionDuration: 'NUMBER_VALUE', /* required */
      units: MINUTE | HOUR | DAY, /* required */
      enabled: true || false,
      ruleID: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  replicatedDisks: [
    {
      deviceName: 'STRING_VALUE',
      iops: 'NUMBER_VALUE',
      isBootDisk: true || false,
      optimizedStagingDiskType: AUTO | GP2 | GP3 | IO1 | SC1 | ST1 | STANDARD,
      stagingDiskType: AUTO | GP2 | GP3 | IO1 | SC1 | ST1 | STANDARD,
      throughput: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  replicationServerInstanceType: 'STRING_VALUE',
  replicationServersSecurityGroupsIDs: [
    'STRING_VALUE',
    /* more items */
  ],
  stagingAreaSubnetId: 'STRING_VALUE',
  stagingAreaTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  useDedicatedReplicationServer: true || false
};
drs.updateReplicationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • associateDefaultSecurityGroup — (Boolean)

      Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.

    • bandwidthThrottling — (Integer)

      Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

    • createPublicIP — (Boolean)

      Whether to create a Public IP for the Recovery Instance by default.

    • dataPlaneRouting — (String)

      The data plane routing mechanism that will be used for replication.

      Possible values include:
      • "PRIVATE_IP"
      • "PUBLIC_IP"
    • defaultLargeStagingDiskType — (String)

      The Staging Disk EBS volume type to be used during replication.

      Possible values include:
      • "GP2"
      • "GP3"
      • "ST1"
      • "AUTO"
    • ebsEncryption — (String)

      The type of EBS encryption to be used during replication.

      Possible values include:
      • "DEFAULT"
      • "CUSTOM"
    • ebsEncryptionKeyArn — (String)

      The ARN of the EBS encryption key to be used during replication.

    • name — (String)

      The name of the Replication Configuration.

    • pitPolicy — (Array<map>)

      The Point in time (PIT) policy to manage snapshots taken during replication.

      • enabled — (Boolean)

        Whether this rule is enabled or not.

      • intervalrequired — (Integer)

        How often, in the chosen units, a snapshot should be taken.

      • retentionDurationrequired — (Integer)

        The duration to retain a snapshot for, in the chosen units.

      • ruleID — (Integer)

        The ID of the rule.

      • unitsrequired — (String)

        The units used to measure the interval and retentionDuration.

        Possible values include:
        • "MINUTE"
        • "HOUR"
        • "DAY"
    • replicatedDisks — (Array<map>)

      The configuration of the disks of the Source Server to be replicated.

      • deviceName — (String)

        The name of the device.

      • iops — (Integer)

        The requested number of I/O operations per second (IOPS).

      • isBootDisk — (Boolean)

        Whether to boot from this disk or not.

      • optimizedStagingDiskType — (String)

        The Staging Disk EBS volume type to be used during replication when stagingDiskType is set to Auto. This is a read-only field.

        Possible values include:
        • "AUTO"
        • "GP2"
        • "GP3"
        • "IO1"
        • "SC1"
        • "ST1"
        • "STANDARD"
      • stagingDiskType — (String)

        The Staging Disk EBS volume type to be used during replication.

        Possible values include:
        • "AUTO"
        • "GP2"
        • "GP3"
        • "IO1"
        • "SC1"
        • "ST1"
        • "STANDARD"
      • throughput — (Integer)

        The throughput to use for the EBS volume in MiB/s. This parameter is valid only for gp3 volumes.

    • replicationServerInstanceType — (String)

      The instance type to be used for the replication server.

    • replicationServersSecurityGroupsIDs — (Array<String>)

      The security group IDs that will be used by the replication server.

    • sourceServerID — (String)

      The ID of the Source Server for this Replication Configuration.

    • stagingAreaSubnetId — (String)

      The subnet to be used by the replication staging area.

    • stagingAreaTags — (map<String>)

      A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

    • useDedicatedReplicationServer — (Boolean)

      Whether to use a dedicated Replication Server in the replication staging area.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • associateDefaultSecurityGroup — (Boolean)

        Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.

      • bandwidthThrottling — (Integer)

        Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

      • createPublicIP — (Boolean)

        Whether to create a Public IP for the Recovery Instance by default.

      • dataPlaneRouting — (String)

        The data plane routing mechanism that will be used for replication.

        Possible values include:
        • "PRIVATE_IP"
        • "PUBLIC_IP"
      • defaultLargeStagingDiskType — (String)

        The Staging Disk EBS volume type to be used during replication.

        Possible values include:
        • "GP2"
        • "GP3"
        • "ST1"
        • "AUTO"
      • ebsEncryption — (String)

        The type of EBS encryption to be used during replication.

        Possible values include:
        • "DEFAULT"
        • "CUSTOM"
      • ebsEncryptionKeyArn — (String)

        The ARN of the EBS encryption key to be used during replication.

      • name — (String)

        The name of the Replication Configuration.

      • pitPolicy — (Array<map>)

        The Point in time (PIT) policy to manage snapshots taken during replication.

        • enabled — (Boolean)

          Whether this rule is enabled or not.

        • intervalrequired — (Integer)

          How often, in the chosen units, a snapshot should be taken.

        • retentionDurationrequired — (Integer)

          The duration to retain a snapshot for, in the chosen units.

        • ruleID — (Integer)

          The ID of the rule.

        • unitsrequired — (String)

          The units used to measure the interval and retentionDuration.

          Possible values include:
          • "MINUTE"
          • "HOUR"
          • "DAY"
      • replicatedDisks — (Array<map>)

        The configuration of the disks of the Source Server to be replicated.

        • deviceName — (String)

          The name of the device.

        • iops — (Integer)

          The requested number of I/O operations per second (IOPS).

        • isBootDisk — (Boolean)

          Whether to boot from this disk or not.

        • optimizedStagingDiskType — (String)

          The Staging Disk EBS volume type to be used during replication when stagingDiskType is set to Auto. This is a read-only field.

          Possible values include:
          • "AUTO"
          • "GP2"
          • "GP3"
          • "IO1"
          • "SC1"
          • "ST1"
          • "STANDARD"
        • stagingDiskType — (String)

          The Staging Disk EBS volume type to be used during replication.

          Possible values include:
          • "AUTO"
          • "GP2"
          • "GP3"
          • "IO1"
          • "SC1"
          • "ST1"
          • "STANDARD"
        • throughput — (Integer)

          The throughput to use for the EBS volume in MiB/s. This parameter is valid only for gp3 volumes.

      • replicationServerInstanceType — (String)

        The instance type to be used for the replication server.

      • replicationServersSecurityGroupsIDs — (Array<String>)

        The security group IDs that will be used by the replication server.

      • sourceServerID — (String)

        The ID of the Source Server for this Replication Configuration.

      • stagingAreaSubnetId — (String)

        The subnet to be used by the replication staging area.

      • stagingAreaTags — (map<String>)

        A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

      • useDedicatedReplicationServer — (Boolean)

        Whether to use a dedicated Replication Server in the replication staging area.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateReplicationConfigurationTemplate(params = {}, callback) ⇒ AWS.Request

Updates a ReplicationConfigurationTemplate by ID.

Examples:

Calling the updateReplicationConfigurationTemplate operation

var params = {
  replicationConfigurationTemplateID: 'STRING_VALUE', /* required */
  arn: 'STRING_VALUE',
  associateDefaultSecurityGroup: true || false,
  bandwidthThrottling: 'NUMBER_VALUE',
  createPublicIP: true || false,
  dataPlaneRouting: PRIVATE_IP | PUBLIC_IP,
  defaultLargeStagingDiskType: GP2 | GP3 | ST1 | AUTO,
  ebsEncryption: DEFAULT | CUSTOM,
  ebsEncryptionKeyArn: 'STRING_VALUE',
  pitPolicy: [
    {
      interval: 'NUMBER_VALUE', /* required */
      retentionDuration: 'NUMBER_VALUE', /* required */
      units: MINUTE | HOUR | DAY, /* required */
      enabled: true || false,
      ruleID: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  replicationServerInstanceType: 'STRING_VALUE',
  replicationServersSecurityGroupsIDs: [
    'STRING_VALUE',
    /* more items */
  ],
  stagingAreaSubnetId: 'STRING_VALUE',
  stagingAreaTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  useDedicatedReplicationServer: true || false
};
drs.updateReplicationConfigurationTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • arn — (String)

      The Replication Configuration Template ARN.

    • associateDefaultSecurityGroup — (Boolean)

      Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

    • bandwidthThrottling — (Integer)

      Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

    • createPublicIP — (Boolean)

      Whether to create a Public IP for the Recovery Instance by default.

    • dataPlaneRouting — (String)

      The data plane routing mechanism that will be used for replication.

      Possible values include:
      • "PRIVATE_IP"
      • "PUBLIC_IP"
    • defaultLargeStagingDiskType — (String)

      The Staging Disk EBS volume type to be used during replication.

      Possible values include:
      • "GP2"
      • "GP3"
      • "ST1"
      • "AUTO"
    • ebsEncryption — (String)

      The type of EBS encryption to be used during replication.

      Possible values include:
      • "DEFAULT"
      • "CUSTOM"
    • ebsEncryptionKeyArn — (String)

      The ARN of the EBS encryption key to be used during replication.

    • pitPolicy — (Array<map>)

      The Point in time (PIT) policy to manage snapshots taken during replication.

      • enabled — (Boolean)

        Whether this rule is enabled or not.

      • intervalrequired — (Integer)

        How often, in the chosen units, a snapshot should be taken.

      • retentionDurationrequired — (Integer)

        The duration to retain a snapshot for, in the chosen units.

      • ruleID — (Integer)

        The ID of the rule.

      • unitsrequired — (String)

        The units used to measure the interval and retentionDuration.

        Possible values include:
        • "MINUTE"
        • "HOUR"
        • "DAY"
    • replicationConfigurationTemplateID — (String)

      The Replication Configuration Template ID.

    • replicationServerInstanceType — (String)

      The instance type to be used for the replication server.

    • replicationServersSecurityGroupsIDs — (Array<String>)

      The security group IDs that will be used by the replication server.

    • stagingAreaSubnetId — (String)

      The subnet to be used by the replication staging area.

    • stagingAreaTags — (map<String>)

      A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

    • useDedicatedReplicationServer — (Boolean)

      Whether to use a dedicated Replication Server in the replication staging area.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • arn — (String)

        The Replication Configuration Template ARN.

      • associateDefaultSecurityGroup — (Boolean)

        Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

      • bandwidthThrottling — (Integer)

        Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

      • createPublicIP — (Boolean)

        Whether to create a Public IP for the Recovery Instance by default.

      • dataPlaneRouting — (String)

        The data plane routing mechanism that will be used for replication.

        Possible values include:
        • "PRIVATE_IP"
        • "PUBLIC_IP"
      • defaultLargeStagingDiskType — (String)

        The Staging Disk EBS volume type to be used during replication.

        Possible values include:
        • "GP2"
        • "GP3"
        • "ST1"
        • "AUTO"
      • ebsEncryption — (String)

        The type of EBS encryption to be used during replication.

        Possible values include:
        • "DEFAULT"
        • "CUSTOM"
      • ebsEncryptionKeyArn — (String)

        The ARN of the EBS encryption key to be used during replication.

      • pitPolicy — (Array<map>)

        The Point in time (PIT) policy to manage snapshots taken during replication.

        • enabled — (Boolean)

          Whether this rule is enabled or not.

        • intervalrequired — (Integer)

          How often, in the chosen units, a snapshot should be taken.

        • retentionDurationrequired — (Integer)

          The duration to retain a snapshot for, in the chosen units.

        • ruleID — (Integer)

          The ID of the rule.

        • unitsrequired — (String)

          The units used to measure the interval and retentionDuration.

          Possible values include:
          • "MINUTE"
          • "HOUR"
          • "DAY"
      • replicationConfigurationTemplateID — (String)

        The Replication Configuration Template ID.

      • replicationServerInstanceType — (String)

        The instance type to be used for the replication server.

      • replicationServersSecurityGroupsIDs — (Array<String>)

        The security group IDs that will be used by the replication server.

      • stagingAreaSubnetId — (String)

        The subnet to be used by the replication staging area.

      • stagingAreaTags — (map<String>)

        A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

      • tags — (map<String>)

        A set of tags to be associated with the Replication Configuration Template resource.

      • useDedicatedReplicationServer — (Boolean)

        Whether to use a dedicated Replication Server in the replication staging area.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.