Skip to content

Commit 8a9b4d9

Browse files
committed
docs: Added explanation of the quicksight arn, removed test scripts
1 parent 535f1e5 commit 8a9b4d9

File tree

2 files changed

+15
-4
lines changed

2 files changed

+15
-4
lines changed

typescript/quicksight/README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ world-population.csv file in data directory taken from https://data.worldbank.or
2222
License: CC BY-4.0
2323

2424
## Build
25-
25+
2626
To build this app, you need to be in this example's root folder. Then run the following:
27-
27+
2828
```bash
2929
npm install -g aws-cdk
3030
npm install
@@ -44,11 +44,23 @@ npm run build
4444
1. Create a quicksight account [by following these instructions](https://docs.aws.amazon.com/quicksight/latest/user/signing-up.html).
4545
2. Use the arn of the quicksight account and pass it to cdk using a context `cdk deploy --context quicksightAccountArn=<arn>`
4646

47+
The Quicksight account arn should look like this 'arn:aws:quicksight:\<region>:\<accountid>:user/\<namespace>/\<username>'
48+
49+
#### \<region>
50+
The aws region that contains the quicksight resources.
51+
#### \<accountid>
52+
This is your AWS account id.
53+
#### \<namespace>
54+
You can create a separate namespace, but if you haven't created one it should be 'default'.
55+
#### \<username>
56+
You can find the username in Quicksight. It should be the same as your IAM Account name
57+
and if you are using a role it will be added to the name as well like: \<role>/\<username>
58+
4759
## Useful commands
4860

4961
* `npm run build` compile typescript to js
5062
* `npm run watch` watch for changes and compile
5163
* `npm run test` perform the jest unit tests
5264
* `npx cdk deploy` deploy this stack to your default AWS account/region
5365
* `npx cdk diff` compare deployed stack with current state
54-
* `npx cdk synth` emits the synthesized CloudFormation template
66+
* `npx cdk synth` emits the synthesized CloudFormation template

typescript/quicksight/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
"scripts": {
88
"build": "tsc",
99
"watch": "tsc -w",
10-
"test": "jest",
1110
"cdk": "cdk"
1211
},
1312
"devDependencies": {

0 commit comments

Comments
 (0)