Launch Instance
AutomatR.AWS.Activities.LaunchInstance
The "Launch Instance" activity in AutomatR is part of the AWS EC2 (Elastic Compute Cloud) activities package, enabling automation processes to launch EC2 instances within the Amazon Web Services (AWS) cloud. This activity streamlines the process of creating and launching virtual server instances, 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 desired AWS region in which you want to launch the EC2 instance. Use the RegionEndpoint enumeration to set the region. |
| Instance Name | Provides a valid name for the EC2 instance you want to launch. String variables containing the instance name. |
| Instance Type | Specifies the type of EC2 instance on which you want to perform the operation. String variables containing the instance type. |
| Image ID | Provides the image ID associated with the desired instance. String variables containing the image ID. |
| Key Name | Specifies either a public or private key name as the key name for launching an EC2 instance. String variables containing the key name. |
| Availability Zone | Provides valid availability zones available for launching instances in your AWS account. String variables containing the availability zone. |
| 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 "Launch 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. |
| Output | |
| Instance | Stores the result in a variable of type Instance, providing details about the launched EC2 instance. Variables of type Instance for further processing. |
How to use:
- Drag and drop the "Launch Instance" activity onto the workflow.
- Configure the properties by providing the required inputs, such as access key ID, secret access key, region, instance name, instance type, image ID, key name, and availability zone.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to launch the specified EC2 instance.
Example: Consider an example where the "Launch Instance" activity is used to launch a t2.micro instance named "MyInstance" in the "us-east-1" region:
Launch Instance:
Display Name: "Launch MyInstance"
Access Key ID: "**************"
Secret Access Key: "**************"
Region: "us-east-1"
Instance Name: "MyInstance"
Instance Type: "t2.micro"
Image ID: "ami-XXXXXXXXXXXXXXXXX"
Key Name: "MyKeyPair"
Availability Zone: "us-east-1a"
Instance: launchedInstance
In this example, the activity launches a t2.micro instance named "MyInstance" in the "us-east-1" region. The result of the operation, including details about the launched instance, is stored in the variable "launchedInstance" of type Instance for further handling in the workflow.