UpdateSourceServerReplicationTypeCommand

Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MgnClient, UpdateSourceServerReplicationTypeCommand } from "@aws-sdk/client-mgn"; // ES Modules import
// const { MgnClient, UpdateSourceServerReplicationTypeCommand } = require("@aws-sdk/client-mgn"); // CommonJS import
const client = new MgnClient(config);
const input = { // UpdateSourceServerReplicationTypeRequest
  sourceServerID: "STRING_VALUE", // required
  replicationType: "STRING_VALUE", // required
  accountID: "STRING_VALUE",
};
const command = new UpdateSourceServerReplicationTypeCommand(input);
const response = await client.send(command);
// { // SourceServer
//   sourceServerID: "STRING_VALUE",
//   arn: "STRING_VALUE",
//   isArchived: true || false,
//   tags: { // TagsMap
//     "<keys>": "STRING_VALUE",
//   },
//   launchedInstance: { // LaunchedInstance
//     ec2InstanceID: "STRING_VALUE",
//     jobID: "STRING_VALUE",
//     firstBoot: "STRING_VALUE",
//   },
//   dataReplicationInfo: { // DataReplicationInfo
//     lagDuration: "STRING_VALUE",
//     etaDateTime: "STRING_VALUE",
//     replicatedDisks: [ // DataReplicationInfoReplicatedDisks
//       { // DataReplicationInfoReplicatedDisk
//         deviceName: "STRING_VALUE",
//         totalStorageBytes: Number("long"),
//         replicatedStorageBytes: Number("long"),
//         rescannedStorageBytes: Number("long"),
//         backloggedStorageBytes: Number("long"),
//       },
//     ],
//     dataReplicationState: "STRING_VALUE",
//     dataReplicationInitiation: { // DataReplicationInitiation
//       startDateTime: "STRING_VALUE",
//       nextAttemptDateTime: "STRING_VALUE",
//       steps: [ // DataReplicationInitiationSteps
//         { // DataReplicationInitiationStep
//           name: "STRING_VALUE",
//           status: "STRING_VALUE",
//         },
//       ],
//     },
//     dataReplicationError: { // DataReplicationError
//       error: "STRING_VALUE",
//       rawError: "STRING_VALUE",
//     },
//     lastSnapshotDateTime: "STRING_VALUE",
//   },
//   lifeCycle: { // LifeCycle
//     addedToServiceDateTime: "STRING_VALUE",
//     firstByteDateTime: "STRING_VALUE",
//     elapsedReplicationDuration: "STRING_VALUE",
//     lastSeenByServiceDateTime: "STRING_VALUE",
//     lastTest: { // LifeCycleLastTest
//       initiated: { // LifeCycleLastTestInitiated
//         apiCallDateTime: "STRING_VALUE",
//         jobID: "STRING_VALUE",
//       },
//       reverted: { // LifeCycleLastTestReverted
//         apiCallDateTime: "STRING_VALUE",
//       },
//       finalized: { // LifeCycleLastTestFinalized
//         apiCallDateTime: "STRING_VALUE",
//       },
//     },
//     lastCutover: { // LifeCycleLastCutover
//       initiated: { // LifeCycleLastCutoverInitiated
//         apiCallDateTime: "STRING_VALUE",
//         jobID: "STRING_VALUE",
//       },
//       reverted: { // LifeCycleLastCutoverReverted
//         apiCallDateTime: "STRING_VALUE",
//       },
//       finalized: { // LifeCycleLastCutoverFinalized
//         apiCallDateTime: "STRING_VALUE",
//       },
//     },
//     state: "STRING_VALUE",
//   },
//   sourceProperties: { // SourceProperties
//     lastUpdatedDateTime: "STRING_VALUE",
//     recommendedInstanceType: "STRING_VALUE",
//     identificationHints: { // IdentificationHints
//       fqdn: "STRING_VALUE",
//       hostname: "STRING_VALUE",
//       vmWareUuid: "STRING_VALUE",
//       awsInstanceID: "STRING_VALUE",
//       vmPath: "STRING_VALUE",
//     },
//     networkInterfaces: [ // NetworkInterfaces
//       { // NetworkInterface
//         macAddress: "STRING_VALUE",
//         ips: [ // IPsList
//           "STRING_VALUE",
//         ],
//         isPrimary: true || false,
//       },
//     ],
//     disks: [ // Disks
//       { // Disk
//         deviceName: "STRING_VALUE",
//         bytes: Number("long"),
//       },
//     ],
//     cpus: [ // Cpus
//       { // CPU
//         cores: Number("long"),
//         modelName: "STRING_VALUE",
//       },
//     ],
//     ramBytes: Number("long"),
//     os: { // OS
//       fullString: "STRING_VALUE",
//     },
//   },
//   replicationType: "STRING_VALUE",
//   vcenterClientID: "STRING_VALUE",
//   applicationID: "STRING_VALUE",
//   userProvidedID: "STRING_VALUE",
//   fqdnForActionFramework: "STRING_VALUE",
//   connectorAction: { // SourceServerConnectorAction
//     credentialsSecretArn: "STRING_VALUE",
//     connectorArn: "STRING_VALUE",
//   },
// };

UpdateSourceServerReplicationTypeCommand Input

Parameter
Type
Description
replicationType
Required
ReplicationType | undefined

Replication type to which to update source server.

sourceServerID
Required
string | undefined

ID of source server on which to update replication type.

accountID
string | undefined

Account ID on which to update replication type.

UpdateSourceServerReplicationTypeCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
applicationID
string | undefined

Source server application ID.

arn
string | undefined

Source server ARN.

connectorAction
SourceServerConnectorAction | undefined

Source Server connector action.

dataReplicationInfo
DataReplicationInfo | undefined

Source server data replication info.

fqdnForActionFramework
string | undefined

Source server fqdn for action framework.

isArchived
boolean | undefined

Source server archived status.

launchedInstance
LaunchedInstance | undefined

Source server launched instance.

lifeCycle
LifeCycle | undefined

Source server lifecycle state.

replicationType
ReplicationType | undefined

Source server replication type.

sourceProperties
SourceProperties | undefined

Source server properties.

sourceServerID
string | undefined

Source server ID.

tags
Record<string, string> | undefined

Source server Tags.

userProvidedID
string | undefined

Source server user provided ID.

vcenterClientID
string | undefined

Source server vCenter client id.

Throws

Name
Fault
Details
ConflictException
client

The request could not be completed due to a conflict with the current state of the target resource.

ResourceNotFoundException
client

Resource not found exception.

UninitializedAccountException
client

Uninitialized account exception.

ValidationException
client

Validate exception.

MgnServiceException
Base exception class for all service exceptions from Mgn service.