Amazon Kinesis Agent for Microsoft Windows
User Guide

Getting Started with Amazon Kinesis Agent for Microsoft Windows

You can use Amazon Kinesis Agent for Microsoft Windows (Kinesis Agent for Windows) to collect, parse, transform, and stream logs, events, and metrics from your Windows fleet to various AWS services. The following information contains prerequisites and step-by-step instructions for installing and configuring Kinesis Agent for Windows.

Prerequisites

Before installing Kinesis Agent for Windows, ensure that you have the following prerequisites:

Setting Up an AWS Account

If you do not have an AWS account, use the following procedure to create one.

To sign up for AWS

  1. Open https://aws.amazon.com/, and then choose Create an AWS Account.

    Note

    If you previously signed in to the AWS Management Console using AWS account root user credentials, choose Sign in to a different account. If you previously signed in to the console using IAM credentials, choose Sign-in using root account credentials. Then choose Create a new AWS account.

  2. Follow the online instructions.

    Part of the sign-up procedure involves receiving a phone call and entering a verification code using the phone keypad.

To create an IAM user for yourself and add the user to an Administrators group

  1. Use your AWS account email address and password to sign in as the AWS account root user to the IAM console at https://console.aws.amazon.com/iam/.

    Note

    We strongly recommend that you adhere to the best practice of using the Administrator IAM user below and securely lock away the root user credentials. Sign in as the root user only to perform a few account and service management tasks.

  2. In the navigation pane of the console, choose Users, and then choose Add user.

  3. For User name, type Administrator.

  4. Select the check box next to AWS Management Console access, select Custom password, and then type the new user's password in the text box. You can optionally select Require password reset to force the user to create a new password the next time the user signs in.

  5. Choose Next: Permissions.

  6. On the Set permissions page, choose Add user to group.

  7. Choose Create group.

  8. In the Create group dialog box, for Group name type Administrators.

  9. For Filter policies, select the check box for AWS managed - job function.

  10. In the policy list, select the check box for AdministratorAccess. Then choose Create group.

  11. Back in the list of groups, select the check box for your new group. Choose Refresh if necessary to see the group in the list.

  12. Choose Next: Tags to add metadata to the user by attaching tags as key-value pairs.

  13. Choose Next: Review to see the list of group memberships to be added to the new user. When you are ready to proceed, choose Create user.

You can use this same process to create more groups and users, and to give your users access to your AWS account resources. To learn about using policies to restrict users' permissions to specific AWS resources, go to Access Management and Example Policies.

To sign up for AWS and create an administrator account

  1. If you don't have an AWS account, open https://aws.amazon.com/. Choose Create an AWS Account, and then follow the online instructions.

    Part of the sign-up procedure involves receiving a phone call and entering a PIN using the phone keypad.

  2. Sign in to the AWS Management Console and open the IAM console at https://console.aws.amazon.com/iam/.

  3. In the navigation pane, choose Groups, and then choose Create New Group.

  4. For Group Name, enter a name for your group, such as Administrators, and then choose Next Step.

  5. In the list of policies, select the check box next to the AdministratorAccess policy. You can use the Filter menu and the Search box to filter the list of policies.

  6. Choose Next Step. Choose Create Group, and your new group appears under Group Name.

  7. In the navigation pane, choose Users, and then choose Create New Users.

  8. In box 1, enter a user name, clear the check box next to Generate an access key for each user, and then choose Create.

  9. In the list of users, choose the name (not the check box) of the user that you just created. You can use the Search box to search for the user name.

  10. Choose the Groups tab, and then choose Add User to Groups.

  11. Select the check box next to the administrators group, and then choose Add to Groups.

  12. Choose the Security Credentials tab. Under Sign-In Credentials, choose Manage Password.

  13. Select Assign a custom password, enter a password in the Password and Confirm Password boxes, and then choose Apply.

Installing Kinesis Agent for Windows

There are two ways that you can install Kinesis Agent for Windows on Windows:

  • Install from AWS Systems Manager, a set of services for administering servers and desktops.

  • Download from Amazon Simple Storage Service (Amazon S3) and execute a PowerShell script.

