CSE AWS EC2 Inventory Source

The CSE 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 Enterprise, see Inventory Sources and Data.

Inventory data mapped

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

CSE schema attribute	AWS source field
ip	PublicIpAddress. If null, then PrivateIpAddress
hostname	PublicDnsName. If null, then PrivateDnsName
uniqueId	AccountId from ARN-InstanceId

Authentication

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

Create a CSE AWS EC2 Inventory Source

When you create a CSE 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 CSE 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 Enterprise. When configured with the Forward to SIEM option the following metadata fields are set:
   • _siemVendor: Amazon
   • _siemProduct: AWS EC2 Inventory
   • _siemDataType: Inventory
7. (Optional) Fields. Click the +Add Field link to define the fields you want to associate, each field needs a name (key) and value.
   •  A green circle with a check mark is shown when the field exists in the Fields table schema.
   •  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 Key and AWS Secret Key. Provide the IAM User access key ID and secret key you want to use to authenticate collection requests.
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. When you are finished configuring the Source, click Submit.

Error types

When Sumo Logic detects an issue it is tracked by Health Events. The following table shows the three possible error types, the reason the error would occur, if the Source attempts to retry, and the name of the event log in the Health Event Index.

Type	Reason	Retries	Retry Behavior	Health Event Name
ThirdPartyConfig	Normally due to an invalid configuration. You'll need to review your Source configuration and make an update.	No retries are attempted until the Source is updated.	Not applicable	ThirdPartyConfigError
ThirdPartyGeneric	Normally due to an error communicating with the third party service APIs.	Yes	The Source will retry for up to 90 minutes, after which it quits.	ThirdPartyGenericError
FirstPartyGeneric	Normally due to an error communicating with the internal Sumo Logic APIs.	Yes	The Source will retry for up to 90 minutes, after which it quits.	FirstPartyGenericError

Restarting your Source

If your Source encounters ThirdPartyConfig errors, you can restart it from either the Sumo Logic UI or Sumo Logic API.

UI

To restart your source in the Sumo Logic platform, follow the steps below:

1. Open the Collection page, and go to Manage Data > Collection > Collection.
2. Select the source and click the information icon on the right side of the row.
3. The API usage information popup is displayed. Click the Restart Source button on the bottom left.
   
4. Click Confirm to send the restart request.
   
5. The bottom left of the platform will provide a notification informing you the request was successful.
   

API

To restart your source using the Sumo Management API, follow the instructions below:

• Method: POST
• Example endpoint:

  https://api.sumologic.com/api/v1/collectors/{collector_id}/sources/{source_id}/action/restart

Sumo Logic endpoints like api.sumologic.com are different in deployments outside us1. For example, an API endpoint in Europe would begin api.eu.sumologic.com. A service endpoint in us2 (Western U.S.) would begin service.us2.sumologic.com. For more information, see Sumo Logic Endpoints.

JSON configuration

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. 

Parameter	Type	Required	Description	Access
config	JSON Object	Yes	Contains the configuration parameters for the Source.
schemaRef	JSON Object	Yes	Use {"type":"CSE AWS EC2 Inventory"}.	not modifiable
sourceType	String	Yes	Use Universal.	not modifiable

The following table shows the **config** parameters.

Parameter	Type	Required?	Default	Description	Access
name	String	Yes		Type a desired name of the Source. The name must be unique per Collector. This value is assigned to the metadata field _source.	modifiable
description	String	No	null	Type a description of the Source.	modifiable
category	String	No	null	Type a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details.	modifiable
fields	JSON Object	No		JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.	modifiable
regions	String array	Yes		Provide a list of AWS regions to query EC2 instances, such as us-east-2. Use ["all"] to support all regions.	modifiable
access_key	String	Yes		Provide the IAM User access key ID you want to use to authenticate collection requests.	modifiable
secret_key	String	Yes		Provide the Secret Key you want to use to authenticate collection requests.	modifiable
polling_interval	Integer	No	600	The minutes in between checks for new data.	modifiable

CSE AWS EC2 Inventory Source JSON example:

{
  "api.version":"v1",
  "source":{
    "config":{
      "name":"AWS Inventory",
      "access_key":"********",
      "polling_interval":600,
      "regions":["all"],
      "secret_key":"********",
      "fields":{
        "_siemForward":true
      },
      "category":"aws/inventory"
    },
    "state":{
      "state":"Collecting"
    },
    "schemaRef":{
      "type":"CSE AWS EC2 Inventory"
    },
    "sourceType":"Universal"
  }
}

States

A CSE AWS EC2 Inventory Source tracks errors, reports its health, and start-up progress. You’re informed, in real-time, if the Source is having trouble connecting, if there's an error requiring user action, or if it is healthy and collecting by utilizing Health Events.

A CSE AWS EC2 Inventory Source goes through the following states when created:

1. Pending. Once the Source is submitted, it is validated, stored, and placed in a Pending state.
2. Started. A collection task is created on the Hosted Collector.
3. Initialized. The task configuration is complete in Sumo Logic.
4. Authenticated. The Source successfully authenticated with AWS EC2 Inventory.
5. Collecting. The Source is actively collecting data from AWS EC2 Inventory.

If the Source has any issues during any one of these states, it is placed in an Error state.

When you delete the Source, it is placed in a Stopping state. When it has successfully stopped, it is deleted from your Hosted Collector.

On the Collection page, the Health and Status for Sources is displayed. Use Health Events to investigate issues with collection. You can click the text in the Health column, such as Error, to open the issue in Health Events to investigate.

Hover your mouse over the status icon to view a tooltip with details on the detected issue.