Version: Latest

scp

This component is responsible for creating a single Service Control Policy (SCP) and optionally attaching it to a target (organization root, OU, or account).

Unlike the monolithic account component which manages SCPs as part of the organization hierarchy, this component follows the single-resource pattern - it only manages a single SCP.

note

This component should be deployed from the management/root account as it creates SCPs within AWS Organizations.

Usage

Stack Level: Global (deployed in the management/root account)

Using policy_statements (recommended)

components:
  terraform:
    aws-scp/deny-leaving-organization:
      metadata:
        component: aws-scp
      vars:
        enabled: true
        policy_name: DenyLeavingOrganization
        policy_description: "Prevents accounts from leaving the organization"
        policy_statements:
          - sid: "DenyLeaveOrganization"
            effect: "Deny"
            actions:
              - "organizations:LeaveOrganization"
            resources:
              - "*"
        target_id: !terraform.output aws-organizational-unit/core organizational_unit_id

Using policy_content (raw JSON)

components:
  terraform:
    aws-scp/custom-policy:
      metadata:
        component: aws-scp
      vars:
        enabled: true
        policy_name: CustomPolicy
        policy_content: |
          {
            "Version": "2012-10-17",
            "Statement": [
              {
                "Effect": "Deny",
                "Action": ["ec2:RunInstances"],
                "Resource": "*"
              }
            ]
          }
        target_id: !terraform.output aws-organizational-unit/plat organizational_unit_id

Policy Without Attachment

Create a policy without attaching it to any target:

components:
  terraform:
    aws-scp/deny-root-user:
      metadata:
        component: aws-scp
      vars:
        enabled: true
        policy_name: DenyRootUser
        attach_to_target: false
        policy_statements:
          - sid: "DenyRootUser"
            effect: "Deny"
            actions:
              - "*"
            resources:
              - "*"
            conditions:
              - test: "StringLike"
                variable: "aws:PrincipalArn"
                values:
                  - "arn:aws:iam::*:root"

Importing an Existing SCP

To import an existing SCP:

Get the policy ID from AWS Console or CLI
Set the import_policy_id variable:
```
vars:
  import_policy_id: "p-xxxxxxxxxx"
```
Run atmos terraform apply

After successful import, you can remove the import_policy_id variable.

Note: If you don't need import functionality, you can exclude imports.tf when vendoring the component.

Policy Statements Format

policy_statements:
  - sid: "OptionalStatementId"
    effect: "Deny"  # or "Allow"
    actions:
      - "service:Action"
    resources:
      - "*"
    conditions:  # optional
      - test: "StringEquals"
        variable: "aws:RequestedRegion"
        values:
          - "us-east-1"

This component is part of a suite of single-resource components for AWS Organizations:

Component	Purpose
`aws-organization`	Creates/imports the AWS Organization
`aws-organizational-unit`	Creates/imports a single OU
`aws-account`	Creates/imports a single AWS Account
`aws-account-settings`	Configures account settings
`aws-scp`	Creates/imports Service Control Policies (this component)

Variables

Required Variables

region (string) required: AWS Region

Optional Variables

attach_to_target (bool) optional

Whether to attach the SCP to a target. Set to false to create the policy without attaching it.

Default value: true

import_policy_id (string) optional

The ID of an existing SCP to import

Default value: null

policy_content (string) optional

The JSON policy document for the SCP. If not provided, policy_statements will be used to generate the policy.

Default value: null

policy_description (string) optional

Description of the SCP

Default value: "Service Control Policy managed by Terraform"

policy_name (string) optional

The name of the Service Control Policy. Defaults to module.this.id

Default value: null

policy_statements optional

List of policy statements to generate the SCP. Alternative to policy_content.

Type:

list(object({
sid       = optional(string)
effect    = string
actions   = list(string)
resources = list(string)
conditions = optional(list(object({
  test     = string
  variable = string
  values   = list(string)
})), [])
}))

Default value: [ ]

skip_destroy (bool) optional

If true, the policy will be detached from the target but not destroyed when removed from Terraform

Default value: false

target_id (string) optional

The ID of the organization root, OU, or account to attach the SCP to

Default value: null

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.

Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.

Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.

Required: No

Default value:

{
  "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
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.

Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.

Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.

Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.

Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.

Required: No

Default value:

[
  "default"
]

name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

attached: Whether the SCP was attached to a target
attachment_id: The ID of the policy attachment
policy_arn: The ARN of the Service Control Policy
policy_id: The ID of the Service Control Policy
policy_name: The name of the Service Control Policy
target_id: The target ID the SCP is attached to

Dependencies

Requirements

terraform, version: >= 1.7.0
aws, version: >= 5.66

Providers

aws, version: >= 5.66

Modules

Name	Version	Source	Description
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

aws_organizations_policy.this (resource)
aws_organizations_policy_attachment.this (resource)

Data Sources

The following data sources are used by this module:

Usage​

Using policy_statements (recommended)​

Using policy_content (raw JSON)​

Policy Without Attachment​

Importing an Existing SCP​

Policy Statements Format​

Related Components​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Usage

Using policy_statements (recommended)

Using policy_content (raw JSON)

Policy Without Attachment

Importing an Existing SCP

Policy Statements Format

Related Components

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources