Skip to content

Commit

Permalink
terraform-docs: automated action
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Mar 25, 2024
1 parent d600a18 commit 4bf2496
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ No modules.
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_automation_initiator_location"></a> [automation\_initiator\_location](#input\_automation\_initiator\_location) | Specify the URL to the repo of automation script.<br> Valid Values: URL to repo. Example: `"https://github.com/dfds/terraform-aws-rds"`<br> Notes: This set the dfds.automation.initiator.location tag. See recommendations [here](https://wiki.dfds.cloud/en/playbooks/standards/tagging_policy). | `string` | `null` | no |
| <a name="input_aws_ami_name"></a> [aws\_ami\_name](#input\_aws\_ami\_name) | Optional. Specify the name of the AMI image to use for the EC2 instance<br> Valid Values: Any suitable EC2 instance filter string<br> Notes: The value will be used to filter the AMI image to use for the EC2 instance. By default it will use an appropriate value. | `string` | `"al2023-ami-2023.*-x86_64"` | no |
| <a name="input_aws_iam_instance_profile"></a> [aws\_iam\_instance\_profile](#input\_aws\_iam\_instance\_profile) | Optional. Specify the name of the IAM instance profile to use for the EC2 instance<br> Valid Values: Any valid IAM Instance Profile name<br> Notes: The value will be used to set the IAM instance profile for the EC2 instance. By default it will use an appropriate value. | `string` | `"ssm-tunnel"` | no |
| <a name="input_aws_security_group_name"></a> [aws\_security\_group\_name](#input\_aws\_security\_group\_name) | Optional. Specify the name of the security group to use for the EC2 instance<br> Valid Values: Any valid AWS Security Group name<br> Notes: The value will be used to attach the correct security group to the EC2 instance. By default it will use an appropriate value. | `string` | `"ssm-tunnel"` | no |
| <a name="input_aws_subnet_name"></a> [aws\_subnet\_name](#input\_aws\_subnet\_name) | Optional. Specify the name of the subnet to use for the EC2 instance<br> Valid Values: Any valid VPC Subnet name<br> Notes: The value will be used to place the EC2 instance in the correct subnet. By default it will use an appropriate value. | `string` | `"peering-a"` | no |
| <a name="input_aws_vpc_name"></a> [aws\_vpc\_name](#input\_aws\_vpc\_name) | Optional. Specify the name of the VPC to use for the EC2 instance<br> Valid Values: Any valid VPC name<br> Notes: The value will be used to place the EC2 instance in the correct VPC. By default it will use an appropriate value. | `string` | `"peering"` | no |
| <a name="input_aws_ami_name"></a> [aws\_ami\_name](#input\_aws\_ami\_name) | Optional. Specify the name of the AMI image to use for the EC2 instance<br> Valid Values: Any suitable EC2 instance filter string<br> Notes:<br> - The value will be used to filter the AMI image to use for the EC2 instance.<br> - If not specified, it will use the default value as a filter. | `string` | `"al2023-ami-2023.*-x86_64"` | no |
| <a name="input_aws_iam_instance_profile"></a> [aws\_iam\_instance\_profile](#input\_aws\_iam\_instance\_profile) | Optional. Specify the name of the IAM instance profile to use for the EC2 instance<br> Valid Values: Any valid IAM Instance Profile name<br> Notes:<br> - The value will be used to set the IAM instance profile for the EC2 instance.<br> - If not specified, it will use the default value. | `string` | `"ssm-tunnel"` | no |
| <a name="input_aws_security_group_name"></a> [aws\_security\_group\_name](#input\_aws\_security\_group\_name) | Optional. Specify the name of the security group to use for the EC2 instance<br> Valid Values: Any valid AWS Security Group name<br> Notes:<br> - The value will be used to attach the correct security group to the EC2 instance.<br> - If not specified, it will use the default value. | `string` | `"ssm-tunnel"` | no |
| <a name="input_aws_subnet_name"></a> [aws\_subnet\_name](#input\_aws\_subnet\_name) | Optional. Specify the name of the subnet to use for the EC2 instance<br> Valid Values: Any valid VPC Subnet name<br> Notes:<br> - The value will be used to place the EC2 instance in the correct subnet.<br> - If not specified, it will use the default value. | `string` | `"peering-a"` | no |
| <a name="input_aws_vpc_name"></a> [aws\_vpc\_name](#input\_aws\_vpc\_name) | Optional. Specify the name of the VPC to use for the EC2 instance<br> Valid Values: Any valid VPC name<br> Notes:<br> - The value will be used to place the EC2 instance in the correct VPC.<br> - If not specified, it will use the default value. | `string` | `"peering"` | no |
| <a name="input_cost_centre"></a> [cost\_centre](#input\_cost\_centre) | Provide a cost centre for the resource.<br> Valid Values: .<br> Notes: This set the dfds.cost\_centre tag. See recommendations [here](https://wiki.dfds.cloud/en/playbooks/standards/tagging_policy). | `string` | n/a | yes |
| <a name="input_environment"></a> [environment](#input\_environment) | Specify the staging environment.<br> Valid Values: "dev", "test", "staging", "uat", "training", "prod".<br> Notes: The value will set configuration defaults according to DFDS policies. | `string` | n/a | yes |
| <a name="input_name"></a> [name](#input\_name) | Specify the name of the EC2 instance<br> Valid Values: Any string<br> Notes: The value will be used as the Name tag for the EC2 instance. | `string` | `"ssm-tunnel"` | no |
Expand Down

0 comments on commit 4bf2496

Please sign in to comment.