Class: AWS.Drs

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.

      • agentVersion — (String)

        The version of the DRS agent installed on the 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.

          • volumeStatus — (String)

            The status of the volume.

            Possible values include:
            • "REGULAR"
            • "CONTAINS_MARKETPLACE_PRODUCT_CODES"
            • "MISSING_VOLUME_ATTRIBUTES"
            • "MISSING_VOLUME_ATTRIBUTES_AND_PRECHECK_UNAVAILABLE"
            • "PENDING"
        • stagingAvailabilityZone — (String)

          AWS Availability zone into which data is being replicated.

        • stagingOutpostArn — (String)

          The ARN of the staging Outpost

      • 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"
          • status — (String)

            Status of Source Server's last launch.

            Possible values include:
            • "PENDING"
            • "IN_PROGRESS"
            • "LAUNCHED"
            • "FAILED"
            • "TERMINATED"
        • 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.

      • replicationDirection — (String)

        Replication direction of the Source Server.

        Possible values include:
        • "FAILOVER"
        • "FAILBACK"
      • reversedDirectionSourceServerArn — (String)

        For EC2-originated Source Servers which have been failed over and then failed back, this value will mean the ARN of the Source Server on the opposite replication direction.

      • sourceCloudProperties — (map)

        Source cloud properties of the Source Server.

        • originAccountID — (String)

          AWS Account ID for an EC2-originated Source Server.

        • originAvailabilityZone — (String)

          AWS Availability Zone for an EC2-originated Source Server.

        • originRegion — (String)

          AWS Region for an EC2-originated Source Server.

        • sourceOutpostArn — (String)

          The ARN of the source Outpost

      • sourceNetworkID — (String)

        ID of the Source Network which is protecting this Source Server's network.

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

        • supportsNitroInstances — (Boolean)

          Are EC2 nitro instance types supported 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.

var params = {
  copyPrivateIp: true || false,
  copyTags: true || false,
  exportBucketArn: 'STRING_VALUE',
  launchDisposition: STOPPED | STARTED,
  launchIntoSourceInstance: true || false,
  licensing: {
    osByol: true || false
  },
  postLaunchEnabled: true || false,
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  targetInstanceTypeRightSizingMethod: NONE | BASIC | IN_AWS
};
drs.createLaunchConfigurationTemplate(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)

    Copy private IP.

  • copyTags — (Boolean)

    Copy tags.

  • exportBucketArn — (String)

    S3 bucket ARN to export Source Network templates.

  • launchDisposition — (String)

    Launch disposition.

    Possible values include:
    • "STOPPED"
    • "STARTED"
  • launchIntoSourceInstance — (Boolean)

    DRS will set the 'launch into instance ID' of any source server when performing a drill, recovery or failback to the previous region or availability zone, using the instance ID of the source instance.

  • licensing — (map)

    Licensing.

    • osByol — (Boolean)

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

  • postLaunchEnabled — (Boolean)

    Whether we want to activate post-launch actions.

  • tags — (map<String>)

    Request to associate tags during creation of a Launch Configuration Template.

  • targetInstanceTypeRightSizingMethod — (String)

    Target instance type right-sizing method.

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

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:

    • launchConfigurationTemplate — (map)

      Created Launch Configuration Template.

      • arn — (String)

        ARN of the Launch Configuration Template.

      • copyPrivateIp — (Boolean)

        Copy private IP.

      • copyTags — (Boolean)

        Copy tags.

      • exportBucketArn — (String)

        S3 bucket ARN to export Source Network templates.

      • launchConfigurationTemplateID — (String)

        ID of the Launch Configuration Template.

      • launchDisposition — (String)

        Launch disposition.

        Possible values include:
        • "STOPPED"
        • "STARTED"
      • launchIntoSourceInstance — (Boolean)

        DRS will set the 'launch into instance ID' of any source server when performing a drill, recovery or failback to the previous region or availability zone, using the instance ID of the source instance.

      • licensing — (map)

        Licensing.

        • osByol — (Boolean)

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

      • postLaunchEnabled — (Boolean)

        Post-launch actions activated.

      • tags — (map<String>)

        Tags of the Launch Configuration Template.

      • targetInstanceTypeRightSizingMethod — (String)

        Target instance type right-sizing method.

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

