Guardrails for GitHub →
Policy Packs
Deploy AWS IAM Stack

Deploy AWS IAM Stack

Deploy and manage AWS IAM resources using OpenTofu with AWS > IAM > Stack [Native] control.

This policy pack helps you deploy, configure, and manage standard account-level IAM resources using the AWS > IAM > Stack [Native] control. You can customize the Source, but the example will create a simple IAM role.

Documentation

Getting Started

Requirements

Credentials

To create a policy pack through Terraform:

  • Ensure you have Turbot/Admin permissions (or higher) in Guardrails
  • Create access keys in Guardrails

And then set your credentials:

export TURBOT_WORKSPACE=myworkspace.acme.com
export TURBOT_ACCESS_KEY=acce6ac5-access-key-here
export TURBOT_SECRET_KEY=a8af61ec-secret-key-here

Please see Turbot Guardrails Provider authentication for additional authentication methods.

Usage

Install Policy Pack

Note

By default, installed policy packs are not attached to any resources.

Policy packs must be attached to resources in order for their policy settings to take effect.

Clone:

git clone https://github.com/turbot/guardrails-samples.git
cd guardrails-samples/policy_packs/aws/stack/deploy_aws_iam_stack

The example Source will create a read-only IAM role. You must set the trusted_principals variable (in the stack/variables.auto.tfvars file) to a valid ARN if you want to run the example as-is:

trusted_principals = ["arn:aws:iam::123456789012:root"]

Alternatively, modify the Source policy (in the stack/source.tofu file) and/or Variables policy (in the stack/variables.auto.tfvars file) to match you standards.

There are additional stack-related example policies that are commented out in the policies.tf that you may choose to edit as well:

  • AWS > IAM > Stack [Native] > Secret Variables
  • AWS > IAM > Stack [Native] > Modifier
  • AWS > IAM > Stack [Native] > Timeout
  • AWS > IAM > Stack [Native] > Version
  • AWS > IAM > Stack [Native] > Drift Detection
  • AWS > IAM > Stack [Native] > Drift Detection > Interval

Run the Terraform to create the policy pack in your workspace:

terraform init
terraform plan

Then apply the changes:

terraform apply

Apply Policy Pack

Important

Attaching this policy pack in Guardrails will result in creation of resources in the target account. However, it is easy to remove those resources later, by setting the contents of the Stack's Source policy to {} (empty).

Log into your Guardrails workspace and attach the policy pack to a resource.

If this policy pack is attached to a Guardrails folder, its policies will be applied to all accounts in that folder. The policy pack can also be attached to multiple resources.

For more information, please see Policy Packs.

Enable Enforcement

Tip

You can also update the policy settings in this policy pack directly in the Guardrails console.

Please note your Terraform state file will then become out of sync and the policy settings should then only be managed in the console.

By default, the policies are set to Check in the pack's policy settings. To enable automated enforcements, you can switch these policies settings by adding a comment to the Check setting and removing the comment from one of the listed enforcement options:

# AWS > IAM > Stack [Native]
resource "turbot_policy_setting" "aws_iam_stack" {
resource = turbot_policy_pack.main.id
type = "tmod:@turbot/aws#/policy/types/iamStackNative"
#value = "Check: Configured"
value = "Enforce: Configured"
}

Then re-apply the changes:

terraform plan
terraform apply