Module: inspector
This module enables AWS Inspector in one region of one account and optionally enables various rules packages provided by AWS.
Usage
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 AWS), see test.
module "inspector" {
source = "cloudposse/inspector/aws"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
create_iam_role = true
enabled_rules = ["cis"]
}
Examples
Here is an example of using this module:
examples/complete
- complete example of using this module
Requirements
Name | Version |
---|---|
terraform | >= 0.13.0 |
aws | >= 4.27 |
Providers
Name | Version |
---|---|
aws | >= 4.27 |
Modules
Name | Source | Version |
---|---|---|
iam_role | cloudposse/iam-role/aws | 0.16.2 |
inspector_assessment_target_label | cloudposse/label/null | 0.25.0 |
inspector_assessment_template_label | cloudposse/label/null | 0.25.0 |
inspector_schedule_label | cloudposse/label/null | 0.25.0 |
this | cloudposse/label/null | 0.25.0 |
Resources
Name | Type |
---|---|
aws_cloudwatch_event_rule.schedule | resource |
aws_cloudwatch_event_target.target | resource |
aws_inspector_assessment_target.target | resource |
aws_inspector_assessment_template.assessment | resource |
aws_iam_policy_document.start_assessment_policy | data source |
aws_region.current | data source |
Inputs
Name | Description | Type | Default | Required |
---|---|---|---|---|
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 |
assessment_duration | The max duration of the Inspector assessment run in seconds | string | "3600" | no |
assessment_event_subscription | Configures sending notifications about a specified assessment template event to a designated SNS topic |
| {} | 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 |
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 |
| no |
create_iam_role | Flag to indicate whether an IAM Role should be created to grant the proper permissions for AWS Config | bool | false | 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 beidentical 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 |
enabled_rules | A list of AWS Inspector rules that should run on a periodic basis. Valid values are cve , cis , nr , sbp which map to the appropriate Inspector rule arns by region. | list(string) | n/a | yes |
environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string | null | no |
event_rule_description | A description of the CloudWatch event rule | string | "Trigger an AWS Inspector Assessment" | no |
iam_role_arn | The ARN for an IAM Role AWS Config uses to make read or write requests to the delivery channel and to describe the AWS resources associated with the account. This is only used if create_iam_role is false. If you want to use an existing IAM Role, set the value of this to the ARN of the existing topic and set create_iam_role to false. | string | null | 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 bechanged in later chained modules. Attempts to change it will be silently ignored. | set(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 |
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 |
schedule_expression | An AWS Schedule Expression to indicate how often the scheduled event shoud run. For more information see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html | string | "rate(7 days)" | 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_cloudwatch_event_rule | The AWS Inspector event rule |
aws_cloudwatch_event_target | The AWS Inspector event target |
aws_inspector_assessment_template | The AWS Inspector assessment template |
inspector_assessment_target | The AWS Inspector assessment target |