Terraform module to provision Service Control Policies (SCP) for AWS Organizations, Organizational Units, and AWS accounts.

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform

Example of running atmos to manage infrastructure from our Quick Start tutorial.

Service Control Policies are configured in YAML configuration files.

We maintain a comprehensive catalog of SCP configurations and welcome contributions via pull request!

The example in this module uses the catalog to provision the SCPs on AWS.

The policies in the catalog/*-templates files require parameters supplied via the parameters input to terraform-yaml-config.

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on Datadog), see test.

  module "yaml_config" {
    source = "cloudposse/config/yaml"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"

    list_config_local_base_path = path.module
    list_config_paths           = ["catalog/*.yaml"]

    context = module.this.context
  }

  module "yaml_config_with_parameters" {
    source = "cloudposse/config/yaml"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"

    list_config_local_base_path = path.module
    list_config_paths           = ["https://raw.githubusercontent.com/cloudposse/terraform-aws-service-control-policies/0.12.0/catalog/s3-templates/DenyS3InNonSelectedRegion.yaml"]

    parameters = {
      "s3_regions_lockdown" = "us-*,eu-north-1"
      }

    context = module.this.context
  }

  data "aws_caller_identity" "this" {}

  module "service_control_policies" {
    source = "../../"

    service_control_policy_statements  = concat(module.yaml_config.list_configs, module.yaml_config_with_parameters.list_configs)
    service_control_policy_description = var.service_control_policy_description
    target_id                          = data.aws_caller_identity.this.account_id

    context = module.this.context
  }

Review the complete example to see how to use this module.

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

[
  "default"
]

Check out these related projects.

• terraform-aws-iam-role - A Terraform module that creates IAM role with provided JSON IAM polices documents.
• terraform-aws-iam-policy-document-aggregator - Terraform module to aggregate multiple IAM policy documents into single policy document
• terraform-aws-iam-chamber-s3-role - Terraform module to provision an IAM role with configurable permissions to access S3 as chamber backend.
• terraform-yaml-config - Terraform module to convert local and remote YAML configuration templates into Terraform lists and maps.

For additional context, refer to some of these links.

• Service control policies - Service control policies (SCPs) are a type of organization policy that you can use to manage permissions in your organization.
• Example service control policies - Examples of Service Control Policies (SCPs).
• SCP syntax - Service control policies (SCPs) use a similar syntax to that used by AWS Identity and Access Management (IAM) permission policies and resource-based policies.
• Terraform Standard Module Structure - HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories.
• Terraform Module Requirements - HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy.
• Terraform random_integer Resource - The resource random_integer generates random values from a given range, described by the min and max attributes of a given resource.
• Terraform Version Pinning - The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration
• SCPs size limits - The SCP have a size limit and creating many policies at once can result in a POLICY_CONTENT_LIMIT_EXCEEDED error

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. Review our Code of Conduct and Contributor Guidelines.
2. Fork the repo on GitHub
3. Clone the project to your own machine
4. Commit changes to your own branch
5. Push your work back up to your fork
6. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

All other trademarks referenced herein are the property of their respective owners.

Copyright © 2020-2024 Cloud Posse, LLC