AWS EC2 Instance Stop Version 1

The stop_instance function can be executed against any valid instance in any state. When executed against an already stopped instance, the Previous Status and Current Status will both be "stopped".

The result of the stop_instance call is a mixed hash/array with the following structure:

Parameters

Name Description
Instance ID The instance id of the EC2 virtual machine that this handler will send a stop request to.

Sample Configuration

Name Description
Instance ID <%= @answers['Instance ID'] %>

Results

Name Description
Previous Status The state of the machine instance prior to the stop request being issued.
Current Status The state of the machine instance after the stop request. The state will typically be "stopping".

Changelog

AWS EC2 Instance Stop V1 (2011-03-04)

  • Initial version. See README for details.

AWS EC2 Instance Stop V1.1 (2017-08-24)

  • Update the EC2 gem to AWS SDK 2.2.34.

  • Change Info Values to be more consistent with the other AWS handlers.

  • Internal tweaks to make execution similar to other AWS handlers.

  • Remove Request Id from results because it is no longer supplied by the AWS EC2

API


Related Handlers

AWS EC2 Attach Internet Gateway
Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC.
AWS EC2 Create Internet Gateway
Creates an internet gateway
AWS EC2 Create Key Pair
Creates a 2048-bit RSA key pair with the specified name.
AWS EC2 Create Route Table
Creates a route table for the specified VPC.
AWS EC2 Create Security Group
This handler is used to create a security group in AWS.
AWS EC2 Create Tag
Creates a single tag against a single resource.
AWS EC2 Delete Internet Gateway
Deletes a VPC
AWS EC2 Delete Route Table
Deletes a specified route table.
AWS EC2 Delete Security Group
Deletes a security group.
AWS EC2 Delete Tag
Deletes a single tag against a single resource.
AWS EC2 Describe Availability Zone
Returns a single availability zone's Name, State, and Region.
AWS EC2 Describe Images
Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.
AWS EC2 Disassociate Route Table
Disassociates a subnet from a route table.
AWS EC2 Image Retrieve
Retrieves the properties of the image supplied
AWS EC2 Instance Retrieve Status
Retrieves the status of a particular EC2 instance.
AWS EC2 Instance Start
This handler sends a start request to an AWS EC2 machine instance
AWS EC2 Modify Instance Attribute
Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.
AWS EC2 Revoke Security Group Ingress
Removes one or more ingress rules from a security group.
AWS EC2 Run Instances
Launches the specified number of instances using an AMI for which you have permissions.