apfm-actions/terraform-project-base-action

Begin a terraform project component

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Maintainedlast commit May 7, 2025
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: apfm-actions/terraform-project-base-action@70f94432801c046d8e55d256edda89a652d33bda # v1.0.1

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
projectProject name this resource is part ofyes
ownerProject owner/teamyes
emailProject owner/team email addressyes
devGit branch pattern to deploy to dev environmentdevelop
stageGit branch pattern to deploy to stage environmentmaster
prodGit branch pattern to deploy to prod environmenttag
workspaceTerraform Workspace to operate from. In terraform this is accessible as terraform.workspace. By default the git branch pattern will decide which workspace to use.no
tf_assume_roleSpecify role that later actions should assume. Only actions designed to work with terraform-project-base will assume this role.
remote_state_bucketS3 bucket containing this projects remote state data (read-write)yes
remote_lock_tableDynamoDB Table for managing Terraform Locksyes
shared_state_keyS3 key containing Terraform Shared State data to read from (read-only)yes
planSkip the Terraform Plan portion of the buildtrue
debugEnable action debuggingfalse
namedescription
account_root_idAWS apfm-root account ID
account_idCurrent AWS account ID
cluster_azsECS Cluster availability zone
cluster_cluster_nameECS Cluster name
cluster_ecr_repoDefault ECR repo to use when launching containers in this cluster
cluster_elk_endpointELK endpoint which collects logs for this cluster [deprecated]
cluster_execution_roleDefault exec role name used when provisioning containers in this cluster
cluster_execution_role_arnDefault exec role ARN used when provisioning containers in this cluster
cluster_idECS Cluster id (same as name)
cluster_private_subnetsDefault private subnets to use when launching containers in this cluster
cluster_public_subnetsDefault public subnets to use when launching containers in this cluster
cluster_regionRegion this cluster is deployed in [deprecated]
cluster_security_groupsDefault security groups to use when launching containers in this cluster
cluster_service_namespace_idAWS Service Discovery namespace ID for containers in this cluster
cluster_vpc_idDefault VPC to use when launching containers in this cluster
dns_zone_id_privateDefault private DNS zone id to use when launching containers in this cluster
dns_zone_id_publicDefault public DNS zone id to use when launching containers in this cluster
dns_zone_id_serviceDefault service discovery DNS zone id to use when launching containers in this cluster
external_idAWS external id to use when assuming roles into this account
network_azsNetwork availability zones [deprecated: same as cluster_azs]
network_cidr_blockNetwork CIDR block [deprecated]
network_dns_delegation_idDNS delegation set id [deprecated]
network_igw_idNetwork internet gateway id [deprecated]
network_power_user_role_arnPower user role ARN [deprecated]
network_private_route_tblPrivate route table [deprecated]
network_private_subnetsPrivate subnets [deprecated]
network_public_route_tblPublic route table [deprecated]
network_public_subnetsPublic subnets [deprecated]
network_regionNetwork region [deprecated]
network_vpc_idNetwork VPC ID [deprectated]
project_nameProject Name
project_ownerProject Owner
project_emailProject Email Address
route_table_id_privatePrivate route table id [deprecated]
route_table_id_publicPublic route table id [deprecated]
setting_adminAdministrator name
setting_admin_emailAdministrator email
setting_admin_keyAdministrator public key
setting_admin_key_nameAdministrator public key name
setting_domain_nameTop Level Domain Name for account
setting_elkendpointELK Endpoint [deprecated]
setting_enable_couchdbCouchDB Enabled [deprecated]
setting_enable_finance-cstFinance CST enabled [deprecated]
setting_enable_sa_eksSA EKS enabled [deprecated]
setting_enable_vpc_flow_logsVPC Vlowlogs enabled [deprecated]
setting_enable_vpn_gatewayVPN Gateway enabled [deprecated]
setting_enable_wptestWebPageSpeedTest enabled [deprecated]
setting_s3_remotestate_bucket_idTerraform S3 remotestate bucket id]
setting_sa_eks_enableSA EKS enabled [deprecated]
setting_subnet_prefixSubnet prefix [deprecated]
sns_alertsSNS alerts topic name [deprecated]
sns_notificationsSNS notifications topic name [deprecated]
subnet_id_privatePrivate subnet ID [deprecated]
subnet_id_publicPublic subnet id [deprecated]
user_idCurrent AWS user ID
user_arnCurrent AWS user arn