fargate API README

Description

Fargate API is designed to handle long-running processes on the backend. If you need to add any resource permissions to the container, please add policy statement to the TaskDefinitionTaskRoleDefaultPolicy282E8624 policy in the cloud formation template. API Tasks:

• Generates reports
• Imports
• Exports
• etc...

How to use

To start the container locally:

1. Update values in the containers/bigboy-api/.env file
2. Run pnpm run start:dev in the containers/bigboy-api folder
3. Wait for the container to start, this could take a few minutes

Inputs

A JSDoc style parameter definition for the input object properties

/**
 * @param {object} input - params for your request
 * @param {string} input.route - route to get your request to the right function call. Ex: "report/assessment"
 */

Example Call from frontend

/**
 * Input to generate a report
 */
const input = {
  route: "report/assessment",
  organizationID,
  assessmentID: item?.id,
  config: reportSettings?.reportConfig,
};

EventLogger("Sending request to upload fargateApi. Input: " + JSON.stringify(input));
await fargateApi({ input });

Outputs

Returns a job object, so you can track the progress of the request

Automations

Automations can be triggered in various ways, but the Automation steps always execute in fargate.

Create / Update Resource

The types of resources that can be created or updated via an Automation Step

• Control
• CustomResourceEntry
• Exercise
• Incident
• Metric
• Observation
• Policy
• PointOfContact
• Evidence
• InformationAsset
• Meeting
• RiskChange
• RiskControl
• System
• Target
• Threat
• Vendor
• VendorSolution
• Vulnerability