Copy page

AWS

Security Groups

Describes Security Groups from your Instances in AWS.

Sync Type: Full Synchronisation

Details

When the input is run, it retrieves all security groups (optionally narrowed by the configured filters) from the specified AWS region. The sync runs on a scheduled basis according to your cron configuration. Monad uses the EC2 DescribeSecurityGroups API to fetch current security group configurations, including inbound and outbound rules, tags and metadata. The instances or network interfaces that use each security group are not retrieved. Each sync re-lists every security group, so the same groups are emitted again on every run.

Requirements

• IAM Role Assumption / Static Credentials
• Example permission to attach to the role/user:

Code
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "ec2:DescribeSecurityGroups"
      ],
      "Resource": "*"
    }
  ]
}

Configuration

The following configuration defines the input parameters. Each field's specifications, such as type, requirements, and descriptions, are detailed below.

Settings

Setting	Type	Required	Default	Description
cron	string (cron)	Yes	0 * * * *	Cron string for scheduling the ingest of your input. eg: 0 0 * * * - Daily at midnight, or */15 * * * * - Every 15 minutes. Defaults to an hour.
region	string	Yes	us-east-1	The AWS region to use. Allowed values: us-east-1, us-east-2, us-west-1, us-west-2, af-south-1, ap-east-1, ap-south-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-southeast-1, ap-southeast-2, ca-central-1, ca-west-1, cn-north-1, cn-northwest-1, eu-central-1, eu-west-1, eu-west-2, eu-west-3, eu-north-1, eu-south-1, me-south-1, sa-east-1, us-gov-east-1, us-gov-west-1.
role_arn	string	No	-	The ARN of the IAM role to assume for accessing AWS resources.
filters	array of object	No	[]	Optional filters to narrow down which security groups are retrieved. Each filter consists of an attribute name and one or more values to match against.
use_synthetic_data	bool	No	false	Generate synthetic data for testing, instead of connecting to a real data source. Defaults to an hourly cron schedule for cron-based inputs.

Code
{
  "Filters": [
    {
      "Name": "group-id",
      "Values": ["sg-abcd1234"]
    }
  ]
}

Secrets (Static Credentials Only)

Secret	Type	Required	Description
access_key	secret	No	The Access Key from AWS to authenticate with AWS
secret_key	secret	No	The Secret Key from AWS to authenticate with AWS

⚠️ Authentication: Choose either Role ARN (recommended) or static credentials. See AWS Authentication Guide for setup instructions.

Sample Record

Code
{
  "Description": "load balancer security group",
  "GroupId": "sg-be948f0938d4a038a",
  "GroupName": "default",
  "IpPermissions": [],
  "IpPermissionsEgress": [
    {
      "FromPort": null,
      "IpProtocol": "-1",
      "IpRanges": [
        {
          "CidrIp": "0.0.0.0/0",
          "Description": null
        }
      ],
      "Ipv6Ranges": [],
      "PrefixListIds": [],
      "ToPort": null,
      "UserIdGroupPairs": []
    }
  ],
  "OwnerId": "345056260303",
  "SecurityGroupArn": "arn:aws:ec2:us-east-1:345056260303:security-group/sg-be948f0938d4a038a",
  "Tags": [
    {
      "Key": "Environment",
      "Value": "staging"
    }
  ],
  "VpcId": "vpc-be948f0938d4a038a"
}

Sync frequency

This input runs on a cron schedule (default hourly, 0 * * * *), which you can configure on the pipeline. See Input Sync Frequency for details.