./HAVOC Deployment Variables

Details about deployment variables used when creating a ./HAVOC deployment

When creating a new ./HAVOC deployment, several variables are used to configure resources that are deployed in your AWS account. Below is a list of the defined variables.

The Terraform configuration file that is used to create the variables is available here: https://github.com/havocsh/havoc/blob/main/havoc_deploy/aws/terraform/variables.tf

Variables

aws_region

• Description: The AWS region where resources will be created.
• Default Value: us-east-1

aws_profile

• Description: The AWS profile to be used by Terraform.
• Default Value: default

deployment_name

• Description: The name used for naming AWS resources associated with your HAVOC deployment. It must be DNS compliant.
• Default Value: None (must be provided)

deployment_version

• Description: The deployment version for your HAVOC deployment.
• Default Value: None (must be provided)

enable_domain_name

• Description: If set to true, the HAVOC API endpoint will be deployed with a friendly DNS name as defined by the hosted_zone and domain_name variables.
• Type: Boolean

hosted_zone

• Description: The ID of the hosted zone from which your HAVOC API endpoint will derive its DNS name.
• Default Value: null

domain_name

• Description: The domain name that will be assigned to your HAVOC API (e.g., example.com).
• Default Value: null

enable_task_results_logging

• Description: If set to true, successful task requests/responses will be logged to CloudWatch Logs.
• Type: Boolean

enable_playbook_results_logging

• Description: If set to true, playbook operations will be logged to CloudWatch Logs.
• Type: Boolean

deployment_admin_email

• Description: The email address that will be referenced as the deployment admin.

results_queue_expiration

• Description: The number of days to keep task results in the queue.
• Default Value: 30