How can I use the AWSPremiumSupport-ResizeNitroInstance runbook to resize Amazon EC2 instances that are built on the Nitro System?

Short description

The AWSPremiumSupport-ResizeNitroInstance runbook provides two ways to specify the instance type that you want to change to:

• TargetInstanceTypeFromParameter: Use for simple automations that target a single instance.
• TargetInstanceTypeFromTagValue: Use to run automations at scale to change the instance type of several instances.

If you don't specify a value for either parameter, then the automation fails.

Important: Access to the AWSPremiumSupport-ResizeNitroInstance runbook requires a Business Support or Enterprise Support plan. For more information, see AWS Support.

Resolution

Prerequisite

Before you start the runbook, make sure that your AWS Identify and Access Management (IAM) user or role has the required permissions. For more information, see the Required IAM permissions section of AWSPremiumSupport-ResizeNitroInstance.

Run the Systems Manager automation runbook

1. Open the AWSPremiumSupport-ResizeNitroInstance runbook in the AWS Systems Manager console.
2. Choose Execute automation.
3. Enter the following input parameters:
   InstanceId (Required): The ID of the Amazon EC2 instance whose type you want to change.
   Acknowledge (Required): Enter Yes to acknowledge that your instance stops as part of this runbook.
   AllowInstanceStoreInstances (Optional): If you set this value to Yes, then the runbook can run on instances that have instance store volumes attached. By default, this value is set to No.
   AllowCloudFormationInstances (Optional): If you set this value to Yes, then the runbook runs on instances that are part of an AWS CloudFormation stack. By default, this value is set to No.
   DryRun (Optional): If you set this vale to Yes, then the runbook validates whether requirements are resized without changes to the instance type. By default, this value is set to No.
   SkipInstancesWithTagKey (Optional): Enter a tag key value for the automation to skip the target instance when the tag key is applied.
   SleepTime (Optional): The number of seconds the runbook sleeps after completion. By default, this value is set to 3 seconds.
   TagInstance (Optional): Tag the instances with a key and value that you choose. Use the following format: Key=ChangingType,Value=True.
   Note: This option tracks instances that the runbook targets. Tag keys and values are case sensitive.
   TargetInstanceTypeFromParameter (Optional): The instance type that you want to change your instance to. Keep this parameter empty to use the value of the tag key in the TargetInstanceTypeFromTagValue parameter.
   TargetInstanceTypeFromTagValue (Optional): The tag key that's applied to your target instances. This value contains the instance type that you want to change to. If you specify a value for TargetInstanceTypeFromParameter, then it overrides any value that you specify for this parameter.
   AutomationAssumeRole (Optional): The ARN of the IAM role that allows Systems Manager Automation to perform the actions for you. If you don't specify a role, then Systems Manager Automation uses the permissions of the user who starts this runbook.
4. Choose Execute.
   Note: For a list of the steps that the runbook performs, see the Document Steps section of AWSPremiumSupport-ResizeNitroInstance.

After the automation completes, review the Outputs section to see detailed results.

Related information

Run an automation

Setting up Automation