EC2 AWS CLI Adapter

Refer to our documentation IguanaX Installation and AWS CLI if you have not installed them.

You can use this url:

git@bitbucket.org:interfaceware/ec2awscli.git

This adapter is built as a Library, so you can also create your own component and simply import the EC2 Library into your project. See Import Library.

There are two custom fields to set:

• ltemplate: AWS EC2 Instance Launch Template ID (ex. lt-0123456789abcdef0) will be used to programmatically run an EC2 instance. You can find this value in your AWS Console > Services > EC2 > Instance > Launch Templates.

• resultsout: File directory location to store temporary result files. You can leave this as is or change to a directory of your choice.

These are a component’s Custom Fields.

In main.lua, update the functions and try out the different EC2 methods by uncommenting the sample function calls. Continue on reading this doc for examples of each method.

Uncomment sampleAllocateIp() and see the results in your AWS Console. Go to EC2 > Network & Security > Elastic IPs.

Note the Allocation ID value. We’ll use this later when we associate this IP.

Go to the sampleRunInstance function and replace the parameters with your launchTemplate ID, Name and optional CNAME. Uncomment sampleRunInstance() to launch a new instance using your launch template.

You can also access your launchTemplate ID in your custom fields!

See the results in your AWS Console in EC2 > Instances. Copy the Instance ID for the next call.

In sampleDescribeInstance(), replace the Instance ID with your value and uncomment sampleDescribeInstance() in main to run the function. With this command, you can retrieve details of one or more instances by providing a list of Instance IDs

The result will look something like this sample:

{
    “Reservations”: [
        {
            “Groups”: [],
            “Instances”: [
                {
                    “AmiLaunchIndex”: 0,
                    “ImageId”: “ami-00903e1945998682a”,
                    “InstanceId”: “i-0c3eeb68afc0672c6",
                    “InstanceType”: “t2.micro”,
                    “KeyName”: “mykey”,
                    “LaunchTime”: “2023-12-17T19:50:10+00:00",
                    “Monitoring”: {
                        “State”: “disabled”
                    },
                    “Placement”: {
                        “AvailabilityZone”: “us-east-1”,
                        “GroupName”: “”,
                        “Tenancy”: “default”
                    },
                    “PrivateDnsName”: “ip-172-31-36-128.ec2.internal”,
                    “PrivateIpAddress”: “172.31.36.128",
                    “ProductCodes”: [],
                    “PublicDnsName”: “ec2-52-207-82-96.compute-1.amazonaws.com”,
                    “PublicIpAddress”: “52.207.82.96”,
.
.
.

Paste in your InstanceID and AllocationID from the Elastic IP we created earlier. Uncomment sampleAssociateIp() in main to run the function.

See the results in your AWS Console in EC2 > Instances.

Finally, use the sampleStopInstance() and sampleStartInstance() functions to change the instance state by changing the Instance ID parameter. See the instance state change in your AWS Console in EC2 > Instances.