Control types for @turbot/aws

AWS > Account > Budget > Budget

Determine whether budget reporting is enabled for the AWS Account.\n\nIf enabled, the Budget control will gather cost data\nfrom the cloud provider, and will alarm if the\nBudget > State reaches the configured threshold.\n

URI
tmod:@turbot/aws#/control/types/budget
Category

AWS > Account > CMDB

Record and synchronize details for the AWS account into the CMDB.\n\nThe CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.\n\nIf set to Skip then all changes to the CMDB are paused - no new resources will be discovered, no updates will be made and deleted resources will not be removed.\n\nTo cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".\n

URI
tmod:@turbot/aws#/control/types/accountCmdb
Category

AWS > Account > Stack

Configure a custom stack on AWS, per the custom Stack > Source.\n\nA Guardrails Stack is a set of resources configured by Guardrails, as specified\nvia Terraform source. Stacks are responsible for the creation and deletion\nof multiple resources. Once created, stack resources are responsible for\nconfiguring themselves from the stack source via their Configured control.\n

URI
tmod:@turbot/aws#/control/types/accountStack

AWS > Region > Discovery

Discover Regions and add them to Guardrails.\n\nThe Discovery\ncontrol is tasked with identifying instances for a particular resource.\nThe Discovery control will periodically search for new target resources and\nsave them to the Guardrails CMDB.\n\nNote: The Discovery control also uses the Regions policy associated with\nthe resource. If the region is not in AWS > Account > Regions policy, the\nDiscovery control will delete the region from the CMDB.\n\nStatus:\n - Enabled - If the region is in the policy and enabled in AWS\n - Disabled - If the region is in the policy and disabled in AWS\n - Skipped - If the region is not in the policy and enabled in AWS\n

URI
tmod:@turbot/aws#/control/types/regionDiscovery
Category

AWS > Region > Stack

Configure a custom stack on AWS, per the custom Stack > Source.\n\nA Guardrails Stack is a set of resources configured by Guardrails, as specified\nvia Terraform source. Stacks are responsible for the creation and deletion\nof multiple resources. Once created, stack resources are responsible for\nconfiguring themselves from the stack source via their Configured control.\n

URI
tmod:@turbot/aws#/control/types/regionStack

AWS > Turbot

Turbot control root.

URI
tmod:@turbot/aws#/control/types/turbot
Parent
Category

AWS > Turbot > Audit Trail

Configure the Guardrails Audit Trail stack.\n\nThis stack configures an AWS CloudTrail which can log, continuously monitor,\nand record account activity.\n

URI
tmod:@turbot/aws#/control/types/auditTrail

AWS > Turbot > Event Handlers

Configure the set of resources in a Guardrails Stack per the Event Handlers >\nSource policy.\n\nGuardrails Stacks are used to manage a set of resources via Terraform.\nStacks are responsible for the creation and deletion of multiple resources,\nbut once created, the resources are responsible for configuring themselves\nwith their Configured control, using the Source from the parent stack.\n\nThe AWS Event Handlers stack is responsible for configuring the resources\nrequired for the Guardrails Event Handler, which attaches the Guardrails Router to\na cloud provider's audit trail. This is a pre-requisite for Guardrails to\nprocess and respond to real-time events -- a core capability that allows\nGuardrails to respond to changes on resources as they occur.\n

URI
tmod:@turbot/aws#/control/types/eventHandlers

AWS > Turbot > Event Handlers [Global]

Configure the set of resources in a Guardrails Stack per the Event Handlers [Global] >\nSource policy.\n\nGuardrails Stacks are used to manage a set of resources via Terraform.\nStacks are responsible for the creation and deletion of multiple resources,\nbut once created, the resources are responsible for configuring themselves\nwith their Configured control, using the Source from the parent stack.\n\nThis stack is responsible for configuring the resources\nrequired for the Event Handlers [Global], which attaches the Guardrails Router to\na cloud provider's audit trail. This is a pre-requisite for Guardrails to\nprocess and respond to real-time events -- a core capability that allows\nGuardrails to respond to changes on resources as they occur.\n

URI
tmod:@turbot/aws#/control/types/eventHandlersGlobal

AWS > Turbot > Event Poller

The Guardrails AWS Poller control will query CloudTrail for relevant events on a schedule, and forward them to the router for processing.\n

URI
tmod:@turbot/aws#/control/types/accountEventPoller
Category

AWS > Turbot > Logging

Logging control root.

URI
tmod:@turbot/aws#/control/types/logging

AWS > Turbot > Logging > Bucket

Configure the Guardrails Logging Bucket stack.\n\nThis stack configures an AWS S3 Bucket for use as a destination\nfor logs from other AWS services.\n

URI
tmod:@turbot/aws#/control/types/loggingBucket

AWS > Turbot > Service Roles

Configure a custom stack on the AWS Account, per the Custom Stack > Source.\n\nA Guardrails Stack is a set of resources configured by Guardrails, as specified\nvia Terraform source. Stacks are responsible for the creation and deletion\nof multiple resources. Once created, stack resources are responsible for\nconfiguring themselves from the stack source via their Configured control.\n

URI
tmod:@turbot/aws#/control/types/serviceRolesStack