Get Instance List
AutomatR.AWS.Activities.GetInstanceList
The "Get Instance List" activity in AutomatR is part of the AWS EC2 (Elastic Compute Cloud) activities package, enabling automation processes to retrieve a list of instances matching specific filter criteria. This activity streamlines the process of obtaining information about multiple EC2 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 AWS region in which the EC2 instances are created. Use the RegionEndpoint enumeration to set the region. |
| 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 "Get Instance List" 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 List | Retrieves a list of instances matching specific filter criteria and stores the result in a List<Amazon.EC2.Model.Instance> variable for further activities. Variables of type List<Amazon.EC2.Model.Instance> to store the list of EC2 instances. |
How to use:
- Drag and drop the "Get Instance List" activity onto the workflow.
- Configure the properties by providing the required inputs, such as access key ID, secret access key, and region.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to retrieve a list of EC2 instances based on the specified criteria.
Example: Consider an example where the "Get Instance List" activity is used to retrieve a list of all EC2 instances in the "us-east-1" region:
Get Instance List:
Display Name: "Retrieve All EC2 Instances"
Access Key ID: "**************"
Secret Access Key: "**************"
Region: "us-east-1"
Instance List: ec2Instances
In this example, the activity retrieves a list of all EC2 instances in the "us-east-1" region. The result is stored in the variable "ec2Instances" of type List<Amazon.EC2.Model.Instance> for further handling in the workflow.