Skip to main content
Sponsor @cloudposse

aws-inspector2

This component is responsible for configuring Inspector V2 within an AWS Organization.

Usage​

Stack Level: Regional

Deployment Overview​

The deployment of this component requires multiple runs with different variable settings to properly configure the AWS Organization. First, you delegate Inspector V2 central management to the Administrator account (usually security account). After the Administrator account is delegated, we configure the it to manage Inspector V2 across all the Organization accounts and send all their findings to that account.

In the examples below, we assume that the AWS Organization Management account is root and the AWS Organization Delegated Administrator account is security.

Deploy to Organization Management Account​

First, the component is deployed to the AWS Organization Management account root in each region in order to configure the AWS Delegated Administrator account that operates Amazon Inspector V2.

# ue1-root
components:
  terraform:
    aws-inspector2/delegate-orgadmin/ue1:
      metadata:
        component: aws-inspector2
      vars:
        enabled: true
        region: us-east-1

Deploy Organization Settings in Delegated Administrator Account​

Now the component can be deployed to the Delegated Administrator Account security to create the organization-wide configuration for all the Organization accounts. Note that var.admin_delegated set to true indicates that the delegation has already been performed from the Organization Management account, and only the resources required for organization-wide configuration will be created.

# ue1-security
components:
  terraform:
    aws-inspector2/orgadmin-configuration/ue1:
      metadata:
        component: aws-inspector2
      vars:
        enabled: true
        region: us-east-1
        admin_delegated: true

Variables​

Required Variables​

region (string) required

AWS Region

Optional Variables​

account_map_tenant (string) optional

The tenant where the account_map component required by remote-state is deployed


Default value: "core"

admin_delegated (bool) optional

A flag to indicate if the AWS Organization-wide settings should be created. This can only be done after the GuardDuty
Administrator account has already been delegated from the AWS Org Management account (usually 'root'). See the
Deployment section of the README for more information.



Default value: false

auto_enable_ec2 (bool) optional

Whether Amazon EC2 scans are automatically enabled for new members of the Amazon Inspector organization.


Default value: true

auto_enable_ecr (bool) optional

Whether Amazon ECR scans are automatically enabled for new members of the Amazon Inspector organization.


Default value: true

auto_enable_lambda (bool) optional

Whether Lambda Function scans are automatically enabled for new members of the Amazon Inspector organization.


Default value: true

delegated_administrator_account_name (string) optional

The name of the account that is the AWS Organization Delegated Administrator account


Default value: "security"

global_environment (string) optional

Global environment name


Default value: "gbl"

member_association_excludes (list(string)) optional

List of account names to exlude from Amazon Inspector member association


Default value: [ ]

organization_management_account_name (string) optional

The name of the AWS Organization management account


Default value: null

privileged (bool) optional

true if the default provider already has access to the backend


Default value: false

root_account_stage (string) optional

The stage name for the Organization root (management) account. This is used to lookup account IDs from account names
using the account-map component.



Default value: "root"

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​

aws_inspector2_member_association

The Inspector2 member association resource.

Dependencies​

Requirements​

  • terraform, version: >= 1.0.0
  • aws, version: >= 5.0
  • awsutils, version: >= 0.16.0

Providers​

  • aws, version: >= 5.0

Modules​

NameVersionSourceDescription
account_map1.4.3cloudposse/stack-config/yaml//modules/remote-staten/a
iam_roleslatest../account-map/modules/iam-rolesn/a
this0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module:

References​