Skip to content

Commit

Permalink
test(examples): added new example
Browse files Browse the repository at this point in the history
added new example 
closes #11
  • Loading branch information
shamimice03 authored Aug 30, 2023
2 parents f8092eb + e6b977a commit c9b82e2
Show file tree
Hide file tree
Showing 6 changed files with 88 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ module "parameters" {
}
},
]
}
```
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Requirements
Expand Down
37 changes: 37 additions & 0 deletions examples/create-parameters/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.0.0 |

## Providers

No providers.

## Modules

| Name | Source | Version |
|------|--------|---------|
| <a name="module_demo_parameters"></a> [demo\_parameters](#module\_demo\_parameters) | ../../ | n/a |

## Resources

No resources.

## Inputs

No inputs.

## Outputs

| Name | Description |
|------|-------------|
| <a name="output_parameters"></a> [parameters](#output\_parameters) | A list of parameters extracted from the aws\_ssm\_parameter resources. These values are treated as sensitive. |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

## View Output
```hcl
terraform output signalrserviceconnstring
```
35 changes: 35 additions & 0 deletions examples/create-parameters/main.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
module "demo_parameters" {

source = "../../"

parameters = [
{
name = "/webapp/db/username"
type = "String"
description = "Parameter for webapp"
value = "admin"
tags = {
"Name" = "webapp-params"
}
},
{
name = "/webapp/db/role"
type = "StringList"
description = "Parameter for webapp"
value = "create,delete"
tags = {
"Name" = "webapp-params"
}
},
{
name = "/webapp/db/password"
type = "SecureString"
description = "Parameter for webapp"
value = "Password"
key_alias = "alias/aws/ssm"
tags = {
"Name" = "webapp-params"
}
},
]
}
5 changes: 5 additions & 0 deletions examples/create-parameters/outputs.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
output "parameters" {
description = "A list of parameters extracted from the aws_ssm_parameter resources. These values are treated as sensitive."
sensitive = true
value = module.demo_parameters.parameters
}
Empty file.
10 changes: 10 additions & 0 deletions examples/create-parameters/versions.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
terraform {
required_version = ">= 1.5.0"

required_providers {
aws = {
source = "hashicorp/aws"
version = ">= 5.0.0"
}
}
}

0 comments on commit c9b82e2

Please sign in to comment.