Skip to content

Commit d4a6746

Browse files
authored
feat: added details on aws roles for cloudlist docs (#97)
1 parent 777e04f commit d4a6746

File tree

1 file changed

+49
-1
lines changed

1 file changed

+49
-1
lines changed

tools/cloudlist/providers.mdx

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,55 @@ Amazon Web Services can be integrated by using the following configuration block
4646
4747
`aws_access_key` and `aws_secret_key` can be generated in the IAM console. We recommend creating a new IAM user with `Read Only` permissions and providing the access token for the user.
4848

49-
Scopes Required: Read EC2, Route53, S3
49+
Scopes Required:
50+
51+
The following scopes can directly be provided to the IAM user.
52+
53+
```
54+
EC2 - AmazonEC2ReadOnlyAccess
55+
Route53 - AmazonRoute53ReadOnlyAccess
56+
S3 - AmazonS3ReadOnlyAccess
57+
Lambda - AWSLambda_ReadOnlyAccess
58+
ELB - ElasticLoadBalancingReadOnly
59+
Cloudfront - CloudFrontReadOnlyAccess
60+
```
61+
62+
To also support other services, a custom policy document is provided which can directly be copy-pasted to the role to allow correct and minimal permissions.
63+
64+
```json
65+
{
66+
"Version": "2012-10-17",
67+
"Statement": [
68+
{
69+
"Sid": "RequiredReadPermissions",
70+
"Effect": "Allow",
71+
"Action": [
72+
"ec2:DescribeInstances",
73+
"ec2:DescribeRegions",
74+
"route53:ListHostedZones",
75+
"route53:ListResourceRecordSets",
76+
"s3:ListAllMyBuckets",
77+
"lambda:ListFunctions",
78+
"elasticloadbalancing:DescribeLoadBalancers",
79+
"elasticloadbalancing:DescribeTargetGroups",
80+
"elasticloadbalancing:DescribeTargetHealth",
81+
"cloudfront:ListDistributions",
82+
"ecs:ListClusters",
83+
"ecs:ListServices",
84+
"ecs:ListTasks",
85+
"ecs:DescribeTasks",
86+
"ecs:DescribeContainerInstances",
87+
"eks:ListClusters",
88+
"eks:DescribeCluster",
89+
"apigateway:GET",
90+
"lightsail:GetInstances",
91+
"lightsail:GetRegions"
92+
],
93+
"Resource": "*"
94+
}
95+
]
96+
}
97+
```
5098

5199
__References:__
52100
1. https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_examples_iam_read-only-console.html

0 commit comments

Comments
 (0)