This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.AWS.EC2.
Summary
Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions
happen multiple times within a single hour. You can't start or stop Spot Instances.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released
and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged
for Amazon EBS volume usage. You can restart your instance at any time. Before stopping an instance, make sure it is in a state from which it can be
restarted. Stopping an instance does not preserve data stored in RAM. Performing this operation on an instance that uses an instance store as its root device returns an error.
- Assembly
- Cake
.AWS .EC2 .dll - Namespace
- Cake
.AWS .EC2 - Containing Type
- IEC2Manager
Syntax
Task<bool> StopInstances(IList<string> instances, EC2Settings settings, CancellationToken cancellationToken = null)Parameters
| Name | Type | Description |
|---|---|---|
| instances | IList |
A list of instance IDs to be stopped. |
| settings | EC2Settings | The EC2Settings used during the request to AWS. |
| cancellationToken | CancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Return Value
| Type | Description |
|---|---|
| Task |