Skip to content

Commit 581a6ed

Browse files
committed
fix: README.md, better description
1 parent 33acb7d commit 581a6ed

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212
## Getting Started / Prerequisites
1313
* The example project is built with Java 17 and Maven 3. Please be aware that you'll need those to run the project locally.
1414
* You'll need to create a CodeCatalyst space, a new Project with a new Code Repository
15-
* You'll need to connect the CodeCatalyst space to an AWS Account. This account will be used to store Docker images (ECR) and Java Artifacts (CodeArtifact)
16-
* **PLEASE NOTE**: During the creation of the CodeCatalyst connection, you'll need to create a proper IAM Role that will be assumed by CodeCatalyst. For this example we've used the policy you can find in the file `CodeCatalystRolePolicyExample.json`. This IAM policy is very permissive so please **don't use it for production purposes!!**
15+
* You'll need to connect the CodeCatalyst Space to an AWS Account selecting one or more IAM Roles. This AWS Account will be used to store Docker images (ECR) and Java Artifacts (CodeArtifact). The connection you created will be used to interact with the AWS Account Resources through proper IAM Roles.
16+
* **PLEASE NOTE**: During the creation of the CodeCatalyst connection to the target AWS Account, you'll need to create a proper IAM Role that will be assumed by CodeCatalyst (or use an existing one). For this example we've used a IAM Role assigning to it the policy you can find in the file `CodeCatalystRolePolicyExample.json`. This IAM policy is very permissive so please **don't use it for production purposes!!**
1717
* For this particular example we're assuming:
1818
* AWS Account ID: 123456789012
19-
* CodeCatalyst Environment (linked to the account above) named "TestEnvironment" referencing the "CodeCatalystTestEnvironmentRole" IAM role
19+
* CodeCatalyst Environment (targeting the account above) named "TestEnvironment" referencing the "CodeCatalystTestEnvironmentRole" IAM role created in account 123456789012
2020

2121
### Creating ECR and CodeArtifact repositories
2222
* You'll need to create an ECR repository and a CodeArtifact repository and properly substitute values inside `./codecatalyst/workflows/build.yaml`

0 commit comments

Comments
 (0)