Skip to content

Commit 6a9575c

Browse files
committed
Add document
1 parent 2c3528c commit 6a9575c

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

docs/rules/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ These rules warn of possible errors that can occur at `terraform apply`. Rules m
1111
|aws_alb_invalid_security_group||
1212
|aws_alb_invalid_subnet||
1313
|aws_db_instance_invalid_db_subnet_group||
14+
|aws_db_instance_invalid_engine||
1415
|aws_db_instance_invalid_option_group||
1516
|aws_db_instance_invalid_parameter_group||
1617
|aws_db_instance_invalid_type||
@@ -52,6 +53,7 @@ These rules warn of possible errors that can occur at `terraform apply`. Rules m
5253
These rules suggest to better ways.
5354

5455
- [aws_instance_previous_type](aws_instance_previous_type.md)
56+
- [aws_db_instance_invalid_engine](aws_db_instance_invalid_engine.md)
5557
- [aws_db_instance_previous_type](aws_db_instance_previous_type.md)
5658
- [aws_db_instance_default_parameter_group](aws_db_instance_default_parameter_group.md)
5759
- [aws_elasticache_cluster_previous_type](aws_elasticache_cluster_previous_type.md)
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# aws_db_instance_invalid_engine
2+
3+
Disallow using invalid engine name.
4+
5+
## Example
6+
7+
```hcl
8+
resource "aws_db_instance" "default" {
9+
allocated_storage = 20
10+
engine = "mysql57" // invalid engine name!
11+
engine_version = "5.7"
12+
instance_class = "db.t2.micro"
13+
name = "mydb"
14+
username = "foo"
15+
password = "bar"
16+
db_subnet_group_name = "my_database_subnet_group"
17+
parameter_group_name = "default.mysql5.6"
18+
}
19+
```
20+
21+
```
22+
$ tflint
23+
1 issue(s) found:
24+
25+
Warning: "mysql57" is invalid engine. (aws_db_invalid_engine)
26+
27+
on template.tf line 3:
28+
3: engine = "mysql57" // invalid engine name!
29+
30+
```
31+
32+
## Why
33+
34+
Apply will fail. (Plan will succeed with the invalid value though)
35+
36+
## How To Fix
37+
38+
Select valid engine name according to the [document](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html#options)

0 commit comments

Comments
 (0)