Returns:

• (AWS.Request) —

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

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 | NONE, /* 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 */
  autoReplicateNewDisks: true || false,
  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.

  • autoReplicateNewDisks — (Boolean)

    Whether to allow the AWS replication agent to automatically replicate newly added disks.

  • 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"
    • "NONE"
  • 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.

    • interval — required — (Integer)

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

    • retentionDuration — required — (Integer)

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

    • ruleID — (Integer)

      The ID of the rule.

    • units — required — (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.

    • autoReplicateNewDisks — (Boolean)

      Whether to allow the AWS replication agent to automatically replicate newly added disks.

    • 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"
      • "NONE"
    • 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.

      • interval — required — (Integer)

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

      • retentionDuration — required — (Integer)

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

      • ruleID — (Integer)

        The ID of the rule.

      • units — required — (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.

var params = {
  originAccountID: 'STRING_VALUE', /* required */
  originRegion: 'STRING_VALUE', /* required */
  vpcID: 'STRING_VALUE', /* required */
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
drs.createSourceNetwork(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: {}) —
  • originAccountID — (String)

    Account containing the VPC to protect.

  • originRegion — (String)

    Region containing the VPC to protect.

  • tags — (map<String>)

    A set of tags to be associated with the Source Network resource.

  • vpcID — (String)

    Which VPC ID to protect.

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:

    • sourceNetworkID — (String)

      ID of the created Source Network.

Returns:

• (AWS.Request) —

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

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.

var params = {
  actionId: 'STRING_VALUE', /* required */
  resourceId: 'STRING_VALUE' /* required */
};
drs.deleteLaunchAction(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: {}) —
  • actionId — (String)

    Launch action Id.

  • resourceId — (String)

    Launch configuration template Id or 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.

Returns:

• (AWS.Request) —

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

var params = {
  launchConfigurationTemplateID: 'STRING_VALUE' /* required */
};
drs.deleteLaunchConfigurationTemplate(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: {}) —
  • launchConfigurationTemplateID — (String)

    The ID of the Launch 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.

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.

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.

var params = {
  sourceNetworkID: 'STRING_VALUE' /* required */
};
drs.deleteSourceNetwork(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: {}) —
  • sourceNetworkID — (String)

    ID of the Source Network to delete.

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.

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.

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"
        • "DEPLOY_NETWORK_CONFIGURATION_START"
        • "DEPLOY_NETWORK_CONFIGURATION_END"
        • "DEPLOY_NETWORK_CONFIGURATION_FAILED"
        • "UPDATE_NETWORK_CONFIGURATION_START"
        • "UPDATE_NETWORK_CONFIGURATION_END"
        • "UPDATE_NETWORK_CONFIGURATION_FAILED"
        • "UPDATE_LAUNCH_TEMPLATE_START"
        • "UPDATE_LAUNCH_TEMPLATE_END"
        • "UPDATE_LAUNCH_TEMPLATE_FAILED"
        • "NETWORK_RECOVERY_FAIL"
      • 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

          • volumeToProductCodes — (map<Array<map>>)

            A mapping between the volumes being converted and the product codes associated with them

            • productCodeId — (String)

              Id of a product code associated with a volume.

            • productCodeMode — (String)

              Mode of a product code associated with a volume.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
          • volumeToVolumeSize — (map<Integer>)

            A mapping between the volumes and their sizes

        • conversionServerID — (String)

          The ID of a conversion server.

        • eventResourceData — (map)

          Properties of resource related to a job event.

          • sourceNetworkData — (map)

            Source Network properties.

            • sourceNetworkID — (String)

              Source Network ID.

            • sourceVpc — (String)

              VPC ID protected by the Source Network.

            • stackName — (String)

              CloudFormation stack name that was deployed for recovering the Source Network.

            • targetVpc — (String)

              ID of the recovered VPC following Source Network recovery.

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

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"
        • "CREATE_NETWORK_RECOVERY"
        • "UPDATE_NETWORK_RECOVERY"
        • "ASSOCIATE_NETWORK_RECOVERY"
      • jobID — required — (String)

        The ID of the Job.

      • participatingResources — (Array<map>)

        A list of resources that the Job is acting upon.

        • launchStatus — (String)

          The launch status of a participating resource.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "LAUNCHED"
          • "FAILED"
          • "TERMINATED"
        • participatingResourceID — (map)

          The ID of a participating resource.

          • sourceNetworkID — (String)

            Source Network ID.

      • participatingServers — (Array<map>)

        A list of servers that the Job is acting upon.

        • launchActionsStatus — (map)

          The post-launch action runs of a participating server.

          • runs — (Array<map>)

            List of post launch action status.

            • action — (map)

              Action.

              • actionCode — (String)

                Launch action code.

              • actionId — (String)

                Launch action Id.

              • actionVersion — (String)

                Launch action version.

              • active — (Boolean)

                Whether the launch action is active.

              • category — (String)

                Launch action category.

                Possible values include:
                • "MONITORING"
                • "VALIDATION"
                • "CONFIGURATION"
                • "SECURITY"
                • "OTHER"
              • description — (String)

                Launch action description.

              • name — (String)

                Launch action name.

              • optional — (Boolean)

                Whether the launch will not be marked as failed if this action fails.

              • order — (Integer)

                Launch action order.

              • parameters — (map<map>)

                Launch action parameters.

                • type — (String)

                  Type.

                  Possible values include:
                  • "SSM_STORE"
                  • "DYNAMIC"
                • value — (String)

                  Value.

              • type — (String)

                Launch action type.

                Possible values include:
                • "SSM_AUTOMATION"
                • "SSM_COMMAND"
            • failureReason — (String)

              Failure reason.

            • runId — (String)

              Run Id.

            • status — (String)

              Run status.

              Possible values include:
              • "IN_PROGRESS"
              • "SUCCEEDED"
              • "FAILED"
          • ssmAgentDiscoveryDatetime — (String)

            Time where the AWS Systems Manager was detected as running on the launched instance.

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

var params = {
  launchConfigurationTemplateIDs: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
drs.describeLaunchConfigurationTemplates(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: {}) —
  • launchConfigurationTemplateIDs — (Array<String>)

    Request to filter Launch Configuration Templates list by Launch Configuration Template ID.

  • maxResults — (Integer)

    Maximum results to be returned in DescribeLaunchConfigurationTemplates.

  • nextToken — (String)

    The token of the next Launch Configuration Template 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>)

      List of items returned by DescribeLaunchConfigurationTemplates.

      • arn — (String)

        ARN of the Launch Configuration Template.

      • copyPrivateIp — (Boolean)

        Copy private IP.

      • copyTags — (Boolean)

        Copy tags.

      • exportBucketArn — (String)

        S3 bucket ARN to export Source Network templates.

      • launchConfigurationTemplateID — (String)

        ID of the Launch Configuration Template.

      • launchDisposition — (String)

        Launch disposition.

        Possible values include:
        • "STOPPED"
        • "STARTED"
      • launchIntoSourceInstance — (Boolean)

        DRS will set the 'launch into instance ID' of any source server when performing a drill, recovery or failback to the previous region or availability zone, using the instance ID of the source instance.

      • licensing — (map)

        Licensing.

        • osByol — (Boolean)

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

      • postLaunchEnabled — (Boolean)

        Post-launch actions activated.

      • tags — (map<String>)

        Tags of the Launch Configuration Template.

      • targetInstanceTypeRightSizingMethod — (String)

        Target instance type right-sizing method.

        Possible values include:
        • "NONE"
        • "BASIC"
        • "IN_AWS"
    • nextToken — (String)

      The token of the next Launch Configuration Template to retrieve.

Returns:

• (AWS.Request) —

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

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.

      • agentVersion — (String)

        The version of the DRS agent installed on the recovery instance

      • 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"
            • "FAILED_GETTING_REPLICATION_STATE"
            • "SNAPSHOTS_FAILURE"
            • "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.

          • 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"
              • "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"
          • "REPLICATION_STATE_NOT_AVAILABLE"
          • "NOT_STARTED"
        • 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.

        • stagingAvailabilityZone — (String)

          AWS Availability zone into which data is being replicated.

        • stagingOutpostArn — (String)

          The ARN of the staging Outpost

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

        • failbackLaunchType — (String)

          The launch type (Recovery / Drill) of the last launch for the failback replication of this recovery instance.

          Possible values include:
          • "RECOVERY"
          • "DRILL"
        • 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"
          • "FAILBACK_NOT_READY_FOR_LAUNCH"
          • "FAILBACK_LAUNCH_STATE_NOT_AVAILABLE"
      • 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.

      • originAvailabilityZone — (String)

        AWS availability zone associated with the recovery instance.

      • originEnvironment — (String)

        Environment (On Premises / AWS) of the instance that the recovery instance originated from.

        Possible values include:
        • "ON_PREMISES"
        • "AWS"
      • 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.

      • sourceOutpostArn — (String)

        The ARN of the source Outpost

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

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.

      • expectedTimestamp — required — (String)

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

      • snapshotID — required — (String)

        The ID of the Recovery Snapshot.

      • sourceServerID — required — (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.

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.

      • autoReplicateNewDisks — (Boolean)

        Whether to allow the AWS replication agent to automatically replicate newly added disks.

      • 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"
        • "NONE"
      • 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.

        • interval — required — (Integer)

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

        • retentionDuration — required — (Integer)

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

        • ruleID — (Integer)

          The ID of the rule.

        • units — required — (String)

          The units used to measure the interval and retentionDuration.

          Possible values include:
          • "MINUTE"
          • "HOUR"
          • "DAY"
      • replicationConfigurationTemplateID — required — (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.

var params = {
  filters: {
    originAccountID: 'STRING_VALUE',
    originRegion: 'STRING_VALUE',
    sourceNetworkIDs: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
drs.describeSourceNetworks(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 Networks.

    • originAccountID — (String)

      Filter Source Networks by account ID containing the protected VPCs.

    • originRegion — (String)

      Filter Source Networks by the region containing the protected VPCs.

    • sourceNetworkIDs — (Array<String>)

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

  • maxResults — (Integer)

    Maximum number of Source Networks to retrieve.

  • nextToken — (String)

    The token of the next Source Networks 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 Networks.

      • arn — (String)

        The ARN of the Source Network.

      • cfnStackName — (String)

        CloudFormation stack name that was deployed for recovering the Source Network.

      • lastRecovery — (map)

        An object containing information regarding the last recovery of the Source Network.

        • apiCallDateTime — (Date)

          The date and time the last Source Network recovery was initiated.

        • jobID — (String)

          The ID of the Job that was used to last recover the Source Network.

        • lastRecoveryResult — (String)

          The status of the last recovery status of this Source Network.

          Possible values include:
          • "NOT_STARTED"
          • "IN_PROGRESS"
          • "SUCCESS"
          • "FAIL"
          • "PARTIAL_SUCCESS"
          • "ASSOCIATE_SUCCESS"
          • "ASSOCIATE_FAIL"
      • launchedVpcID — (String)

        ID of the recovered VPC following Source Network recovery.

      • replicationStatus — (String)

        Status of Source Network Replication. Possible values: (a) STOPPED - Source Network is not replicating. (b) IN_PROGRESS - Source Network is being replicated. (c) PROTECTED - Source Network was replicated successfully and is being synchronized for changes. (d) ERROR - Source Network replication has failed

        Possible values include:
        • "STOPPED"
        • "IN_PROGRESS"
        • "PROTECTED"
        • "ERROR"
      • replicationStatusDetails — (String)

        Error details in case Source Network replication status is ERROR.

      • sourceAccountID — (String)

        Account ID containing the VPC protected by the Source Network.

      • sourceNetworkID — (String)

        Source Network ID.

      • sourceRegion — (String)

        Region containing the VPC protected by the Source Network.

      • sourceVpcID — (String)

        VPC ID protected by the Source Network.

      • tags — (map<String>)

        A list of tags associated with the Source Network.

    • nextToken — (String)

      The token of the next Source Networks to retrieve.

Returns:

• (AWS.Request) —

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

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.

      • agentVersion — (String)

        The version of the DRS agent installed on the 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.

          • volumeStatus — (String)

            The status of the volume.

            Possible values include:
            • "REGULAR"
            • "CONTAINS_MARKETPLACE_PRODUCT_CODES"
            • "MISSING_VOLUME_ATTRIBUTES"
            • "MISSING_VOLUME_ATTRIBUTES_AND_PRECHECK_UNAVAILABLE"
            • "PENDING"
        • stagingAvailabilityZone — (String)

          AWS Availability zone into which data is being replicated.

        • stagingOutpostArn — (String)

          The ARN of the staging Outpost

      • 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"
          • status — (String)

            Status of Source Server's last launch.

            Possible values include:
            • "PENDING"
            • "IN_PROGRESS"
            • "LAUNCHED"
            • "FAILED"
            • "TERMINATED"
        • 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.

      • replicationDirection — (String)

        Replication direction of the Source Server.

        Possible values include:
        • "FAILOVER"
        • "FAILBACK"
      • reversedDirectionSourceServerArn — (String)

        For EC2-originated Source Servers which have been failed over and then failed back, this value will mean the ARN of the Source Server on the opposite replication direction.

      • sourceCloudProperties — (map)

        Source cloud properties of the Source Server.

        • originAccountID — (String)

          AWS Account ID for an EC2-originated Source Server.

        • originAvailabilityZone — (String)

          AWS Availability Zone for an EC2-originated Source Server.

        • originRegion — (String)

          AWS Region for an EC2-originated Source Server.

        • sourceOutpostArn — (String)

          The ARN of the source Outpost

      • sourceNetworkID — (String)

        ID of the Source Network which is protecting this Source Server's network.

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

        • supportsNitroInstances — (Boolean)

          Are EC2 nitro instance types supported 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.

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.

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:

    • agentVersion — (String)

      The version of the DRS agent installed on the 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.

        • volumeStatus — (String)

          The status of the volume.

          Possible values include:
          • "REGULAR"
          • "CONTAINS_MARKETPLACE_PRODUCT_CODES"
          • "MISSING_VOLUME_ATTRIBUTES"
          • "MISSING_VOLUME_ATTRIBUTES_AND_PRECHECK_UNAVAILABLE"
          • "PENDING"
      • stagingAvailabilityZone — (String)

        AWS Availability zone into which data is being replicated.

      • stagingOutpostArn — (String)

        The ARN of the staging Outpost

    • 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"
        • status — (String)

          Status of Source Server's last launch.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "LAUNCHED"
          • "FAILED"
          • "TERMINATED"
      • 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.

    • replicationDirection — (String)

      Replication direction of the Source Server.

      Possible values include:
      • "FAILOVER"
      • "FAILBACK"
    • reversedDirectionSourceServerArn — (String)

      For EC2-originated Source Servers which have been failed over and then failed back, this value will mean the ARN of the Source Server on the opposite replication direction.

    • sourceCloudProperties — (map)

      Source cloud properties of the Source Server.

      • originAccountID — (String)

        AWS Account ID for an EC2-originated Source Server.

      • originAvailabilityZone — (String)

        AWS Availability Zone for an EC2-originated Source Server.

      • originRegion — (String)

        AWS Region for an EC2-originated Source Server.

      • sourceOutpostArn — (String)

        The ARN of the source Outpost

    • sourceNetworkID — (String)

      ID of the Source Network which is protecting this Source Server's network.

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

      • supportsNitroInstances — (Boolean)

        Are EC2 nitro instance types supported 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.

var params = {
  sourceNetworkID: 'STRING_VALUE' /* required */
};
drs.exportSourceNetworkCfnTemplate(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: {}) —
  • sourceNetworkID — (String)

    The Source Network ID to export its CloudFormation template to an S3 bucket.

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:

    • s3DestinationUrl — (String)

      S3 bucket URL where the Source Network CloudFormation template was exported to.

Returns:

• (AWS.Request) —

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

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.

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"
    • launchIntoInstanceProperties — (map)

      Launch into existing instance properties.

      • launchIntoEC2InstanceID — (String)

        Optionally holds EC2 instance ID of an instance to launch into, instead of launching a new instance during drill, recovery or failback.

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

    • postLaunchEnabled — (Boolean)

      Whether we want to activate post-launch actions for the Source Server.

    • 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"
      • "IN_AWS"

Returns:

• (AWS.Request) —

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

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.

    • autoReplicateNewDisks — (Boolean)

      Whether to allow the AWS replication agent to automatically replicate newly added disks.

    • 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"
      • "NONE"
    • 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.

      • interval — required — (Integer)

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

      • retentionDuration — required — (Integer)

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

      • ruleID — (Integer)

        The ID of the rule.

      • units — required — (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.

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.

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.

var params = {
  resourceId: 'STRING_VALUE', /* required */
  filters: {
    actionIds: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
drs.listLaunchActions(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)

    Filters to apply when listing resource launch actions.

    • actionIds — (Array<String>)

      Launch actions Ids.

  • maxResults — (Integer)

    Maximum amount of items to return when listing resource launch actions.

  • nextToken — (String)

    Next token to use when listing resource launch actions.

  • resourceId — (String)

    Launch configuration template Id or 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>)

      List of resource launch actions.

      • actionCode — (String)

        Launch action code.

      • actionId — (String)

        Launch action Id.

      • actionVersion — (String)

        Launch action version.

      • active — (Boolean)

        Whether the launch action is active.

      • category — (String)

        Launch action category.

        Possible values include:
        • "MONITORING"
        • "VALIDATION"
        • "CONFIGURATION"
        • "SECURITY"
        • "OTHER"
      • description — (String)

        Launch action description.

      • name — (String)

        Launch action name.

      • optional — (Boolean)

        Whether the launch will not be marked as failed if this action fails.

      • order — (Integer)

        Launch action order.

      • parameters — (map<map>)

        Launch action parameters.

        • type — (String)

          Type.

          Possible values include:
          • "SSM_STORE"
          • "DYNAMIC"
        • value — (String)

          Value.

      • type — (String)

        Launch action type.

        Possible values include:
        • "SSM_AUTOMATION"
        • "SSM_COMMAND"
    • nextToken — (String)

      Next token returned when listing resource launch actions.

Returns:

• (AWS.Request) —

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

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.

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.

var params = {
  actionCode: 'STRING_VALUE', /* required */
  actionId: 'STRING_VALUE', /* required */
  actionVersion: 'STRING_VALUE', /* required */
  active: true || false, /* required */
  category: MONITORING | VALIDATION | CONFIGURATION | SECURITY | OTHER, /* required */
  description: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  optional: true || false, /* required */
  order: 'NUMBER_VALUE', /* required */
  resourceId: 'STRING_VALUE', /* required */
  parameters: {
    '<LaunchActionParameterName>': {
      type: SSM_STORE | DYNAMIC,
      value: 'STRING_VALUE'
    },
    /* '<LaunchActionParameterName>': ... */
  }
};
drs.putLaunchAction(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: {}) —
  • actionCode — (String)

    Launch action code.

  • actionId — (String)

    Launch action Id.

  • actionVersion — (String)

    Launch action version.

  • active — (Boolean)

    Whether the launch action is active.

  • category — (String)

    Launch action category.

    Possible values include:
    • "MONITORING"
    • "VALIDATION"
    • "CONFIGURATION"
    • "SECURITY"
    • "OTHER"
  • description — (String)

    Launch action description.

  • name — (String)

    Launch action name.

  • optional — (Boolean)

    Whether the launch will not be marked as failed if this action fails.

  • order — (Integer)

    Launch action order.

  • parameters — (map<map>)

    Launch action parameters.

    • type — (String)

      Type.

      Possible values include:
      • "SSM_STORE"
      • "DYNAMIC"
    • value — (String)

      Value.

  • resourceId — (String)

    Launch configuration template Id or 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:

    • actionCode — (String)

      Launch action code.

    • actionId — (String)

      Launch action Id.

    • actionVersion — (String)

      Launch action version.

    • active — (Boolean)

      Whether the launch action is active.

    • category — (String)

      Launch action category.

      Possible values include:
      • "MONITORING"
      • "VALIDATION"
      • "CONFIGURATION"
      • "SECURITY"
      • "OTHER"
    • description — (String)

      Launch action description.

    • name — (String)

      Launch action name.

    • optional — (Boolean)

      Whether the launch will not be marked as failed if this action fails.

    • order — (Integer)

      Launch action order.

    • parameters — (map<map>)

      Launch action parameters.

      • type — (String)

        Type.

        Possible values include:
        • "SSM_STORE"
        • "DYNAMIC"
      • value — (String)

        Value.

    • resourceId — (String)

      Launch configuration template Id or Source Server Id

    • type — (String)

      Launch action type.

      Possible values include:
      • "SSM_AUTOMATION"
      • "SSM_COMMAND"

Returns:

• (AWS.Request) —

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

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:

    • agentVersion — (String)

      The version of the DRS agent installed on the 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.

        • volumeStatus — (String)

          The status of the volume.

          Possible values include:
          • "REGULAR"
          • "CONTAINS_MARKETPLACE_PRODUCT_CODES"
          • "MISSING_VOLUME_ATTRIBUTES"
          • "MISSING_VOLUME_ATTRIBUTES_AND_PRECHECK_UNAVAILABLE"
          • "PENDING"
      • stagingAvailabilityZone — (String)

        AWS Availability zone into which data is being replicated.

      • stagingOutpostArn — (String)

        The ARN of the staging Outpost

    • 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"
        • status — (String)

          Status of Source Server's last launch.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "LAUNCHED"
          • "FAILED"
          • "TERMINATED"
      • 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.

    • replicationDirection — (String)

      Replication direction of the Source Server.

      Possible values include:
      • "FAILOVER"
      • "FAILBACK"
    • reversedDirectionSourceServerArn — (String)

      For EC2-originated Source Servers which have been failed over and then failed back, this value will mean the ARN of the Source Server on the opposite replication direction.

    • sourceCloudProperties — (map)

      Source cloud properties of the Source Server.

      • originAccountID — (String)

        AWS Account ID for an EC2-originated Source Server.

      • originAvailabilityZone — (String)

        AWS Availability Zone for an EC2-originated Source Server.

      • originRegion — (String)

        AWS Region for an EC2-originated Source Server.

      • sourceOutpostArn — (String)

        The ARN of the source Outpost

    • sourceNetworkID — (String)

      ID of the Source Network which is protecting this Source Server's network.

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

      • supportsNitroInstances — (Boolean)

        Are EC2 nitro instance types supported 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.