Table of Contents
You can access this feature in the Resource node right below the resource selection drop down menu.
What are Add-ons?
Add-ons allow you to enrich the resources data with additional qualities. You can use this enriched data in successor nodes, like Filter node, to selectively retain the resources required.
Example: Let's say you want to fetch instances that has port 22 open. When you fetch data of EC2 instances in the Resource node, it has attributes of instances alone. To filter instances that has an open port, you will need Security Groups associated with each instance. This requires us to fetch additional qualities of a resource, i.e. Add-ons. So, you will select Security Groups in the Add-ons for the fetched EC2 instances in the Resource node. The original data is enriched by the addon data.
Similarly, Volumes can be add-ons for EC2 instances, and Bucket Policies can be add-ons for S3 buckets.
The attributes of Add-ons are same as returned by the corresponding AWS API. So the data of describeSecurityGroups is available as output in addOns.Securitygroups when you select EC2 instances as resource and Security Groups as Add-ons in the Resource node.
Using an Add-On In a Resource Node
Here's how you can use add-ons in resource. We have used the above example for illustration purpose.
- Click on the Resource node's 'Edit' option to access the parameters input window.
- Select the relevant options as shown below.
- Click the Add-ons option. The Add-ons option is visible only when the Resource node is connected to the Filter node
- Select the relevant API, for example, Security Groups
- Click on 'Apply'
- Click on 'Save'
Selecting "EC2 Instances" and "Security Groups" as Add-ons enriches the EC2 instances' data with corresponding Security Groups data. With Add-ons of Security Groups, we have all the attributes of the security group available for further use. Here is how a sample output looks when you select Add-ons, such as SGs of instances:
"Description": "sg for lambda functions",
"Ipv6Ranges": [ ],
"PrefixListIds": [ ],
"UserIdGroupPairs": [ ]
Referencing an Add-On in Filter Parameters
Here's how you can reference an Add-on in the Filter node.
- Connect the Resource node to Filter node as show below
- Click on the Filter node to open the Filter node settings. See the options in the following figure
- The Add-Ons from Resource node can be referred as addons. "Quality" in the Filter node. You can refer the exact API (Quality) from the AWS API SDK Doc.
- Example 1: Key: addOns.IpPermissions.IpProtocol | Operator: == | Value: tcp
- Example 2: Key: addOns.IpPermissions.ToPort | Operator: == | Value: 80
- Click on 'Save'