Skip to content

Commit c120a91

Browse files
update readme
1 parent 84274d3 commit c120a91

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

README.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1-
# Module Blueprint
1+
# ECS instance profile
22

3-
Terraform module blueprint
3+
For an EC2 instance to connect itself to ECS it needs rights to do so.
4+
5+
6+
* [Why do we need ECS instance policies?](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/instance_IAM_role.html)
7+
* [ECS roles explained](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_managed_policies.html)
8+
* [More ECS policy examples explained](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/IAMPolicyExamples.html)
49

510
---
611

@@ -51,30 +56,43 @@ module "blueprint" {
5156
| Name | Version |
5257
|------|---------|
5358
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1 |
59+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4 |
5460

5561
## Providers
5662

57-
No providers.
63+
| Name | Version |
64+
|------|---------|
65+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4 |
5866

5967
## Modules
6068

6169
No modules.
6270

6371
## Resources
6472

65-
No resources.
73+
| Name | Type |
74+
|------|------|
75+
| [aws_iam_instance_profile.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) | resource |
76+
| [aws_iam_role.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
77+
| [aws_iam_role_policy_attachment.amazon_ssm_managed_instance_core](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
78+
| [aws_iam_role_policy_attachment.ecs_ec2_cloudwatch_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
79+
| [aws_iam_role_policy_attachment.ecs_ec2_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
6680

6781
## Inputs
6882

6983
| Name | Description | Type | Default | Required |
7084
|------|-------------|------|---------|:--------:|
71-
| <a name="input_variable"></a> [variable](#input\_variable) | defaul,description,type | `string` | `"variable"` | no |
85+
| <a name="input_include_ssm"></a> [include\_ssm](#input\_include\_ssm) | Whether to include policies needed for AmazonSSM | `bool` | `false` | no |
86+
| <a name="input_name"></a> [name](#input\_name) | Name to be used on all the resources as identifier | `string` | n/a | yes |
87+
| <a name="input_tags"></a> [tags](#input\_tags) | A map of tags to add to instance profile role | `map(string)` | `{}` | no |
7288

7389
## Outputs
7490

7591
| Name | Description |
7692
|------|-------------|
77-
| <a name="output_used"></a> [used](#output\_used) | used value |
93+
| <a name="output_iam_instance_profile_arn"></a> [iam\_instance\_profile\_arn](#output\_iam\_instance\_profile\_arn) | ARN of the IAM instance profile |
94+
| <a name="output_iam_instance_profile_id"></a> [iam\_instance\_profile\_id](#output\_iam\_instance\_profile\_id) | ID of the IAM instance profile |
95+
| <a name="output_iam_role_id"></a> [iam\_role\_id](#output\_iam\_role\_id) | ID of the IAM role |
7896
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
7997

8098

0 commit comments

Comments
 (0)