Restart Instance
AutomatR.AWS.Activities.RestartInstance
The "Restart Instance" activity in AutomatR is part of the AWS EC2 activities package, enabling automation processes to restart an EC2 instance within Amazon Web Services. This activity streamlines instance management tasks, enhancing the efficiency of automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Access Key ID | Provides the encrypted access key ID for your AWS account, enabling connection to the AWS EC2 service. String variables containing the access key ID. |
| Secret Access Key | Provides the encrypted secret access key for your AWS account, enabling connection to the AWS EC2 service. String variables containing the secret access key. |
| Region | Specifies the valid AWS region where your EC2 instance is currently running and where you would like to restart it. Use the RegionEndpoint enumeration to set the region. |
| Instance ID | Specifies the valid instance ID of the EC2 instance that you want to restart. String variables containing the instance ID. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variable or argument containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Restart Instance" activity. Useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the wait time is 1000 milliseconds or 1 sec, i.e., 1. |
How to use:
- Drag and drop the "Restart Instance" activity onto the workflow.
- Configure the properties by providing the required inputs, such as access key ID, secret access key, region, and instance ID.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to restart the specified EC2 instance.
Example: Consider an example where the "Restart Instance" activity is used to restart an EC2 instance with the ID "i-1234567890abcdef0" in the "us-east-1" region:
Restart Instance:
Display Name: "Restart EC2 Instance"
Access Key ID: "**************"
Secret Access Key: "**************"
Region: "us-east-1"
Instance ID: "i-1234567890abcdef0"
In this example, the activity restarts the specified EC2 instance. Any errors encountered during the restart process are thrown as exceptions. Customize the display name based on your workflow requirements.