Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document AWS deployment role. #699

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+107 −4
Draft

docs: document AWS deployment role. #699

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 107 additions & 4 deletions docs/providers/pulumi/aws.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,109 @@ You can create an Access Key by logging into the [AWS console](https://aws.amazo
for full details on credentials and configuration.
</Note>

### Minimum Required Permissions

Below is an AWS policy that represents the minimum set of permissions required to deploy all available resources in the nitric AWS provider.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Below is an AWS policy that represents the minimum set of permissions required to deploy all available resources in the nitric AWS provider.
Below is an AWS policy that represents the minimum set of permissions required to deploy all available resources in the Nitric AWS provider.


```json
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "NitricDeployment",
"Effect": "Allow",
"Action": [
"iam:GetRole",
"iam:CreateRole",
"iam:DeleteRole",
"iam:PassRole",
"iam:ListRolePolicies",
"iam:ListAttachedRolePolicies",
"iam:ListInstanceProfilesForRole",
"iam:ListPolicyVersions",
"iam:GetPolicy",
"iam:GetRolePolicy",
"iam:DeleteRolePolicy",
"iam:GetPolicyVersion",
"iam:CreatePolicy",
"iam:DeletePolicy",
"iam:AttachRolePolicy",
"iam:DetachRolePolicy",
"iam:PutRolePolicy",
"sns:CreateTopic",
"sns:DeleteTopic",
"sns:Subscribe",
"sns:Unsubscribe",
"apigateway:POST",
"apigateway:DELETE",
"lambda:CreateFunction",
"lambda:DeleteFunction",
"lambda:GetFunction",
"lambda:TagResource",
"lambda:DeleteFunction",
"lambda:ListVersionsByFunction",
"sqs:CreateQueue",
"sqs:DeleteQueue",
"ec2:CreateVpc",
"ec2:DeleteVpc",
"ec2:CreateSubnet",
"ec2:DeleteSubnet",
"ec2:CreateSecurityGroup",
"ec2:DeleteSecurityGroup",
"ec2:AuthorizeSecurityGroupIngress",
"ec2:AuthorizeSecurityGroupEgress",
"ec2:RevokeSecurityGroupIngress",
"ec2:RevokeSecurityGroupEgress",
"ecr:BatchGetImage",
"ecr:BatchDeleteImage",
"ecr:BatchCheckLayerAvailability",
"ecr:GetDownloadUrlForLayer",
"ecr:CreateRepository",
"ecr:DeleteRepository",
"ecr:DescribeRepositories",
"ecr:DescribeImages",
"ecr:GetAuthorizationToken",
"ecr:ListTagsForResource",
"ecr:ListImages",
"ecr:PutImage",
"ecr:InitiateLayerUpload",
"ecr:UploadLayerPart",
"ecr:CompleteLayerUpload",
"ecr:GetRepositoryPolicy",
"ecr:SetRepositoryPolicy",
"rds:CreateDBCluster",
"rds:DeleteDBCluster",
"rds:CreateDBInstance",
"rds:DeleteDBInstance",
"resource-groups:CreateGroup",
"resource-groups:DeleteGroup",
"resource-groups:GetGroup",
"resource-groups:GetGroupQuery",
"resource-groups:GetGroupConfiguration",
"resource-groups:GetTags",
"events:PutRule",
"events:DeleteRule",
"events:PutTargets",
"events:RemoveTargets",
"s3:CreateBucket",
"s3:DeleteBucket",
"s3:PutBucketNotification",
"s3:GetBucketNotification",
"dynamodb:CreateTable",
"dynamodb:DeleteTable",
"ssm:DescribeParameters",
"ssm:GetParameter",
"ssm:GetParameters",
"ssm:PutParameter",
"ssm:DeleteParameter",
"ssm:ListTagsForResource"
],
"Resource": "*"
}
]
}
```

## Locating Deployed Resources

This Nitric AWS provider creates a resource tag manager group and tags all possible resources to be referenced by this group. You can locate resources using the [AWS Console](https://console.aws.amazon.com/).
Expand Down Expand Up @@ -96,8 +199,8 @@ The Nitric team is working to expand the list of resources that can be imported.
- [Buckets](/storage)

<Note>
Currently, only resources in the same AWS account and region as the Nitric project
are supported.
Currently, only resources in the same AWS account and region as the Nitric
project are supported.
</Note>

### Buckets
Expand Down Expand Up @@ -142,8 +245,8 @@ import:
```

<Note>
Unlike some other imported resources, secret imports require the ARN to be used.
Providing only the secret's name will be invalid.
Unlike some other imported resources, secret imports require the ARN to be
used. Providing only the secret's name will be invalid.
</Note>

Need to import another resource type or have another question? Chat with us on [Discord](https://nitric.io/chat) or [open an issue](https://github.com/nitrictech/nitric/issues) on GitHub.
Expand Down
Loading