AWS
stop_instance
Stop a single EC2 instance
Stop the given EC2 instances or, if none is provided, all instances of the given availability zone
Below are the details and signature of the activity Python module.
Type | action |
Module | chaosaws.ec2.actions |
Name | stop_instance |
Return | list |
Usage
JSON
{
"name": "stop-instances",
"type": "action",
"provider": {
"type": "python",
"module": "chaosaws.ec2.actions",
"func": "stop_instances"
}
}
YAML
name: stop-instances
provider:
func: stop_instances
module: chaosaws.ec2.actions
type: python
type: action
Arguments
Name | Type | Default | Required | Title | Description |
---|---|---|---|---|---|
instance_ids | list | null | No | Instance IDs | List of instance identifiers, or filters below |
filters | list | null | No | Instance Filters | List of key/value pairs to select instances |
az | string | null | No | Availability Zone | Availability zone to target. If the other fields are left empty, all instances in this AZ will be stopped |
force | boolean | false | No | Force | Force the operation |
If you need more control, you can also provide a list of filters following the documentation https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_instances
Signature
def stop_instances(
instance_ids: List[str] = None,
az: str = None,
filters: List[Dict[str, Any]] = None,
force: bool = False,
configuration: Dict[str, Dict[str, str]] = None,
secrets: Dict[str, Dict[str, str]] = None) -> List[Dict[str, Any]]:
pass