EC2 - Stop Instance

Declaration

<!--<AMAWSEC2 ACTIVITY="stop_instance" INSTANCEID="text" RESULTDATASET="text" FORCE="Yes/No" />-->

See Also

EC2 - Allocate Address, EC2 - Associate Address, EC2 - Attach Volume, EC2 - Authorize Security Group, EC2 - Create Key Pair, EC2 - Create Security Group, EC2 - Create Session, EC2 - Create Snapshot, EC2 - Create Volume, EC2 - Delete Key Pair, EC2 - Delete Security Group, EC2 - Delete Snapshot, EC2 - Delete Volume, EC2 - Disassociate Address, EC2 - End Session, EC2 - Launch Instance, EC2 - List Addresses, EC2 - List Images, EC2 - List Key Pairs, EC2 - List Running Instances, EC2 - List Security Groups, EC2 - List Snapshots, EC2 - List Volumes,  EC2 - Reboot Instance, EC2 - Release Address, EC2 - Revoke Security Group, EC2 - Start Instance, EC2 - Terminate Instance

Description

Stops an instance that uses an Amazon EBS (Elastic Block Store) volume as its root device. When you stop an EC2 instance, the instance will be shutdown and the virtual machine that was provisioned for you will be permanently taken away and you will no longer be charged for instance usage. The key difference between stopping and terminating an instance is that the attached bootable EBS volume will not be deleted. The data on your EBS volume will remain after stopping while all information on the local (ephemeral) hard drive will be lost as usual.

Amazon EBS provides block level storage volumes for use with EC2 instances. EBS volumes are off-instance storage that persists independently from the life of an instance. Amazon Elastic Block Store provides highly available, highly reliable storage volumes that can be attached to a running Amazon EC2 instance and exposed as a device within the instance.

IMPORTANT: The EC2 activities are performed using Amazon's EC2 engine. You must enter a valid Amazon EC2 service account in order for these activities to work properly.

Practical Usage

Commonly used to stop an EC2 instance. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage.

Parameters

Instance Properties

Property

Type

Required

Default

Markup

Description

Instance ID

Text

Yes

(Empty)

INSTANCEID="i-3711a35c"

The instance ID to stop.

Force

Yes/No

No

No

FORCE="yes"

If set to YES, forces the instance to stop.

NOTE: If enabled, the instance will not have an opportunity to flush file system caches nor file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Create and populate dataset with EC2 instance information

Text

No

(Empty)

RESULTDATASET="info"

The name of the dataset to be created and populated with information about the EC2 instance to stop. More on datasets below under Notes.

 

Credentials Properties

These properties allow you to create a custom session for this activity or link this activity to an existing session.

Property

Type

Required

Default

Markup

Description

Provide Credentials

 

 

 

 

Indicates where this activity's credentials should originate from. Different properties apply depending on the option selected.

The available options are:

  • Custom (Default) - Specifies that a custom set of credentials will be entered for this EC2 activity. Select this option if performing a single EC2 activity.

  • Session Based - Specifies that credentials should derive from a session created in a previous step with the use of the Create Session activity. This allows several EC2 activities to be linked to a specific session.

Access Key

Text

Yes

(Empty)

ACCESSKEY="MyAccessKey"

A 20-character, alphanumeric string that uniquely identifies a user who owns a EC2 account (i.e. 022QF06E7MXBSH9DHM02). This along with a Secret Access Key forms a secure information set that EC2 uses to confirm a valid user's identity.

This property is active only if Custom is selected under the Provide Credentials property.

Secret Access Key

Text

Yes

(Empty)

SECRETKEY="SecretKey"

A 40-character string that serves the role as Password to access EC2 (i.e. kWcrlUX5JEDGM/LtmEENI/aVmYvHNif5zB+d9+ct). This along with an associated Access Key forms a secure information set that EC2 uses to confirm a valid user's identity.

This property is active only if Custom is selected under the Provide Credentials property.

User Agent

Text

No

AutoMate

USERAGENT="AutoMate"

The User-Agent header name. The User-Agent request-header field contains information about the user agent originating the request such as timeouts, proxies, name, etc. The default User Agent name is AutoMate.

This property is active only if Custom is selected under the Provide Credentials property.

Service URL

Text

No

(Empty)

SERVICEURL=

"https://sdb.eu-west-1.amazonaws.com"

The Service URL used to make requests to the EC2 service. The Service URL provides the service endpoint. For example, To make the service call to a different region, you can pass the region-specific endpoint, such as 'https://sdb.eu-west-1.amazonaws.com'.

This property is active only if Custom is selected under the Provide Credentials property.

Maximum retry on error

Number

No

(Empty)

MAXERRORRETRY="4"

Signifies how many times the Amazon EC2 engine should retry the request before returning an error.

This property is active only if Custom is selected under the Provide Credentials property.

Proxy Host

Text

No

(Empty)

PROXYHOST="proxy.host.com"

The host name (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server.

This property is active only if Custom is selected under the Provide Credentials property.

Proxy Port

Number

No

(Empty)

PROXYPORT="1028"

The port that should be used to connect to the proxy server.

This property is active only if Custom is selected under the Provide Credentials property.

Signature Method

Text

No

(Empty)

SIGNMETHOD="HmacSHA256"

The Signature Method for signing the request.

This property is active only if Custom is selected under the Provide Credentials property.

Signature Version

Number

No

(Empty)

SIGNVERSION="2"

The Signature Version for signing the request. The version refers to the particular algorithm for signing the request.

This property is active only if Custom is selected under the Provide Credentials property.

Session Name

Text

Yes

EC2Session

SESSION="EC2Session1"

The session name to be created. This allows several EC2 activities to be linked to this  session, eliminating redundancy. Numerous sessions can be used within a single task. The default value is EC2Session.

NOTE: Use the End Session activity to end an EC2 session.

This property is active only if Session Based is selected under the Provide Credentials property.

↑ Top of Page

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab properties allows you to instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.

More on Error Causes properties

On Error Properties

The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.

More about On Error properties

Notes

Datasets

A dataset is a multiple column, multiple row container object. This activity creates and populates a dataset containing a specific set of fields in addition to the standard dataset fields. This activity returns a dataset table that contains the following information (assuming the dataset name assigned is theDataset).

Name

Type

Return Value

theDataset.InstanceId

Text

Returns the stopped instance Id.

theDataset.CurrentState

Text (Options)

Status of the DB instance. Valid values are:

  • creating

  • available

  • deleting

theDataset.PreviousState

Text (Options)

Previous status of the DB instance. Valid values are:

  • creating

  • available

  • deleting

Expressions, Variables and Functions

All text fields allow the use of expressions such as variables, functions or AutoMate extended functions, which can be entered by surrounding the expression in percentage signs (example: %FileDateTime(myVar)% or %myVar%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by clicking the Insert Expression (%) button or by pressing F2.

More on expressions

More on variables

More on function

More on extended functions
More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

 

Description: Stop instance(s) "i-3711a35c". Store EC2 instance information into dataset "info". Force the instance to stop. Use default EC2 session.

 

<AMAWSEC2 ACTIVITY="stop_instance" INSTANCEID="i-3711a35c" RESULTDATASET="info" FORCE="yes" />

 

↑ Top of Page