Reboot stack - AMS Advanced Onboarding Guide

Reboot stack

Reboot a stack using the AMS console or the AMS API/CLI.

Classification: Management | Standard stacks | Stack | Reboot

Change type ID: ct-02u0hoaa9grat

Required Data:

  • Subject: A title for the request.

  • StackId: The stack that you want rebooted. For help finding stack IDs, see Find Stack Id.

Screenshot of this change type in the AMS console:

How it works:

  1. Navigate to the Choose change type page: RFCs -> Create RFC.

  2. Choose a change type from the drop-down lists. Optionally, open the Additional configuration area to select a change type version. After your selections are complete, a Change type: details area opens. Choose Next.

  3. Configure the request for change. A Subject is required. Optionally, open the Additional configuration area to add information about the RFC. Choose Next.

  4. Choose the execution parameters. At the top, in the RFC configuration area, enter values for the change type required parameters. These vary by change type. Open the Additional configuration area to add Tags or additional settings. Some change types also provide a Parameters area where only the required settings are visible. In that case, open the Additional configuration area to view optional parameters.

  5. When finished, choose Create. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Execution output.

  6. Open the Execution parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page.

How it works:

  1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here.

  2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID.

    Monitor the RFC: aws amscm get-rfc --rfc-id ID command.

To check the change type version, use this command:

aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID
Note

You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients\" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference.

INLINE CREATE:

Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this:

aws amscm create-rfc --change-type-id "ct-02u0hoaa9grat" --change-type-version "1.0" --title "Reboot My Stack" --execution-parameters "{\"StackId\":\"STACK_ID\"}"

TEMPLATE CREATE:

  1. Output the RFC template to a file in your current folder. This example names it RebootStackRfc.json. Note that since there is only one execution parameter for stopping (rebooting, or starting) an instance, the execution parameter can be in the schema JSON file itself and there is no need to create a separate execution parameters JSON file.

    aws amscm create-rfc --generate-cli-skeleton > StopInstanceRfc.json
  2. Modify and save the RebootStackRfc.json file.

    The internal quotation marks in the ExecutionParameters JSON extension must be escaped with a backslash (\). Example:

    { "ChangeTypeId": "ct-02u0hoaa9grat", "Title": "Reboot-My-EC2-RFC", "TimeoutInMinutes": 60, "ExecutionParameters": "{ \"StackId\":\"STACK_ID\" }" }
  3. Create the RFC:

    aws amscm create-rfc --cli-input-json file://RebootStackRfc.json

    You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start.