Note

The following instructions occasionally use the terms KinesisTap and AWSKinesisTap. These words mean the same thing as Kinesis Agent for Windows, but you must specify them as is when executing these instructions.

Follow these steps to install Kinesis Agent for Windows using Systems Manager Run Command. For more information about Run Command, see AWS Systems Manager Run Command in the AWS Systems Manager User Guide.

Note

Systems Manager installation for Kinesis Agent for Windows is available in the AWS Regions listed in AWS Systems Manager except the following:

  • cn-north-1

  • cn-northwest-1

  • All AWS GovCloud Regions.

To install Kinesis Agent for Windows using Systems Manager

  1. Ensure that version 2.2.58.0 or later of the SSM agent is installed on instances where you want to install Kinesis Agent for Windows.

  2. Sign in to the AWS Management Console and open the Amazon EC2 console at https://console.aws.amazon.com/ec2/.

  3. Open Systems Manager, and in the navigation pane, choose Run Command. Then choose Run a Command.

  4. Choose the AWS-ConfigureAWSPackage Systems Manager document.

    
      Console screenshot showing AWS-ConfigureAWSPackage document highlighted in Systems
       Manager.
  5. In the Select instances list, choose the instance or instances for Kinesis Agent for Windows installation or uninstallation, or specify a tag.

  6. For Action, choose Install.

  7. In the Name box, enter the following Amazon Resource Name (ARN) for the Kinesis Agent for Windows package:

    arn:aws:ssm:::package/AWSKinesisTap
    
      Console screenshot highlighting the choices to make in Systems Manager.
  8. For Version, keep the version as the latest, or specify a particular version.

  9. Choose Run to execute the command.

In addition to using Systems Manager Run Command, you can also use Systems Manager Maintenance Windows and State Manager to automate the deployment of Kinesis Agent for Windows over time.

Perform the following steps to install the latest version of Kinesis Agent for Windows via Amazon S3 and script execution:

To install the latest version of Kinesis Agent for Windows via Amazon S3

  1. Open an elevated PowerShell command prompt window.

  2. Execute the following command:

    iex ((New-Object System.Net.WebClient).DownloadString('https://s3-us-west-2.amazonaws.com/kinesis-agent-windows/downloads/InstallKinesisAgent.ps1'))

Perform the following steps to install a specific version of Kinesis Agent for Windows via Amazon S3 and script execution:

To install a specific version of Kinesis Agent for Windows from Amazon S3

  1. Download the InstallKinesisAgent.ps1 file from the following URL:

    https://s3-us-west-2.amazonaws.com/kinesis-agent-windows/downloads/InstallKinesisAgent.ps1

  2. Open an elevated command prompt window. In the directory where the file was downloaded, execute the following command:

    PowerShell.exe -File ".\InstallKinesisAgent.ps1" -version "version"

    Replace version with a valid Kinesis Agent for Windows version number (for example 1.0.0.109 as of this time). Browse to https://s3-us-west-2.amazonaws.com/kinesis-agent-windows/downloads/index.html to get a list of currently available versions of Kinesis Agent for Windows.

There are many deployment tools which can remotely execute PowerShell scripts. They can be used to automate the installation of Kinesis Agent for Windows on fleets of servers or desktops.

Configuring and Starting Kinesis Agent for Windows

After installing Kinesis Agent for Windows, you must configure and start the agent. After that, no further operation intervention should be required.

To configure and start Kinesis Agent for Windows

  1. Create and deploy a Kinesis Agent for Windows configuration file. This file configures sources, sinks, and pipes, along with other global configuration items.

    For more information about Kinesis Agent for Windows configuration, see Configuring Amazon Kinesis Agent for Microsoft Windows.

    For complete configuration file examples that you can customize and install, see Kinesis Agent for Windows Configuration Examples.

  2. Open an elevated PowerShell command prompt window, and start Kinesis Agent for Windows using the following PowerShell command:

    Start-Service -Name AWSKinesisTap