| hcp_terraform_org_name |
The name of the HCP Terraform or HCP Terraform Enterprise organization where the agent pool will be configured. The combination of hcp_terraform_org_name and name must be unique within an AWS account. |
string |
n/a |
yes |
| name |
A name to apply to resources. The combination of name and hcp_terraform_org_name must be unique within an AWS account. |
string |
n/a |
yes |
| subnet_ids |
IDs of the subnet(s) where agents can be deployed |
list(string) |
n/a |
yes |
| vpc_id |
ID of the VPC where the cluster is running. |
string |
n/a |
yes |
| agent_auto_update |
Whether the agent should auto-update. Valid values are minor, patch, and disabled. |
string |
"minor" |
no |
| agent_cidr_blocks |
CIDR blocks to allow the agent to communicate with the HCP Terraform instance. |
list(string) |
[
"0.0.0.0/0"
] |
no |
| agent_cpu |
The CPU units allocated to the agent container(s). See https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html#fargate-tasks-size |
number |
256 |
no |
| agent_egress_ports |
Egress ports to allow the agent to communicate with the HCP Terraform instance. |
set(string) |
[
"443",
"7146"
] |
no |
| agent_image |
The Docker image to launch. |
string |
"hashicorp/tfc-agent:latest" |
no |
| agent_log_level |
The logging verbosity for the agent. Valid values are trace, debug, info (default), warn, and error. |
string |
"info" |
no |
| agent_memory |
The amount of memory, in MB, allocated to the agent container(s). |
number |
512 |
no |
| agent_single_execution |
Whether to use single-execution mode. |
bool |
true |
no |
| cloudwatch_log_group_name |
The name of the CloudWatch log group where agent logs will be sent. |
string |
"/hcp/hcp-terraform-agent" |
no |
| cloudwatch_log_group_retention |
The number of days to retain logs in the CloudWatch log group. |
number |
365 |
no |
| create_cloudwatch_log_group |
Whether the CloudWatch log group should be created. |
bool |
true |
no |
| create_ecs_cluster |
Whether to create a new ECS cluster for the agent. |
bool |
true |
no |
| create_tfe_agent_pool |
Whether to omit agent pool/token creation |
bool |
true |
no |
| ecs_cluster_arn |
ARN of the ECS cluster where the agent will be deployed. |
string |
"arn:aws:ecs:us-west-2:000000000000:cluster/ecs-basic" |
no |
| extra_env_vars |
Extra environment variables to pass to the agent container. |
list(object({
name = string
value = string
})) |
[] |
no |
| hcp_terraform_address |
The HTTPS address of the HCP Terraform or HCP Terraform Enterprise instance. |
string |
"https://app.terraform.io" |
no |
| kms_key_arn |
The ARN of the KMS key to create. If empty, a new key will be created. |
string |
"" |
no |
| num_agents |
The number of agent containers to run. |
number |
1 |
no |
| tags |
Map of tags to apply to resources deployed by this solution. |
map(any) |
null |
no |
| task_policy_arns |
ARN(s) of IAM policies to attach to the agent task. Determines what actions the agent can take without requiring additional AWS credentials. |
list(string) |
[] |
no |
| tfe_agent_pool_name |
Terraform agent pool name to be used when agent creation is omitted |
string |
"" |
no |
| tfe_agent_token |
Terraform agent token to be used when agent creation is omitted |
string |
"" |
no |
| use_spot_instances |
Whether to use Fargate Spot instances. |
bool |
false |
no |
