Skip to content

Commit f0a3165

Browse files
committed
add inputs in README
1 parent c382376 commit f0a3165

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,44 @@ module "bastion" {
5454
}
5555
}
5656
```
57+
## Inputs
58+
59+
| Name | Description | Type | Default | Required |
60+
|------|-------------|:----:|:-----:|:-----:|
61+
| auto_scaling_group_subnets | List of subnet were the Auto Scalling Group will deploy the instances | list | - | yes |
62+
| bastion_amis | | map | `<map>` | no |
63+
| bastion_host_key_pair | Select the key pair to use to launch the bastion host | string | - | yes |
64+
| bastion_instance_count | | string | `1` | no |
65+
| bastion_record_name | DNS record name to use for the bastion | string | `` | no |
66+
| bucket_name | Bucket name were the bastion will store the logs | string | - | yes |
67+
| cidrs | List of CIDRs than can access to the bastion. Default : 0.0.0.0/0 | list | `<list>` | no |
68+
| create_dns_record | Choose if you want to create a record name for the bastion (LB). If true 'hosted_zone_name' and 'bastion_record_name' are mandatory | string | - | yes |
69+
| elb_subnets | List of subnet were the ELB will be deployed | list | - | yes |
70+
| hosted_zone_name | Name of the hosted zone were we'll register the bastion DNS name | string | `` | no |
71+
| is_lb_private | If TRUE the load balancer scheme will be "internal" else "internet-facing" | string | - | yes |
72+
| log_auto_clean | Enable or not the lifecycle | string | `false` | no |
73+
| log_expiry_days | Number of days before logs expiration | string | `90` | no |
74+
| log_glacier_days | Number of days before moving logs to Glacier | string | `60` | no |
75+
| log_standard_ia_days | Number of days before moving logs to IA Storage | string | `30` | no |
76+
| region | | string | - | yes |
77+
| tags | A mapping of tags to assign | map | `<map>` | no |
78+
| vpc_id | VPC id were we'll deploy the bastion | string | - | yes |
79+
80+
## Outputs
81+
82+
| Name | Description |
83+
|------|-------------|
84+
| bucket_name | |
85+
| elb_ip | |
86+
5787

5888
Known issues
5989
------------
6090

91+
Tags are not applied to the instances generated by the auto scaling group.
92+
Known terraform issue : terraform-providers/terraform-provider-aws#290
93+
94+
6195
Authors
6296
-------
6397

0 commit comments

Comments
 (0)