How do I use AWSSupport-ManageRDPSettings Systems Manager Automation runbook to manage RDP settings on a managed EC2Windows instance?

2 minute read

I want to use the AWSSupport-ManageRDPSettings runbook by Automation, a capability of AWS System Manager, to control the Remote Desktop Protocol (RDP) settings on my Amazon Elastic Compute Cloud (Amazon EC2) Windows managed instance.

Short description

The AWSSupport-ManageRDPSettings runbook manages common RDP settings, such as RDP port and Network Layer Authentication (NLA).

Note: Before you use this runbook to change RDP settings, make sure that you review the existing settings.



Make sure that the AWS Identity and Access Management (IAM) user or role has the required permissions. For more information, see Required IAM permissions.

Run the Systems Manager automation runbook

  1. Open the AWS Systems Manager console.
  2. In the navigation pane, choose Documents.
  3. In the search bar, enter AWSSupport-ManageRDPSettings.
  4. Select the AWSSupport-ManageRDPSettings document, and then choose Execute automation. Or, choose Run this Automation (console).
  5. For the input parameters, enter the following:
  • InstanceID (required): Choose the ID of the managed instance that you want to change RDP settings for.
  • RDPPortAction (required): Choose the action to apply to the RDP port from the dropdown list.
  • NLASettingAction (required): Choose the action to perform on the NLA setting from the dropdown list.
  • RemoteConnections (required): Choose the action to perform on the DenyTSConnections setting from the dropdown list.
  • RDPPort (optional): If you set the RDPPortAction to Modify, then enter the new RDP port number. The port number must be between 1025–65535. Note that if you change the port, then the RDP service restarts.
  • AutomationAssumeRole (optional): Choose the IAM role for this runbook from the dropdown list. If a role isn't specified, then Automation uses the permissions of the user who runs this document.
  1. Choose Execute.

To see detailed results after the automation completes, review the Outputs section.

Related information

Run an automation

Setting up Automation

Systems Manager Automation runbook reference

AWS OFFICIALUpdated 9 months ago