Installing the AWS Replication Agent on Windows servers - Application Migration Service

Installing the AWS Replication Agent on Windows servers

Complete the following steps to install the AWS Replication Agent on Windows source servers.

  1. Ensure that the necessary service roles have been created by clicking on the Reinitialize service permissions button on the AWS Application Migration Service console replication settings page. You must have the permissions necessary to create IAM roles in order for this operation to succeed.

  2. Download the agent installer (AWSReplicationWindowsInstaller.exe). Copy or distribute the downloaded agent installer to each Windows source server that you want to add to AWS Application Migration Service.

    The agent installer follows the following format: https://aws-application-migration-service-<region>.s3.<region>.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe . Replace <region> with the AWS Region into which you are replicating.

    The following is an example of the installer link for us-east-1:

    https://aws-application-migration-service-us-east-1.s3.us-east-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe

    Important

    • You need to run the agent installer file as an Administrator on each Windows server.

    • If you need to validate the installer hash, the correct hash can be found here: https://aws-application-migration-service-hashes-<region>.s3.<region>.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe.sha512 (replace <region> with the AWS Region into which you are replicating, for example, us-east-1:

      https://aws-application-migration-service-hashes-us-east-1.s3.us-east-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe.sha512

    • We recommend using Windows PowerShell, which support ctrl+v pasting, and not Windows Command Prompt (cmd), which does not.

    • Replicating Amazon EC2 instances that were launched with marketplace product codes, is not supported.

    Note

    • AWS Regions that are not opt-in also support the shorter installer path: https://aws-application-migration-service-<region>.s3.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe. Replace <region> with the AWS Region into which you are replicating.

    • You can generate a custom installation command through the Add servers prompt. Learn more about the Add servers prompt.

    • Microsoft Windows Server versions 2003, 2003 R2, 2008 and 2008 R2 use a unique version of the AWS Replication Agent that is only valid for legacy Windows OSs (AwsReplicationWindowsLegacyInstaller.exe). DO NOT use this installer file to install the agent on any other OS types. You can generate an installer by following the steps outlined in the Add servers actions prompt documentation or directly download it from https://aws-application-migration-service-<region>.s3.amazonaws.com/latest/windows_legacy/AwsReplicationWindowsLegacyInstaller.exe . Replace <region> with the AWS Region into which you are replicating. If you need to validate the installer hash, the correct hash can be found here: https://aws-application-migration-service-hashes-<region>.s3.amazonaws.com/latest/windows_legacy/AwsReplicationWindowsLegacyInstaller.exe.sha512 (replace <region> with the AWS Region into which you are replicating.

    The following table contains the installer download link by supported AWS Region:

    Region name Region identity Download Link
    US East (Ohio) us-east-2 https://aws-application-migration-service-us-east-2.s3.us-east-2.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    US East (N. Virginia) us-east-1 https://aws-application-migration-service-us-east-1.s3.us-east-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    US West (N. California) us-west-1 https://aws-application-migration-service-us-west-1.s3.us-west-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    US West (Oregon) us-west-2 https://aws-application-migration-service-us-west-2.s3.us-west-2.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Africa (Cape Town) af-south-1 https://aws-application-migration-service-af-south-1.s3.af-south-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Asia Pacific (Hong Kong) ap-east-1 https://aws-application-migration-service-ap-east-1.s3.ap-east-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Asia Pacific (Jakarta) ap-southeast-3 https://aws-application-migration-service-ap-southeast-3.s3.ap-southeast-3.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Asia Pacific (Mumbai) ap-south-1 https://aws-application-migration-service-ap-south-1.s3.ap-south-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Asia Pacific (Osaka) ap-northeast-3 https://aws-application-migration-service-ap-northeast-3.s3.ap-northeast-3.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Asia Pacific (Seoul) ap-northeast-2 https://aws-application-migration-service-ap-northeast-2.s3.ap-northeast-2.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Asia Pacific (Singapore) ap-southeast-1 https://aws-application-migration-service-ap-southeast-1.s3.ap-southeast-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Asia Pacific (Sydney) ap-southeast-2 https://aws-application-migration-service-ap-southeast-2.s3.ap-southeast-2.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Asia Pacific (Tokyo) ap-northeast-1 https://aws-application-migration-service-ap-northeast-1.s3.ap-northeast-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Canada (Central) ca-central-1 https://aws-application-migration-service-ca-central-1.s3.ca-central-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Europe (Frankfurt) eu-central-1 https://aws-application-migration-service-eu-central-1.s3.eu-central-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Europe (Ireland) eu-west-1 https://aws-application-migration-service-eu-west-1.s3.eu-west-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Europe (London) eu-west-2 https://aws-application-migration-service-eu-west-2.s3.eu-west-2.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Europe (Milan) eu-south-1 https://aws-application-migration-service-eu-south-1.s3.eu-south-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Europe (Paris) eu-west-3 https://aws-application-migration-service-eu-west-3.s3.eu-west-3.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Europe (Stockholm) eu-north-1 https://aws-application-migration-service-eu-north-1.s3.eu-north-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Middle East (Bahrain) me-south-1 https://aws-application-migration-service-me-south-1.s3.me-south-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    South America (São Paulo) sa-east-1 https://aws-application-migration-service-sa-east-1.s3.sa-east-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Middle East (UAE) me-central-1 https://aws-application-migration-service-me-central-1.s3.me-central-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Asia Pacific (Melbourne) ap-southeast-4 https://aws-application-migration-service-ap-southeast-4.s3.ap-southeast-4.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Asia Pacific (Hyderabad) ap-south-2 https://aws-application-migration-service-ap-south-2.s3.ap-south-2.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Europe (Zurich) eu-central-2 https://aws-application-migration-service-eu-central-2.s3.eu-central-2.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Europe (Spain) eu-south-2 https://aws-application-migration-service-eu-south-2.s3.eu-south-2.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    Tel Aviv il-central-1 https://aws-application-migration-service-il-central-1.s3.il-central-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    AWS GovCloud (US-East) us-gov-east-1 https://aws-application-migration-service-us-gov-east-1.s3.us-gov-east-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe
    AWS GovCloud (US-West) us-gov-west-1 https://aws-application-migration-service-us-gov-west-1.s3.us-gov-west-1.amazonaws.com/latest/windows/AwsReplicationWindowsInstaller.exe

  3. Generate the temporary credentials that are required to install the AWS Replication Agent.

    Important

    When using temporary credentials (created using an IAM role instead of a user), you will need to enter the following parameters into the command prompt:

    • AWS access key

    • AWS secret access key

    • AWS session token

    The request to enter an AWS session token will only appear if the system identifies that you are using temporary credentials. AWS access key for temporary credentials begins with the letters ASIA.

  4. Run the agent installer file – AWSReplicationWindowsInstaller.exe – as an Administrator. The CMD will open.

    To run the installer with the default settings, enter your AWS Region Name, the AWS Access Key ID and the AWS Secret Access Key, and the AWS Session Token as described in the next step.

    If you require additional customization, you can add a variety of parameters to the installation script in order to manipulate the way the Agent is installed on your server. Add the parameters to the end of the installation script.

    • --no-prompt

      This parameter will run a silent installation.

    • --devices

      This parameter specifies which specific disks to replicate.

    • --force-volumes

      This parameter must be used with the --no-prompt parameter. This parameter will cancel the automatic detection of physical disks to replicate. You will need to specify the exact disks to replicate using the --devices parameter (including the root disk, failure to specify the root disk will cause replication to fail). This parameter should only be used as a troubleshooting tool if the --devices parameter fails to identify the disks correctly.

    • --tags

      Use this parameter to add resource tags to the source server. Use a space to separate each tag (for example: --tags KEY=VALUE [KEY=VALUE ...])

      Note

      This flag may only be used when adding new source servers to Application Migration Service. You cannot use the --tags flag to modify tags of source servers that have already been added to Application Migration Service.

    • --s3-endpoint

      Use this parameter to specify a VPC endpoint you created for Amazon S3 if you do not wish to open your firewall ports to access the default Amazon S3 endpoint. Learn more about installing the Agent on a blocked network.

    • --user-provided-id

      This parameter allows you to provide a name to the source server that you are about to add, or identify a source server that needs to be updated.

    • --endpoint

      Use this parameter to specify the Private Link endpoint you created for AWS Application Migration Service if you do not wish to open your firewall ports to access the default Application Migration Service endpoint. Learn more about installing the agent on a blocked network.

    • --no-replication

      By default after agent installation, the replication begins automatically. This attribute allows you to install the agent without immediately starting the replication. The 90-day free replication period excludes hours where the replication was stopped.

    The installer will confirm that the installation of the AWS Replication Agent has started.

    Command prompt window showing the start of AWS Replication Agent installation.

  5. The installer will prompt you to enter your AWS Region Name, the AWS Access Key ID, the AWS Secret Access Key (and the AWS Session Token if appropriate) that you previously generated. Enter the complete AWS Region name (for example: eu-central-1), and the full AWS Access Key ID and AWS Secret Access Key.

    AWS Replication Agent installation window prompting for AWS Region Name and access credentials.
    Note

    You can also enter these values as part of the installation script command parameters. If you do not enter these parameters as part of the installation script, you will be prompted to enter them one by one as described above. (for example: AwsReplicationWindowsInstaller.exe --region regionname --aws-access-key-id AKIAIOSFODNN7EXAMPLE --aws-secret-access-key wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY)

  6. Once you have entered your credentials, the installer will verify that the source server has enough free disk space for Agent installation and identify volumes for replication. The installer will display the identified disks and prompt you to choose the disks you want to replicate.

    AWS Replication Agent installation window showing region, access key details, and disk selection prompt.

    To replicate some of the disks, type the path of the disks, separated by a comma, as illustrated in the installer (for example: C: or D:). To replicate all of the disks, press Enter. The installer will identify the selected disks and print their size.

    AWS Replication Agent installer showing region, access key details, and disk selection prompt.

    The installer will confirm that all of the disks were successfully identified.

    AWS Replication Agent installation progress showing disk selection and successful identification.
    Note

    When identifying specific disks for replication, do not use apostrophes, brackets, or disk paths that do not exist. Type only existing disk paths. Each disk that you selected for replication is displayed with the caption Disk to replicate identified. However, the displayed list of identified disks for replication may differ from the data you entered. This difference can due to several reasons:

    • The root disk of the source server is always replicated, whether you select it or not. Therefore, it always appears on the list of identified disks for replication.

    • AWS Application Migration Service replicates whole disks. Therefore, if you choose to replicate a partition, its entire disk will appear on the list and will later be replicated. If several partitions on the same disk are selected, then the disk encompassing all of them will only appear once on the list.

    • Incorrect disks may be chosen by accident. Ensure that the correct disks have been chosen.

    Important

    If disks are disconnected from a server, AWS Application Migration Service can no longer replicate them, so they are removed from the list of replicated disks. When they are reconnected, the AWS Replication Agent cannot know that these were the same disks that were disconnected and therefore does not add them automatically. To add the disks after they are reconnected, rerun the AWS Replication Agent installer on the server.

    Note that the returned disks will need be replicated from the beginning. Any disk size changes will be automatically identified, but will also cause a resync. Perform a test after installing the Agent to ensure that the correct disks have been added.

  7. After all of the disks that will be replicated have been successfully identified, the installer will download and install the AWS Replication Agent on the source server.

    AWS Replication Agent installation progress showing disk selection and successful download.

  8. Once the AWS Replication Agent is installed, the server will be added to the AWS Application Migration Service Console and will undergo the initial sync process. The installer will provide you with the source server's ID.

    Command prompt showing successful installation of AWS Replication Agent with region and disk details.

    You can review this process in real time on the Source servers page. Learn more about the initial sync process.