Component: 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 Adminstrator 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

Requirements

Name	Version
terraform	>= 1.0.0
aws	>= 5.0
awsutils	>= 0.16.0

Providers

Name	Version
aws	>= 5.0

Modules

Name	Source	Version
account_map	cloudposse/stack-config/yaml//modules/remote-state	1.4.3
iam_roles	../account-map/modules/iam-roles	n/a
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_inspector2_delegated_admin_account.default	resource
aws_inspector2_enabler.delegated_admin	resource
aws_inspector2_enabler.member_accounts	resource
aws_inspector2_member_association.default	resource
aws_inspector2_organization_configuration.default	resource
aws_caller_identity.this	data source

Inputs

Name	Description	Type	Default	Required
account_map_tenant	The tenant where the account_map component required by remote-state is deployed	string	"core"	no
additional_tag_map	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.	map(string)	{}	no
admin_delegated	A flag to indicate if the AWS Organization-wide settings should be created. This can only be done after the GuardDuty Admininstrator account has already been delegated from the AWS Org Management account (usually 'root'). See the Deployment section of the README for more information.	bool	false	no
attributes	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.	list(string)	[]	no
auto_enable_ec2	Whether Amazon EC2 scans are automatically enabled for new members of the Amazon Inspector organization.	bool	true	no
auto_enable_ecr	Whether Amazon ECR scans are automatically enabled for new members of the Amazon Inspector organization.	bool	true	no
auto_enable_lambda	Whether Lambda Function scans are automatically enabled for new members of the Amazon Inspector organization.	bool	true	no
context	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.	any	{ "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 }	no
delegated_administrator_account_name	The name of the account that is the AWS Organization Delegated Administrator account	string	"security"	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
descriptor_formats	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).	any	{}	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
global_environment	Global environment name	string	"gbl"	no
id_length_limit	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.	number	null	no
label_key_case	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.	string	null	no
label_order	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.	list(string)	null	no
label_value_case	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.	string	null	no
labels_as_tags	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.	set(string)	[ "default" ]	no
member_association_excludes	List of account names to exlude from Amazon Inspector member association	list(string)	[]	no
name	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.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
organization_management_account_name	The name of the AWS Organization management account	string	null	no
privileged	true if the default provider already has access to the backend	bool	false	no
regex_replace_chars	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.	string	null	no
region	AWS Region	string	n/a	yes
root_account_stage	The stage name for the Organization root (management) account. This is used to lookup account IDs from account names using the account-map component.	string	"root"	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no

Outputs

Name	Description
aws_inspector2_member_association	The Inspector2 member association resource.

References

• Amazon Inspector V2 Documentation
• Cloud Posse's upstream component