Skip to content

Commit

Permalink
Update docstrings (#182)
Browse files Browse the repository at this point in the history
Update docstringsUpdates docstrings for rds-ca-2019 cert typos and several other places where terraform-docs changed formatting.
  • Loading branch information
mbarrien authored Mar 24, 2020
1 parent 868a72b commit 8d7f1ff
Show file tree
Hide file tree
Showing 20 changed files with 92 additions and 25 deletions.
19 changes: 15 additions & 4 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ dist: trusty
cache: pip
install:
# terraform
- travis_retry wget -t 10 -O terraform.zip https://releases.hashicorp.com/terraform/0.12.19/terraform_0.12.19_linux_amd64.zip
- travis_retry wget -t 10 -O terraform.zip https://releases.hashicorp.com/terraform/0.12.24/terraform_0.12.24_linux_amd64.zip
- unzip terraform.zip
- mv terraform ~/bin/
- chmod +x ~/bin/terraform
# terraform-provider-bless
- travis_retry wget -t 10 -O terraform-provider-bless.tar https://github.com/chanzuckerberg/terraform-provider-bless/releases/download/v0.2.10/terraform-provider-bless_0.2.10_linux_amd64.tar.gz
- tar -C ~/bin -xzf terraform-provider-bless.tar
# terraform-docs
# - wget -t 10 -O terraform-docs https://github.com/segmentio/terraform-docs/releases/download/v0.6.0/terraform-docs-v0.6.0-linux-amd64
# - mv terraform-docs ~/bin/terraform-docs
# - chmod +x ~/bin/terraform-docs
- wget -t 10 -O terraform-docs https://github.com/segmentio/terraform-docs/releases/download/v0.8.2/terraform-docs-v0.8.2-linux-amd64
- mv terraform-docs ~/bin/terraform-docs
- chmod +x ~/bin/terraform-docs
# awscli
- pip install awscli --upgrade --user
- aws configure set aws_access_key_id $CI1_AWS_ACCESS_KEY_ID --profile cztack-ci-1
Expand Down Expand Up @@ -49,3 +49,14 @@ env:
- secure: EzbYu45kuUeC56EVsLHdzhrLZc7tqUJAq5ayK1ccYYQbBkfrRYvFYbY2KHm/F7xQqqH8mai/LLTL9Z3VCbi60GVw/ywdQZR3Hv+KRClrl3+UccpoR0y4WxMERp6yjy7rwvcjg37J/mxjyQUyyUVahj/bLB9Sst/M6/OWbrK9SIO8l/ZynBBEm2PPqelwwIg+kpOatKY/mwBsaLl3i/lirR6kSE3gJMU/v8e+ecQRW2wsZ5u+ZiwfIuYI0a2GIt8UpI0H1tgZHh4aT+ArKICTkggWJTxqKy21xyEUe7frku8SUmyRBdu1h2O3Xz/qQ4tzUgDPaDMaxL/9L5Xm0K9RkhANTGXzmVBtVOtohdLL4Jn6VHcedPH2thm47+fWSwr1MaMI8o4RJro9B5mj1uDOz4W4rac6RXkPERB3IeBR2+g138TT1CxpaawrS/E92uDOggJ1/lpVyKFGwP1JoCJsz+yhxRgvEIUIR4mPDU6MqPOjZEr2ub9YK3AWDBMzyF41BLx1Rpd/ChN8LzEX0HrpGx3dNhh8LPxum1/8O0GpZFQZcex44FLp8UB7j4zC1KDo44SKUPcNM31GHiDKMN/uWvCSlN56c0rnZ/a/aWNUUipaXKJmnbU/IyAsLIMb6pXVxbSID2hq7hh1LFv7i/bp4tDNNrW8hLrCeQkYjzdE+Jo=
- secure: U/daF6UvK+oUEMT/10O+li4+VLZcEBAlGv22M31T1KYbNItM6oNOhKqE/QG29K98X3naw07tdpfFnPdgDBokaZXIXJr853pCDevjrrg8+HtgTAoRZMDtnVSQRrpT/o44U3bxuGAhCAEq4QBrqgdWhYLoBcw1qv3sg4FhBAOR5DFm4L/+uZ4d7RvYBBk4yed9H1l/Av67ps9klZ70VAQ2JB1sGWyD2wiajaZh+nP5Z4TE1j+XdKKpOeAuAS0oml5onXk8i/fOTmi3pplbaWsQjQjQXH0JzKsqi1aqieevTCMt4GBHjKaU34i9TmMprL9bxCCHrI3s4xJ+gi5LAaV8hjliKuAIwPqq7dcx/JwH7pDxLTLzycGWTG9HHgE26sp+OFCTG54ed47Y/4jttEBl6jyV7C9jNKi6GcJ/+qgXZ596tKBY6+oPNjoduA9aMkuQ7HGlbOsYdul1xGSwZB1G4Z/Xwt/6VFgtjdbxkNAkfkJGh2drPP7oZ4xbWS8AF3Ww5ELdlrk+mNh18h9UBITD65UGvasYBXQy5ufnHiojn7ZXXhGEt9gvJKCLYMrqRQYHZzQPym7iMwfqrY/YSsuGbO2QulXNlvX04854PDIf/AQzdzCYkI1ADQ6L8TQzMXSgqpr0LrQloUdVKugP0As2ykQ9vT9YfG1wbrR4yAybNz4=
- secure: vgbr7f5EUve/KKGP+H72Vp9AO3VsW+N1GapoUE4SVH26S3pMV+rk+5uzZI4c/qhuKN0K9mUGjn96R6/SApE6WhgFq6IiRKMEv3LqKUO08iV1nbyRSln55d8ndzNiZwx+s6hKEv85qIOJpEqRDY8u3e1BrO88nFLlY/rFBIlbcy+6zZcOuAxH6DWaYYlxWob2N3DCJypCBNIivMGzVfEEqF+ltVaYS5dpSPowBthQUPY2+/Qc3v6e4+VXZuFJ28FzsOmWryHdgqrxptCx/7nPVxS3N1wX1T+GPmiLd4UCZqThT0hN//67g03LmlQr0+HxmnGPSDWEEg3PfzrvNeHbEG5Pb9mXVJ8Rt6hn2FYUqLqbfh7SAsTIZ2FKPoRo0kQWGGqjs/yyHbEw5HDTxtdyVnpoYIJW7HrsNeyQyEugwca0/nBmzlBYxqm5lhBDhsIay3uZ21y7ZQ70L8vubhx80VzyqqC4DAT6oJ5V9Y4EfG3SG6B33ZBCe0ej1LWRdeLR7SarW/R22dyCs1gY2cxy5yWrDJDtZBtHRIpvK0Y9mjTEHaFogatLaPaNK33s3lNuXh2asbhktG80PjdJpcLQaqhziTjFPV8OMtBtgI5vAOiIHiXw3s1Er5Ct2HcmpWTTQbRPoPMkKubJEq9bYlrLTsqNPimtkfEZm0aryRvL0+U=

stages:
- check
- test

jobs:
include:
- stage: check
script: make check-docs
- stage: check
script: make lint
2 changes: 1 addition & 1 deletion aws-acm-cert/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ module "cert" {
|------|-------------|------|---------|:-----:|
| allow\_validation\_record\_overwrite | Allow the overwrite of validation records. This is needed if you are creating certificates in multiple regions. | `string` | `true` | no |
| aws\_route53\_zone\_id | n/a | `string` | n/a | yes |
| cert\_domain\_name | Like www.foo.bar.com or \*.foo.bar.com | `string` | n/a | yes |
| cert\_domain\_name | Like www.foo.bar.com or *.foo.bar.com | `string` | n/a | yes |
| cert\_subject\_alternative\_names | A map of <alternative\_domain:route53\_zone\_id> | `map` | `{}` | no |
| env | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
| owner | Owner for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
Expand Down
6 changes: 3 additions & 3 deletions aws-aurora-mysql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,13 @@ No provider.
|------|-------------|------|---------|:-----:|
| apply\_immediately | If false changes will not be applied until next maintenance window. | `string` | `false` | no |
| backtrack\_window | Turns on Backgrack for this many seconds. [Doc](https://aws.amazon.com/blogs/aws/amazon-aurora-backtrack-turn-back-time/) | `string` | `0` | no |
| ca\_cert\_identifier | Identifier for the certificate authority. 9 is the latest available version. | `string` | `"rds-ca-2019"` | no |
| ca\_cert\_identifier | Identifier for the certificate authority. rds-ca-2019 is the latest available version. | `string` | `"rds-ca-2019"` | no |
| database\_name | The name of the database to be created in the cluster. | `string` | n/a | yes |
| database\_password | Password for user that will be created. | `string` | n/a | yes |
| database\_subnet\_group | The name of an existing database subnet group to use. | `string` | n/a | yes |
| database\_username | Default user to be created. | `string` | n/a | yes |
| db\_deletion\_protection | n/a | `string` | `false` | no |
| db\_parameters | Instance params you can set. [Doc](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Reference.html#AuroraMySQL.Reference.Parameters.Instance) | `list` | <pre>[<br> {<br> "apply_method": "pending-reboot",<br> "name": "general_log",<br> "value": 1<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "slow_query_log",<br> "value": "1"<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "long_query_time",<br> "value": "0"<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "log_output",<br> "value": "file"<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "log_queries_not_using_indexes",<br> "value": "1"<br> }<br>]<br></pre> | no |
| db\_parameters | Instance params you can set. [Doc](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Reference.html#AuroraMySQL.Reference.Parameters.Instance) | `list` | <pre>[<br> {<br> "apply_method": "pending-reboot",<br> "name": "general_log",<br> "value": 1<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "slow_query_log",<br> "value": "1"<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "long_query_time",<br> "value": "0"<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "log_output",<br> "value": "file"<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "log_queries_not_using_indexes",<br> "value": "1"<br> }<br>]</pre> | no |
| engine\_version | n/a | `string` | `"5.7"` | no |
| env | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
| iam\_database\_authentication\_enabled | n/a | `string` | `false` | no |
Expand All @@ -60,7 +60,7 @@ No provider.
| performance\_insights\_enabled | n/a | `string` | `false` | no |
| project | Project for tagging and naming. See [doc](../README.md#consistent-tagging) | `string` | n/a | yes |
| publicly\_accessible | Avoid doing this - it gives access to the open internet. | `string` | `false` | no |
| rds\_cluster\_parameters | Cluster params you can set. [Doc](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Reference.html#AuroraMySQL.Reference.Parameters.Cluster) | `list` | <pre>[<br> {<br> "apply_method": "pending-reboot",<br> "name": "character_set_server",<br> "value": "utf8"<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "character_set_client",<br> "value": "utf8"<br> }<br>]<br></pre> | no |
| rds\_cluster\_parameters | Cluster params you can set. [Doc](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Reference.html#AuroraMySQL.Reference.Parameters.Cluster) | `list` | <pre>[<br> {<br> "apply_method": "pending-reboot",<br> "name": "character_set_server",<br> "value": "utf8"<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "character_set_client",<br> "value": "utf8"<br> }<br>]</pre> | no |
| service | Service for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
| skip\_final\_snapshot | When you destroy a database RDS will, by default, take snapshot. Set this to skip that step. | `string` | `false` | no |
| vpc\_id | The id of the existing VPC in which this cluster should be created. | `string` | n/a | yes |
Expand Down
2 changes: 1 addition & 1 deletion aws-aurora-mysql/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,6 @@ variable "engine_version" {

variable ca_cert_identifier {
type = string
description = "Identifier for the certificate authority. 9 is the latest available version."
description = "Identifier for the certificate authority. rds-ca-2019 is the latest available version."
default = "rds-ca-2019"
}
2 changes: 1 addition & 1 deletion aws-aurora/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This is a low-level module for creating AWS Aurora clusters. We strongly reccome
|------|-------------|------|---------|:-----:|
| apply\_immediately | n/a | `bool` | `false` | no |
| backtrack\_window | n/a | `number` | `0` | no |
| ca\_cert\_identifier | Identifier for the certificate authority. Use rds-ca-2015 for anything new. | `string` | `"rds-ca-2019"` | no |
| ca\_cert\_identifier | Identifier for the certificate authority. Use rds-ca-2019 for anything new. | `string` | `"rds-ca-2019"` | no |
| database\_name | n/a | `string` | n/a | yes |
| database\_password | n/a | `string` | n/a | yes |
| database\_subnet\_group | n/a | `string` | n/a | yes |
Expand Down
2 changes: 1 addition & 1 deletion aws-aurora/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,6 @@ variable "db_deletion_protection" {

variable ca_cert_identifier {
type = string
description = "Identifier for the certificate authority. Use rds-ca-2015 for anything new."
description = "Identifier for the certificate authority. Use rds-ca-2019 for anything new."
default = "rds-ca-2019"
}
14 changes: 14 additions & 0 deletions aws-ecs-job-fargate/module_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package test

import (
"testing"

"github.com/gruntwork-io/terratest/modules/terraform"
)

func TestAWSECSJobFargate(t *testing.T) {
options := &terraform.Options{
TerraformDir: ".",
}
terraform.Init(t, options)
}
14 changes: 14 additions & 0 deletions aws-ecs-job/module_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package test

import (
"testing"

"github.com/gruntwork-io/terratest/modules/terraform"
)

func TestAWSECSJob(t *testing.T) {
options := &terraform.Options{
TerraformDir: ".",
}
terraform.Init(t, options)
}
6 changes: 3 additions & 3 deletions aws-ecs-service-fargate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,12 +166,12 @@ service = false` argument can be removed.
| extra\_tags | Extra tags that will be added to components created by this module. | `map(string)` | `{}` | no |
| health\_check\_grace\_period\_seconds | Seconds to ignore failing load balancer health checks on newly instantiated tasks to prevent premature shutdown, up to 7200. | `number` | `60` | no |
| health\_check\_interval | Time between health checks of the underlying service. | `number` | n/a | yes |
| health\_check\_matcher | Range of HTTP status codes considered success for health checks. [Doc](https://www.terraform.io/docs/providers/aws/r/lb\_target\_group.html#matcher) | `string` | `"200-399"` | no |
| health\_check\_matcher | Range of HTTP status codes considered success for health checks. [Doc](https://www.terraform.io/docs/providers/aws/r/lb_target_group.html#matcher) | `string` | `"200-399"` | no |
| health\_check\_path | n/a | `string` | `"/"` | no |
| health\_check\_timeout | Timeout for a health check of the underlying service. | `number` | n/a | yes |
| internal\_lb | n/a | `bool` | `false` | no |
| lb\_idle\_timeout\_seconds | n/a | `number` | `60` | no |
| lb\_ingress\_cidrs | n/a | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]<br></pre> | no |
| lb\_ingress\_cidrs | n/a | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]</pre> | no |
| lb\_ingress\_security\_group\_ids | n/a | `list(string)` | `[]` | no |
| lb\_subnets | List of subnets in which to deploy the load balancer. | `list(string)` | n/a | yes |
| manage\_task\_definition | If false, Terraform will not touch the task definition for the ECS service after initial creation | `bool` | `true` | no |
Expand All @@ -186,7 +186,7 @@ service = false` argument can be removed.
| subdomain | Subdomain in the zone. Final domain name will be subdomain.zone | `string` | n/a | yes |
| tag\_service | Apply cost tags to the ECS service. Only specify false for backwards compatibility with old ECS services. | `bool` | `true` | no |
| task\_definition | JSON to describe task. If omitted, defaults to a stub task that is expected to be managed outside of Terraform. | `string` | n/a | yes |
| task\_egress\_cidrs | CIDRs the task is allowed to communicate with for outbound traffic. | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]<br></pre> | no |
| task\_egress\_cidrs | CIDRs the task is allowed to communicate with for outbound traffic. | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]</pre> | no |
| task\_egress\_security\_group\_ids | Security groups the task is allowed to communicate with for outbound traffic. Only used if awsvpc\_network is true. | `list(string)` | `[]` | no |
| task\_role\_arn | n/a | `string` | n/a | yes |
| task\_subnets | List of subnets in which to deploy the task for awsvpc networking mode. | `list(string)` | `[]` | no |
Expand Down
2 changes: 1 addition & 1 deletion aws-ecs-service-fargate/alb.tf
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ resource "aws_lb_listener" "https" {

module "alb-sg" {
source = "terraform-aws-modules/security-group/aws"
version = "3.1.0"
version = "3.4.0"
name = "${local.name}-alb"
description = "Security group for ${var.internal_lb ? "internal" : "internet facing"} ALB"
vpc_id = var.vpc_id
Expand Down
14 changes: 14 additions & 0 deletions aws-ecs-service-fargate/module_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package test

import (
"testing"

"github.com/gruntwork-io/terratest/modules/terraform"
)

func TestAWSECSServiceFargate(t *testing.T) {
options := &terraform.Options{
TerraformDir: ".",
}
terraform.Init(t, options)
}
2 changes: 1 addition & 1 deletion aws-ecs-service-fargate/service.tf
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ locals {

module "container-sg" {
source = "terraform-aws-modules/security-group/aws"
version = "3.1.0"
version = "3.4.0"
name = local.name
description = "ECS ingress port"
vpc_id = var.vpc_id
Expand Down
6 changes: 3 additions & 3 deletions aws-ecs-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,12 +158,12 @@ service = false` argument can be removed.
| extra\_tags | Extra tags that will be added to components created by this module. | `map(string)` | `{}` | no |
| health\_check\_grace\_period\_seconds | Seconds to ignore failing load balancer health checks on newly instantiated tasks to prevent premature shutdown, up to 7200. | `number` | `60` | no |
| health\_check\_interval | Time between health checks of the underlying service. | `number` | n/a | yes |
| health\_check\_matcher | Range of HTTP status codes considered success for health checks. [Doc](https://www.terraform.io/docs/providers/aws/r/lb\_target\_group.html#matcher) | `string` | `"200-399"` | no |
| health\_check\_matcher | Range of HTTP status codes considered success for health checks. [Doc](https://www.terraform.io/docs/providers/aws/r/lb_target_group.html#matcher) | `string` | `"200-399"` | no |
| health\_check\_path | n/a | `string` | `"/"` | no |
| health\_check\_timeout | Timeout for a health check of the underlying service. | `number` | n/a | yes |
| internal\_lb | n/a | `bool` | `false` | no |
| lb\_idle\_timeout\_seconds | n/a | `number` | `60` | no |
| lb\_ingress\_cidrs | n/a | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]<br></pre> | no |
| lb\_ingress\_cidrs | n/a | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]</pre> | no |
| lb\_ingress\_security\_group\_ids | n/a | `list(string)` | `[]` | no |
| lb\_subnets | List of subnets in which to deploy the load balancer. | `list(string)` | n/a | yes |
| manage\_task\_definition | If false, Terraform will not touch the task definition for the ECS service after initial creation | `bool` | `true` | no |
Expand All @@ -178,7 +178,7 @@ service = false` argument can be removed.
| subdomain | Subdomain in the zone. Final domain name will be subdomain.zone | `string` | n/a | yes |
| tag\_service | Apply cost tags to the ECS service. Only specify false for backwards compatibility with old ECS services. | `bool` | `true` | no |
| task\_definition | JSON to describe task. If omitted, defaults to a stub task that is expected to be managed outside of Terraform. | `string` | n/a | yes |
| task\_egress\_cidrs | CIDR blocks the task is allowed to communicate with for outbound traffic. Only used if awsvpc\_network\_mode is true. | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]<br></pre> | no |
| task\_egress\_cidrs | CIDR blocks the task is allowed to communicate with for outbound traffic. Only used if awsvpc\_network\_mode is true. | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]</pre> | no |
| task\_egress\_security\_group\_ids | Security groups the task is allowed to communicate with for outbound traffic. Only used if awsvpc\_network\_mode is true. | `list(string)` | `[]` | no |
| task\_role\_arn | n/a | `string` | n/a | yes |
| task\_subnets | List of subnets in which to deploy the task for awsvpc networking mode. Only used if awsvpc\_network\_mode is true. | `list(string)` | `[]` | no |
Expand Down
2 changes: 1 addition & 1 deletion aws-ecs-service/alb.tf
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ resource "aws_lb_listener" "https" {

module "alb-sg" {
source = "terraform-aws-modules/security-group/aws"
version = "3.1.0"
version = "3.4.0"
name = "${local.name}-alb"
description = "Security group for ${var.internal_lb ? "internal" : "internet facing"} ALB"
vpc_id = var.vpc_id
Expand Down
14 changes: 14 additions & 0 deletions aws-ecs-service/module_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package test

import (
"testing"

"github.com/gruntwork-io/terratest/modules/terraform"
)

func TestAWSECSService(t *testing.T) {
options := &terraform.Options{
TerraformDir: ".",
}
terraform.Init(t, options)
}
2 changes: 1 addition & 1 deletion aws-ecs-service/service.tf
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ locals {

module "container-sg" {
source = "terraform-aws-modules/security-group/aws"
version = "3.1.0"
version = "3.4.0"
create = var.awsvpc_network_mode
name = local.name
description = "ECS ingress port"
Expand Down
2 changes: 1 addition & 1 deletion aws-iam-role-cloudfront-poweruser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This module will create a role which is granted poweruser control over AWS Cloud
|------|-------------|------|---------|:-----:|
| iam\_path | n/a | `string` | `"/"` | no |
| role\_name | Name of the role to create | `string` | n/a | yes |
| s3\_bucket\_prefixes | Limits role permissions to buckets with specific prefixes. Empty for all buckets. | `list` | <pre>[<br> ""<br>]<br></pre> | no |
| s3\_bucket\_prefixes | Limits role permissions to buckets with specific prefixes. Empty for all buckets. | `list` | <pre>[<br> ""<br>]</pre> | no |
| saml\_idp\_arn | The AWS SAML IDP arn to establish a trust relationship. Ignored if empty or not provided. | `string` | `""` | no |
| source\_account\_id | The source AWS account to establish a trust relationship. Ignored if empty or not provided. | `string` | `""` | no |

Expand Down
2 changes: 1 addition & 1 deletion aws-iam-role-crossacct/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ module "group" {
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:-----:|
| iam\_path | The IAM path to put this role in. | `string` | `"/"` | no |
| oidc | A list of AWS OIDC IDPs to establish a trust relationship for this role. | <pre>list(object(<br> {<br> idp_arn : string, # the AWS IAM IDP arn<br> client_ids : list(string), # a list of oidc client ids<br> provider : string # your provider url, such as foo.okta.com<br> }<br> ))<br></pre> | `[]` | no |
| oidc | A list of AWS OIDC IDPs to establish a trust relationship for this role. | <pre>list(object(<br> {<br> idp_arn : string, # the AWS IAM IDP arn<br> client_ids : list(string), # a list of oidc client ids<br> provider : string # your provider url, such as foo.okta.com<br> }<br> ))</pre> | `[]` | no |
| role\_name | The name of the role. | `string` | n/a | yes |
| saml\_idp\_arn | The AWS SAML IDP arn to establish a trust relationship. Ignored if empty or not provided. | `string` | `""` | no |
| source\_account\_id | The source AWS account to establish a trust relationship. Ignored if empty or not provided. | `string` | `""` | no |
Expand Down
Loading

0 comments on commit 8d7f1ff

Please sign in to comment.