Skip to main content

Cloud SIEM AWS EC2 Inventory Source

icon

The Cloud SIEM AWS EC2 Inventory Source provides a secure endpoint to receive event data from the EC2 describe instances API. It securely stores the required authentication, scheduling, and state tracking information.

For information on how inventory data is used in Cloud SIEM, see Inventory Sources and Data.

note

This source is not available in the Fed deployment.

Data collected

Polling IntervalData
10 hoursEvent data

Setup

Vendor configuration

Inventory data mapped

The table below shows the AWS source fields that Cloud SIEM maps to Cloud SIEM schema attributes.

Cloud SIEM schema attributeAWS source field
ipPublicIpAddress. If null, then PrivateIpAddress
hostnamePublicDnsName. If null, then PrivateDnsName
uniqueIdAccountId from ARN-InstanceId

Authentication

The IAM policy needs the ec2:DescribeInstances and ec2:DescribeImages permissions.

Source configuration

When you create a Cloud SIEM AWS EC2 Inventory Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector.

To configure a Cloud SIEM AWS EC2 Inventory Source:

  1. In Sumo Logic, select Manage Data > Collection > Collection
  2. On the Collection page, click Add Source next to a Hosted Collector.
  3. Select AWS EC2 Inventory.
  4. Enter a Name for the Source. The description is optional.
  5. (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
  6. Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM.
  7. (Optional) Fields. Click the +Add Field link to define the fields you want to associate, each field needs a name (key) and value.
    • green check circle.png A green circle with a check mark is shown when the field exists in the Fields table schema.
    • orange exclamation point.png An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo that does not exist in the Fields schema it is ignored, known as dropped.
  8. AWS Access. The integration is configured for either role based AWS authentication or key based AWS authentication.
    • Role Based Access. AWS Role ARN is required for Role based Access. Use the information provided on the source page to configure the role.
      role-based
    • Key Access. Enter the IAM user access key ID and secret key you want to use to authenticate collection requests.
      key-based
  9. Regions. Provide a list of AWS regions to query EC2 instances, such as us-east-2.
  10. (Optional) The Polling Interval is set for 600 minutes by default, you can adjust it based on your needs.
  11. Processing Rules for Logs (Optional). Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in Create a Processing Rule.
  12. When you are finished configuring the Source, click Save.

Metadata fields

FieldValueDescription
_siemVendorAmazonSet when Forward To SIEM is checked.
_siemProductAWS EC2 InventorySet when Forward To SIEM is checked.
_siemDataTypeInventorySet when Forward To SIEM is checked.

JSON schema

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details. 

ParameterTypeValueRequiredDescription
schemaRefJSON Object{"type":"Cloud SIEM AWS EC2 Inventory"}YesDefine the specific schema type.
sourceTypeString"Universal"YesType of source.
configJSON ObjectConfiguration objectYesSource type specific values.

Configuration Object

ParameterTypeRequiredDefaultDescriptionExample
nameStringYesnullType a desired name of the source. The name must be unique per Collector. This value is assigned to the metadata field _source."mySource"
descriptionStringNonullType a description of the source."Testing source"
categoryStringNonullType a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details."mySource/test"
fieldsJSON ObjectNonullJSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.{"_siemForward": false, "fieldA": "valueA"}
limitToRegions`String arrayYesProvide a list of AWS regions to query EC2 instances, such as us-east-2. Use ["all"] to support all regions.modifiable
authentication.typeStringYesnullAWS Role Based AuthenticationSelect how Sumo Logic should access your AWS account.
authentication.roleARNStringYesnullProvide the IAM Role ARN you want to use to authenticate collection requests.
authentication.awsIdStringYesnullProvide the IAM User access key ID you want to use to authenticate collection requests.
authentication.roleARNStringYesnullProvide the Secret Key you want to use to authenticate collection requests.
polling_intervalIntegerNo600The minutes in between checks for new data.

JSON example

{
"api.version":"v1",
"source":{
"config":{
"name":"AWS Inventory",
"fields":{
"_siemForward":true
},
"category":"aws/inventory",
"limitToRegions":["all"],
"authentication":{
"type": "AWSRoleBasedAuthentication",
"roleARN": "arn:aws:iam::9568827XXXX:role/C2C_EC2InventoryTest"
},
"polling_interval":600
},
"state":{
"state":"Collecting"
},
"schemaRef":{
"type":"Cloud SIEM AWS EC2 Inventory"
},
"sourceType":"Universal"
}
}

Download example

{
"api.version":"v1",
"source":{
"config":{
"name":"AWS Inventory",
"fields":{
"_siemForward":true
},
"category":"aws/inventory",
"limitToRegions":["all"],
"authentication":{
"type": "S3BucketAuthentication",
"awsId": "XXXXXXSVHNHFXXXXXXX",
"awsKey": "XXXXXtrrIqHvXgMYJEQcwLfEQtyNXXXXXXXX"
},
"polling_interval":600
},
"state":{
"state":"Collecting"
},
"schemaRef":{
"type":"Cloud SIEM AWS EC2 Inventory"
},
"sourceType":"Universal"
}
}

Download example

Terraform example

resource "sumologic_cloud_to_cloud_source" "cloud_siem_aws_ec2_inventory_source" {
collector_id = sumologic_collector.collector.id
schema_ref = {
type = "Cloud SIEM AWS EC2 Inventory"
}
config = jsonencode({
"name":"AWS Inventory",
"fields":{
"_siemForward":true
},
"category":"aws/inventory",
"limitToRegions":["all"],
"authentication":{
"type": "AWSRoleBasedAuthentication",
"roleARN": "arn:aws:iam::9568827XXXX:role/C2C_EC2InventoryTest"
},
"polling_interval":600
})
}
resource "sumologic_collector" "collector" {
name = "my-collector"
description = "Just testing this"
}

Download example

resource "sumologic_cloud_to_cloud_source" "cloud_siem_aws_ec2_inventory_source" {
collector_id = sumologic_collector.collector.id
schema_ref = {
type = "Cloud SIEM AWS EC2 Inventory"
}
config = jsonencode({
"name":"AWS Inventory",
"fields":{
"_siemForward":true
},
"category":"aws/inventory",
"limitToRegions":["all"],
"authentication":{
"type": "S3BucketAuthentication",
"awsId": "XXXXXXSVHNHFXXXXXXX",
"awsKey": "XXXXXtrrIqHvXgMYJEQcwLfEQtyNXXXXXXXX"
},
"polling_interval":600
})
}
resource "sumologic_collector" "collector" {
name = "my-collector"
description = "Just testing this"
}

Download example

FAQ

info

Click here for more information about Cloud-to-Cloud sources.

Legal
Privacy Statement
Terms of Use

Copyright © 2024 by Sumo Logic, Inc.