Skip to content

Commit 50d2b86

Browse files
authored
Merge pull request #98 from DefangLabs/jordan/document-aws-permission-requirements
Document BYOC AWS Managed Resources
2 parents 1458fd4 + a7051f9 commit 50d2b86

File tree

1 file changed

+54
-1
lines changed

1 file changed

+54
-1
lines changed

docs/providers/aws/aws.md

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Why should you use Defang with AWS? Defang allows you to easily create and manag
1414

1515
## Getting Started
1616

17-
Getting started with the Defang BYOC AWS Provider is easy. Make sure you have properly [authenticated your AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html).
17+
Getting started with the Defang BYOC AWS Provider is easy. The first step is to [authenticate your shell](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) with AWS as an admin user. The authenticated user should be an IAM admin because Defang will need permission to create resources and IAM roles in your account.
1818

1919
:::tip
2020
If you have the aws CLI installed, you should be able to successfully run `aws sts get-caller-identity` and see your account ID.
@@ -63,3 +63,56 @@ When using [Managed Postgres](/docs/concepts/managed-storage/managed-postgres.md
6363
### Managed Redis
6464

6565
When using [Managed Redis](/docs/concepts/managed-storage/managed-redis.md), the Defang CLI provisions an ElastiCache Redis cluster in your account.
66+
67+
### Managed Resources
68+
69+
Defang will create and manage the following resources in your AWS account from its bootstrap CloudFormation template:
70+
71+
| Resource Type | Example Resource Name |
72+
|---------------|------------------------|
73+
| s3/Bucket | defang-cd-bucket-cbpbzz8hzm7 |
74+
| ecs/ClusterCapacityProviderAssociations | defang-cd-Cluster-pqFhjwuklvm |
75+
| ecs/Cluster | defang-cd-ClusterpJqFhjwuklvm |
76+
| iam/Role | defang-cd-ExeutionRole-XE7RbQDfeEwx |
77+
| ec2/InternetGateway | igw-05bd7adc92541ec3 |
78+
| ec2/VPCGatewayAttachment | IGW|vpc-0cbca64f13435695 |
79+
| logs/LogGroup | defang-cd-Logroup-6LSZet3tFnEy |
80+
| ecr/PullThroughCacheRule | defang-cd-ecrpublic |
81+
| ec2/Route | rtb-08f3f5afc9e6c8c8|0.0.0.0/0 |
82+
| ec2/RouteTable | rtb-08f3f5ffc9e6c8c8 |
83+
| ec2/VPCEndpoint | vpce-02175d8d4f47d0c9 |
84+
| ec2/SecurityGroup | sg-032b839c63e70e49 |
85+
| ec2/Subnet | subnet-086bead399ddc8a0 |
86+
| ec2/SubnetRouteTableAssociation | rtbassoc-02e200d45e7227fe |
87+
| ecs/TaskDefinition | arn:aws:ecsus-west-2:381492210770:task-definition/defang-cd-TaskDefinition-RXd5tf9TaN38:1 |
88+
| iam/Role | defang-cd-askRole-gsEeDPd6sPQY |
89+
| ec2/VPC | vpc-0cbca64f13435695 |
90+
91+
Then, for each project you deploy, defang will create and manage the following resources:
92+
93+
| Resource Type | Example Resource Name |
94+
|---------------|------------------------|
95+
| ecr/Repository | project1/kaniko-build |
96+
| ecr/LifecyclePolicy | project1/kaniko-build |
97+
| acm/Certificate | *.project1.tenant1.defang.app |
98+
| ecr/Repository | project1/kaniko-build/cache |
99+
| ecr/LifecyclePolicy | project1/kaniko-build/cache |
100+
| iam/InstanceProfile | ecs-agent-profile |
101+
| iam/Role | ecs-task-execution-role |
102+
| cloudwatch/EventRule | project1-ecs-lifecycle-rule |
103+
| cloudwatch/EventTarget | project1-ecs-event-cw-target |
104+
| route53/Record | validation-project1.tenant1.defang.app |
105+
| acm/CertificateValidation | *.project1.tenant1.defang.appValidation |
106+
| ec2/VpcDhcpOptionsAssociation | dhcp-options-association |
107+
| cloudwatch/LogGroup | builds |
108+
| iam/Role | kaniko-task-role |
109+
| ecs/TaskDefinition | kanikoTaskDefArm64 |
110+
| ecs/TaskDefinition | kanikoTaskDefAmd64 |
111+
| s3/Bucket | defang-build |
112+
| s3/BucketPublicAccessBlock | defang-build-block |
113+
| ecs/Cluster | cluster |
114+
| ecs/ClusterCapacityProviders | cluster-capacity-providers |
115+
| ec2/SecurityGroup | project1_app-sg |
116+
| ec2/SecurityGroup | bootstrap |
117+
| ec2/VpcDhcpOptions | dhcp-options |
118+
| cloudwatch/LogGroup | logs |

0 commit comments

Comments
 (0)