AWS::EC2::Instance State - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::EC2::Instance State

Describes the current state of an instance.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Code" : String,
  "Name" : String
}

YAML

  Code: String
  Name: String

Properties

Code

The state of the instance as a 16-bit unsigned integer.

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.

The valid values for instance-state-code will all be in the range of the low byte and they are:

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.

Required: No

Type: String

Update requires: No interruption

Name

The current state of the instance.

Required: No

Type: String

Allowed values: pending | running | shutting-down | terminated | stopping | stopped

Update requires: No interruption