Get Instance by ID
AutomatR.AWS.Activities.GetInstanceByID
The "Get Instance by ID" activity in AutomatR is part of the AWS EC2 (Elastic Compute Cloud) activities package, enabling automation processes to retrieve details of a specific Amazon EC2 instance. This activity streamlines the process of obtaining information about 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 instance is created. Use the RegionEndpoint enumeration to set the region. |
| Instance ID | Specifies the unique identifier of the EC2 instance for which details should be retrieved. 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 "Get Instance by ID" 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 | Retrieves details about an EC2 instance and stores the result in an Instance variable for further activities. Variables of type Instance to store the details of the EC2 instance. |
How to use:
- Drag and drop the "Get Instance by ID" activity onto the workflow.
- Configure the properties by providing the required inputs, such as access key ID, secret access key, region, and EC2 instance ID.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to retrieve details about the specified EC2 instance.
Example: Consider an example where the "Get Instance by ID" activity is used to retrieve details about an EC2 instance with the ID "i-1234567890abcdef0" in the "us-east-1" region:
Get Instance by ID:
Display Name: "Retrieve EC2 Instance Details"
Access Key ID: "**************"
Secret Access Key: "**************"
Region: "us-east-1"
Instance ID: "i-1234567890abcdef0"
Instance: ec2InstanceDetails
In this example, the activity retrieves details about the EC2 instance with the ID "i-1234567890abcdef0" in the "us-east-1" region. The result is stored in the variable "ec2InstanceDetails" of type Instance for further handling in the workflow.