Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ugns/terraform-aws-tenableio

Tenable.io AWS integration
https://github.com/ugns/terraform-aws-tenableio

Last synced: 6 months ago
JSON representation

Tenable.io AWS integration

Awesome Lists containing this project

README 

          



# terraform-aws-tenableio [![Latest Release](https://img.shields.io/github/release/ugns/terraform-aws-tenableio.svg)](https://github.com/ugns/terraform-aws-tenableio/releases/latest)



[![UnderGrid Network Services][logo]](https://undergrid.net)



Short

description



---



This project is part of our comprehensive approach towards DevOps.

[][share_email]

[][share_googleplus]

[][share_facebook]

[][share_reddit]

[][share_linkedin]

[][share_twitter]



Designed following the [Cloud Posse, LLC][cloudposse] ["SweetOps"][sweetops] approach.



[![Terraform Open Source Modules](https://docs.cloudposse.com/images/terraform-open-source-modules.svg)][terraform_modules]



It's 100% Open Source and licensed under the [APACHE2](LICENSE).



We literally have [*hundreds of terraform modules*][terraform_modules] that are Open Source and well-maintained. Check them out!



## Introduction



This is an introduction.



## Security & Compliance [](https://bridgecrew.io/)



Security scanning provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.



| Benchmark | Description |

|--------|---------------|

| [![Infrastructure Security](https://www.bridgecrew.cloud/badges/github/ugns/terraform-aws-tenablio/general)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=ugns%2Fterraform-aws-tenablio&benchmark=INFRASTRUCTURE+SECURITY) | Infrastructure Security Compliance |

| [![CIS KUBERNETES](https://www.bridgecrew.cloud/badges/github/ugns/terraform-aws-tenablio/cis_kubernetes)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=ugns%2Fterraform-aws-tenablio&benchmark=CIS+KUBERNETES+V1.5) | Center for Internet Security, KUBERNETES Compliance |

| [![CIS AWS](https://www.bridgecrew.cloud/badges/github/ugns/terraform-aws-tenablio/cis_aws)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=ugns%2Fterraform-aws-tenablio&benchmark=CIS+AWS+V1.2) | Center for Internet Security, AWS Compliance |

| [![CIS AZURE](https://www.bridgecrew.cloud/badges/github/ugns/terraform-aws-tenablio/cis_azure)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=ugns%2Fterraform-aws-tenablio&benchmark=CIS+AZURE+V1.1) | Center for Internet Security, AZURE Compliance |

| [![PCI-DSS](https://www.bridgecrew.cloud/badges/github/ugns/terraform-aws-tenablio/pci)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=ugns%2Fterraform-aws-tenablio&benchmark=PCI-DSS+V3.2) | Payment Card Industry Data Security Standards Compliance |

| [![NIST-800-53](https://www.bridgecrew.cloud/badges/github/ugns/terraform-aws-tenablio/nist)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=ugns%2Fterraform-aws-tenablio&benchmark=NIST-800-53) | National Institute of Standards and Technology Compliance |

| [![ISO27001](https://www.bridgecrew.cloud/badges/github/ugns/terraform-aws-tenablio/iso)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=ugns%2Fterraform-aws-tenablio&benchmark=ISO27001) | Information Security Management System, ISO/IEC 27001 Compliance |

| [![SOC2](https://www.bridgecrew.cloud/badges/github/ugns/terraform-aws-tenablio/soc2)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=ugns%2Fterraform-aws-tenablio&benchmark=SOC2)| Service Organization Control 2 Compliance |

| [![CIS GCP](https://www.bridgecrew.cloud/badges/github/ugns/terraform-aws-tenablio/cis_gcp)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=ugns%2Fterraform-aws-tenablio&benchmark=CIS+GCP+V1.1) | Center for Internet Security, GCP Compliance |

| [![HIPAA](https://www.bridgecrew.cloud/badges/github/ugns/terraform-aws-tenablio/hipaa)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=ugns%2Fterraform-aws-tenablio&benchmark=HIPAA) | Health Insurance Portability and Accountability Compliance |



## Usage



**IMPORTANT:** We do not pin modules to versions in our examples because of the

difficulty of keeping the versions in the documentation in sync with the latest released versions.

We highly recommend that in your code you pin the version to the exact version you are

using so that your infrastructure remains stable, and update versions in a

systematic way so that they do not catch you by surprise.



Also, because of a bug in the Terraform registry ([hashicorp/terraform#21417](https://github.com/hashicorp/terraform/issues/21417)),

the registry shows many of our inputs as required when in fact they are optional.

The table below correctly indicates which inputs are required.



For a complete example, see [examples/complete](examples/complete).



For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest)

(which tests and deploys the example on AWS), see [test](test).



```hcl

# Create a standard label resource. See [null-label](https://github.com/cloudposse/terraform-null-label/#terraform-null-label--)

module "label" {

  source  = "cloudposse/label/null"

  # Cloud Posse recommends pinning every module to a specific version, though usually you want to use the current one

  # version = "x.x.x"



  namespace = "eg"

  name      = "example"

}



module "example" {

  source  = "cloudposse/*****/aws"

  # Cloud Posse recommends pinning every module to a specific version

  # version = "x.x.x"



  example = "Hello world!"



  context = module.label.this

}

```



## Quick Start



Here's how to get started...



## Examples



Here is an example of using this module:

- [`examples/complete`](https://github.com/ugns/terraform-aws-tenableio/) - complete example of using this module



## Makefile Targets

```text

Available targets:



  help                                Help screen

  help/all                            Display help for all targets

  help/short                          This help short screen

  lint                                Lint terraform code



```



## Requirements



| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | >= 1.0 |

|  [random](#requirement\_random) | >= 2.2 |



## Providers



| Name | Version |

|------|---------|

|  [random](#provider\_random) | >= 2.2 |



## Modules



| Name | Source | Version |

|------|--------|---------|

|  [this](#module\_this) | cloudposse/label/null | 0.25.0 |



## Resources



| Name | Type |

|------|------|

| [random_integer.example](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/integer) | resource |



## Inputs



| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [additional\_tag\_map](#input\_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 |

|  [attributes](#input\_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](#input\_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 |

|  [delimiter](#input\_delimiter) | Delimiter to be used between ID elements.
Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no |

|  [descriptor\_formats](#input\_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
`{
   format = string
   labels = list(string)
}`
(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](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |

|  [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no |

|  [example](#input\_example) | Example variable | `string` | `"hello world"` | no |

|  [id\_length\_limit](#input\_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](#input\_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](#input\_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](#input\_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](#input\_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 |

|  [name](#input\_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](#input\_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](#input\_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 |

|  [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |

|  [tags](#input\_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](#input\_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 |

|------|-------------|

|  [example](#output\_example) | Example output |

|  [id](#output\_id) | ID of the created example |

|  [random](#output\_random) | Stable random number for this example |



## Share the Love



Like this project? Please give it a ★ on [our GitHub](https://github.com/ugns/terraform-aws-tenablio)! (it helps us **a lot**)



## Related Projects



Check out these related projects.



- [terraform-null-label](https://github.com/cloudposse/terraform-null-label) - Terraform module designed to generate consistent names and tags for resources. Use terraform-null-label to implement a strict naming convention.



## References



For additional context, refer to some of these links.



## Help



**Got a question?** We got answers.



File a GitHub [issue](https://github.com/ugns/terraform-aws-tenablio/issues).



## Contributing



### Bug Reports & Feature Requests



Please use the [issue tracker](https://github.com/ugns/terraform-aws-tenablio/issues) to report any bugs or file feature requests.



### Developing



If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you!.



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



 1. **Fork** the repo on GitHub

 2. **Clone** the project to your own machine

 3. **Commit** changes to your own branch

 4. **Push** your work back up to your fork

 5. 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!



## Copyrights



Copyright © 2021-2022 [Cloud Posse, LLC](https://cloudposse.com)



## License



[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)



See [LICENSE](LICENSE) for full details.



```text

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.

```



## Trademarks



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



## About



This project is maintained and funded by [UnderGrid Network Services][website]. Like it? Please let us know!



[![UnderGrid Network Services][logo]][website]



We're a DevOps Professional Services consulting firm based in Kissimmee, FL.



Check out [our other projects][github].



### Contributors



|  [![Jeremy T. Bouse][jbouse_avatar]][jbouse_homepage]
[Jeremy T. Bouse][jbouse_homepage] |

|---|



  [jbouse_homepage]: https://github.com/jbouse

  [jbouse_avatar]: https://img.cloudposse.com/150x150/https://github.com/jbouse.png



[![Beacon][beacon]][website]



  [logo]: https://undergrid.net/undergrid-logo-300x88.png

  [docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=ugns/terraform-aws-tenablio&utm_content=docs

  [website]: https://undergrid.net?utm_source=github&utm_medium=readme&utm_campaign=ugns/terraform-aws-tenablio&utm_content=website

  [cloudposse]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=ugns/terraform-aws-tenablio&utm_content=cloudposse

  [sweetops]: https://cpco.io/sweetops?utm_source=github&utm_medium=readme&utm_campaign=ugns/terraform-aws-tenablio&utm_content=sweetops

  [github]: https://github.com/ugns?utm_source=github&utm_medium=readme&utm_campaign=ugns/terraform-aws-tenablio&utm_content=github

  [linkedin]: https://www.linkedin.com/company/undergrid-network-services/?utm_source=github&utm_medium=readme&utm_campaign=ugns/terraform-aws-tenablio&utm_content=linkedin

  [email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=ugns/terraform-aws-tenablio&utm_content=email

  [terraform_modules]: https://github.com/ugns?utm_source=github&utm_medium=readme&utm_campaign=ugns/terraform-aws-tenablio&utm_content=terraform_modules

  [share_twitter]: https://twitter.com/intent/tweet/?text=terraform-aws-tenableio&url=https://github.com/ugns/terraform-aws-tenablio

  [share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=terraform-aws-tenableio&url=https://github.com/ugns/terraform-aws-tenablio

  [share_reddit]: https://reddit.com/submit/?url=https://github.com/ugns/terraform-aws-tenablio

  [share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/ugns/terraform-aws-tenablio

  [share_googleplus]: https://plus.google.com/share?url=https://github.com/ugns/terraform-aws-tenablio

  [share_email]: mailto:?subject=terraform-aws-tenableio&body=https://github.com/ugns/terraform-aws-tenablio

  [beacon]: https://ga-beacon.cloudposse.com/UA-2819624-1/ugns/terraform-aws-tenablio?pixel&cs=github&cm=readme&an=terraform-aws-tenablio