Connect Cribl Search to AWS API
Configure Cribl Search to query an AWS API endpoint.
Amazon Web Services (AWS) offers scalable and cost-effective cloud computing solutions.
In this guide, you’ll set up a Dataset Provider and a Dataset to search the AWS API supporting the following endpoints:
| Product | Endpoints |
|---|---|
| EC2 | EC2 Instances, EC2 Volumes, EC2 Security Groups |
| Lambda | Lambda Functions |
| IAM | Users, Roles, Groups, Policies, MFA Devices |
| CloudFormation | StackSets, Stacks, Exports |
| DynamoDB | Backups |
| RDS | Clusters, Cluster Endpoints, Instances, Security Groups, Certificates |
| CloudTrail | Events |
| VPC | VPCs, Subnets, Network Interfaces |
| EFS | File Systems |
Add an AWS API Dataset Provider
A Dataset Provider tells Cribl Search where to query and contains access credentials. Here, you will add an AWS API Dataset Provider.
To add a new Dataset Provider, select Data, then Dataset Providers, then Add Provider.
Set the following configurations in the New Dataset Provider modal:
- ID is a unique identifier for the Dataset Provider. This is how you’ll reference it when assigning Datasets to
it. Start the ID with a letter; the rest of the ID can use letters, numbers, and underscores (for example,
my_dataset_provider_1). - Description is optional.
- Set Dataset Provider Type to AWS API.
- Authentication method provides two options, Assume Role and AWS keys. See how to grant access to AWS for details on each option.
- Select Add Configuration to specify your AWS account. The configuration depends on the Authentication method
selected and you can use only one method for all configurations. In the Account Configurations table:
- Assume Role requires the IAM role’s ARN (AssumeRole ARN) and has options to define an External ID and
Duration.
- The External ID on the Dataset Provider must match the external ID defined in the IAM Role Trust Policy.
- Duration defines the Assumed Role’s session length of time, in seconds. Minimum is
900(15 minutes), default is3600(1 hour), and maximum is43200(12 hours).
- AWS keys requires the IAM user’s account Name, Access key, and Secret key.
- Assume Role requires the IAM role’s ARN (AssumeRole ARN) and has options to define an External ID and
Duration.
- Select Save when finished.
For details on obtaining your AWS credentials, see Grant Access to AWS.
Permission Requirements for AWS API
Accessing specific AWS endpoints requires the following permissions:
| Endpoint | Permission |
|---|---|
ec2_instancesec2_volumesec2_security_groups | ec2:DescribeInstancesec2:DescribeVolumesec2:DescribeSecurityGroupsor ec2:Describe* |
lambda_functions | lambda:ListFunctions |
iam_usersiam_groupsiam_policiesiam_rolesiam_mfa_devices | iam:ListPoliciesiam:ListRolesiam:ListUsersiam:ListGroupsiam:ListMFADevices |
cloudformation_stackscloudformation_stacksetscloudformation_exports | cloudformation:ListExportscloudformation:ListStackscloudformation:ListStackSets |
dynamodb_backups | dynamodb:ListBackups |
rds_clustersrds_cluster_endpointsrds_instancesrds_security_groupsrds_certificates | rds:DescribeDBInstancesrds:DescribeDBClusterEndpointsrds:DescribeDBSecurityGroupsrds:DescribeCertificatesrds:DescribeDBClustersor rds:Describe* |
cloudtrail_events | cloudtrail:LookupEvents |
vpc_vpcsvpc_subnetsvpc_network_interfaces | ec2:DescribeNetworkInterfacesec2:DescribeVpcsec2:DescribeSubnets |
efs_file_systems | elasticfilesystem:DescribeFileSystems |
Add an AWS API Dataset
Now you’ll add a Dataset that tells Cribl Search what data to search from the Dataset Provider.
To add a new Dataset, select Data, then Datasets, then Add Dataset.
Set the following configurations in the New Dataset modal:
- ID is an identifier unique for both Cribl Search and Cribl Lake. You’ll use this to specify the
Dataset in a query’s scope, telling Cribl Search to search the Dataset. Start the ID with a letter; the rest of the ID can use letters, numbers, and underscores (for example,
my_dataset_1). - Description is optional.
- Set Dataset Provider to the ID of an AWS Dataset Provider.
- Under Enabled endpoint, select Add Endpoints to select the endpoints for your Dataset. Select an endpoint
from the drop-down menu. Your options are:
ec2_instancesec2_volumesec2_security_groupslambda_functionsiam_usersiam_rolesiam_groupsiam_policiesiam_mfa_devicescloudformation_stackscloudformation_stacksetscloudformation_exportsdynamodb_backupsrds_exportsrds_backupsrds_clustersrds_cluster_endpointsrds_instancesrds_security_groupsrds_certificatescloudtrail_eventsvpc_subnetsvpc_network_interfacesefs_file_systems
- Under AWS Regions, select Add Regions to specify the AWS Regions to query for the endpoint(s).
- In Processing, you can apply rules for breaking data into discrete events. For more information, see Datatypes.
- In Snapshots, you can set up API Snapshots.
- Select Save when finished.
Search AWS API
Now that you have a Dataset Provider and Dataset, you’re ready to start searching.
Search results can start showing up within a second or two, but when the search completes depends on how much data there is in the account.