KenF
56 lines
2.2 KiB
Markdown
56 lines
2.2 KiB
Markdown
<!-- This readme file is generated with terraform-docs -->
|
|
Inline policy for IAM role is not supported by this module. Use managed policies instead.
|
|
|
|
When trusted-entity is provided as an AWS service name (e.g ec2.amazonaws.com), the assume role
|
|
policy will be generated. Otherwise, the trusted-entity variable is assumed to be a json-encoded
|
|
policy. Assume role policy will be set with the json-encoded string. See examples.
|
|
|
|
## Requirements
|
|
|
|
| Name | Version |
|
|
|------|---------|
|
|
| terraform | >= 1.3.0 |
|
|
| aws | >= 5.4.0 |
|
|
|
|
## Providers
|
|
|
|
| Name | Version |
|
|
|------|---------|
|
|
| aws | >= 5.4.0 |
|
|
|
|
## Modules
|
|
|
|
No modules.
|
|
|
|
## Resources
|
|
|
|
| Name | Type |
|
|
|------|------|
|
|
| [aws_iam_instance_profile.ip](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) | resource |
|
|
| [aws_iam_policy.p](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
|
|
| [aws_iam_role.r](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
|
|
| [aws_iam_role_policy_attachment.pa](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
|
|
|
|
## Inputs
|
|
|
|
| Name | Description | Type | Default | Required |
|
|
|------|-------------|------|---------|:--------:|
|
|
| create-instance-profile | Determines whether instance profile will be created | `bool` | `false` | no |
|
|
| description | Description of IAM role | `string` | n/a | yes |
|
|
| path | Path of IAM role. Defaults to /Customer/ | `string` | `"/Customer/"` | no |
|
|
| policies | Map of policies to be created and attached | <pre>map(<br> object(<br> {<br> description = string<br> policy = string<br> }<br> )<br> )</pre> | `{}` | no |
|
|
| role-name | Name of IAM role | `string` | n/a | yes |
|
|
| trusted-entity | AWS service allowed to assume this role or a full assume role policy | `string` | n/a | yes |
|
|
|
|
## Outputs
|
|
|
|
| Name | Description |
|
|
|------|-------------|
|
|
| instance-profile-arn | ARN of IAM instance profile |
|
|
| name | Name of IAM role |
|
|
| profile-name | Name of IAM instance profile |
|
|
| role-arn | IAM role ARN |
|
|
|
|
---
|
|
## Authorship
|
|
This module was developed by KF. |