Skip to content

Commit

Permalink
Merge pull request #333 from aws-solutions/feature/update-readme
Browse files Browse the repository at this point in the history
docs: update 'Customizing the Solution' section
  • Loading branch information
beomseoklee authored Feb 3, 2022
2 parents 1bc3f9f + 83296c8 commit b6a4f88
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ export MAIN_DIRECTORY=$PWD

```bash
export REGION=aws-region-code # the AWS region to launch the solution (e.g. us-east-1)
export DIST_OUTPUT_BUCKET=my-bucket-name # bucket where customized code will reside, randomized name recommended
export BUCKET_PREFIX=my-bucket-name # the bucket prefix, randomized name recommended
export BUCKET_NAME=$BUCKET_PREFIX-$REGION # the bucket name where customized code will reside
export SOLUTION_NAME=my-solution-name # the solution name
export VERSION=my-version # version number for the customized code
```
Expand All @@ -80,12 +81,12 @@ chmod +x run-unit-tests.sh
```bash
cd $MAIN_DIRECTORY/deployment
chmod +x build-s3-dist.sh
./build-s3-dist.sh $DIST_OUTPUT_BUCKET $SOLUTION_NAME $VERSION
./build-s3-dist.sh $BUCKET_PREFIX $SOLUTION_NAME $VERSION
```

## Deploy

- Deploy the distributable to the Amazon S3 bucket in your account. Make sure you are uploading the distributable to the `$DIST_OUTPUT_BUCKET-$REGION` bucket.
- Deploy the distributable to the Amazon S3 bucket in your account. Make sure you are uploading the files in `deployment/global-s3-assets` and `deployment/regional-s3-assets` to `$BUCKET_NAME/$SOLUTION_NAME/$VERSION`.
- Get the link of the solution template uploaded to your Amazon S3 bucket.
- Deploy the solution to your account by launching a new AWS CloudFormation stack using the link of the solution template in Amazon S3.

Expand Down

0 comments on commit b6a4f88

Please sign in to comment.