docs: generated module docs
This commit is contained in:
101
remote-state-access/README.md
Normal file
101
remote-state-access/README.md
Normal file
@@ -0,0 +1,101 @@
|
||||
## Requirements
|
||||
|
||||
The following requirements are needed by this module:
|
||||
|
||||
- <a name="requirement_aws"></a> [aws](#requirement\_aws) (~> 4.9)
|
||||
|
||||
## Providers
|
||||
|
||||
The following providers are used by this module:
|
||||
|
||||
- <a name="provider_aws"></a> [aws](#provider\_aws) (~> 4.9)
|
||||
|
||||
## Modules
|
||||
|
||||
No modules.
|
||||
|
||||
## Resources
|
||||
|
||||
The following resources are used by this module:
|
||||
|
||||
- [aws_iam_policy.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) (resource)
|
||||
- [aws_iam_role.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) (resource)
|
||||
- [aws_iam_policy_document.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) (data source)
|
||||
|
||||
## Required Inputs
|
||||
|
||||
The following input variables are required:
|
||||
|
||||
### <a name="input_bucket_name"></a> [bucket\_name](#input\_bucket\_name)
|
||||
|
||||
Description: n/a
|
||||
|
||||
Type: `string`
|
||||
|
||||
### <a name="input_dynamo_table"></a> [dynamo\_table](#input\_dynamo\_table)
|
||||
|
||||
Description: n/a
|
||||
|
||||
Type: `string`
|
||||
|
||||
### <a name="input_prefixes"></a> [prefixes](#input\_prefixes)
|
||||
|
||||
Description: n/a
|
||||
|
||||
Type: `list(string)`
|
||||
|
||||
## Optional Inputs
|
||||
|
||||
The following input variables are optional (have default values):
|
||||
|
||||
### <a name="input_create_policy"></a> [create\_policy](#input\_create\_policy)
|
||||
|
||||
Description: n/a
|
||||
|
||||
Type: `bool`
|
||||
|
||||
Default: `false`
|
||||
|
||||
### <a name="input_create_role"></a> [create\_role](#input\_create\_role)
|
||||
|
||||
Description: n/a
|
||||
|
||||
Type: `bool`
|
||||
|
||||
Default: `false`
|
||||
|
||||
### <a name="input_policy_name"></a> [policy\_name](#input\_policy\_name)
|
||||
|
||||
Description: n/a
|
||||
|
||||
Type: `string`
|
||||
|
||||
Default: `null`
|
||||
|
||||
### <a name="input_policy_path"></a> [policy\_path](#input\_policy\_path)
|
||||
|
||||
Description: n/a
|
||||
|
||||
Type: `string`
|
||||
|
||||
Default: `"/"`
|
||||
|
||||
### <a name="input_role_name"></a> [role\_name](#input\_role\_name)
|
||||
|
||||
Description: n/a
|
||||
|
||||
Type: `string`
|
||||
|
||||
Default: `null`
|
||||
|
||||
## Outputs
|
||||
|
||||
The following outputs are exported:
|
||||
|
||||
### <a name="output_policy_arn"></a> [policy\_arn](#output\_policy\_arn)
|
||||
|
||||
Description: n/a
|
||||
|
||||
### <a name="output_role_arn"></a> [role\_arn](#output\_role\_arn)
|
||||
|
||||
Description: n/a
|
||||
Reference in New Issue
Block a user