refactor: Fixed some links for Cloudformation resources docs, quicksightAccountArn needs to be passed as context

Author: SGhotra1

typescript/quicksight/README.md

@@ -1,3 +1,18 @@
+<!--BEGIN STABILITY BANNER-->
+---
+
+![Stability: Cfn-Only](https://img.shields.io/badge/stability-Cfn--Only-important.svg?style=for-the-badge)
+
+> **This is an experimental example. It may not build out of the box**
+>
+> This example is built on Cfn resources.
+>
+> It requires additional infrastructure prerequisites that must be created before successful build, see below.
+>
+> If build is unsuccessful, please create an [issue](https://github.com/aws-samples/aws-cdk-examples/issues/new) so that we may debug the problem
+---
+<!--END STABILITY BANNER-->
+
 # Welcome to your CDK TypeScript project
 
 This is a blank project for CDK development with TypeScript.
@@ -13,5 +28,5 @@ The `cdk.json` file tells the CDK Toolkit how to execute your app.
 * `npx cdk diff`    compare deployed stack with current state
 * `npx cdk synth`   emits the synthesized CloudFormation template
 
-Data taken from https://data.worldbank.org/indicator/SP.POP.TOTL
+world-population.csv file in data directory taken from https://data.worldbank.org/indicator/SP.POP.TOTL
 License: CC BY-4.0

typescript/quicksight/bin/quicksight-example.ts

@@ -4,11 +4,11 @@ import * as cdk from 'aws-cdk-lib';
 import { QuicksightExampleStack } from '../lib/quicksight-example-stack';
 
 const app = new cdk.App();
-new QuicksightExampleStack(app, 'QuicksightExampleStack');
 
-// 1. define stack props in QuicksightExampleStack
-// 2. pass stack props to QuicksightExampleStack
-// 3. make them available in the stack
-// 4. name it something along quicksight account arn
-// 5. use it getContext here and find out how to pass context with the cli. error out if context is missing
-// 6. document how to set up the stack
+// Quicksight account arn should look like this 'arn:aws:quicksight:<region>:<accountid>:user/<namespace>/<username>'
+const quicksightExampleProps = {quicksightAccountArn: app.node.tryGetContext('quicksightAccountArn')};
+if (quicksightExampleProps.quicksightAccountArn == null) {
+  console.log('quicksightAccountArn is empty! Please provide it via the cdk context');
+  process.exit(1);
+}
+new QuicksightExampleStack(app, 'QuicksightExampleStack', quicksightExampleProps);

typescript/quicksight/lib/data-transforms.ts

@@ -1,6 +1,6 @@
 import { CfnDataSet } from "aws-cdk-lib/aws-quicksight";
 /**
- * @see https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TransformOperation.html
+ * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperation.html
  */
 export const dataTransforms: CfnDataSet.TransformOperationProperty[] = [
   {

typescript/quicksight/lib/input-columns.ts

@@ -1,5 +1,8 @@
-
-export const inputColumns = [
+import { CfnDataSet } from "aws-cdk-lib/aws-quicksight";
+/**
+ * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-inputcolumn.html
+ */
+export const inputColumns: CfnDataSet.InputColumnProperty[] = [
   { "name": "Country Name", "type": "STRING"},
   { "name": "Country Code", "type": "STRING"},
   { "name": "1960", "type": "STRING"},

typescript/quicksight/lib/quicksight-example-stack.ts

@@ -3,10 +3,14 @@ import {BlockPublicAccess, Bucket, BucketAccessControl, BucketEncryption} from '
 import {BucketDeployment, Source} from 'aws-cdk-lib/aws-s3-deployment';
 import {CfnDataSet, CfnDataSource, CfnTemplate} from 'aws-cdk-lib/aws-quicksight';
 import {CfnManagedPolicy} from 'aws-cdk-lib/aws-iam';
-import { Stack, StackProps } from 'aws-cdk-lib';
+import {Stack} from 'aws-cdk-lib';
 import {dataTransforms} from './data-transforms';
 import {inputColumns} from './input-columns';
 
+interface QuicksightExampleProps {
+  quicksightAccountArn: string;
+}
+
 export class QuicksightExampleStack extends Stack {
   /**
    * location of the manifest json file in the s3 bucket.
@@ -25,13 +29,11 @@ export class QuicksightExampleStack extends Stack {
 
   public static QUICKSIGHT_DATASET_NAME = 'quicksightExampleDataset';
 
-
-  constructor(scope: Construct, id: string, props?: StackProps) {
-    super(scope, id, props);
+  constructor(scope: Construct, id: string, props: QuicksightExampleProps) {
+    super(scope, id);
 
     const { bucket, deployment } = this.createBucket();
-    const accountQuicksight = 'arn:aws:quicksight:<region>:<accountid>:user/<namespace>/<username>';
-    this.createQuicksightResources(bucket, deployment, accountQuicksight);
+    this.createQuicksightResources(bucket, deployment, props.quicksightAccountArn);
   }
 
   // creates s3 bucket and deploys test data
@@ -62,7 +64,7 @@ export class QuicksightExampleStack extends Stack {
       QuicksightExampleStack.MANIFEST_KEY,
       manifest
     );
-    // deploy them
+    // deploy them and the files stored in the data directory
     const deployment = new BucketDeployment(this, 'BucketDeployment', {
       sources: [sourceInternal, Source.asset('./data')],
       destinationBucket: bucket,
@@ -154,10 +156,13 @@ export class QuicksightExampleStack extends Stack {
       }
     )
 
-    // quicksight needs these to be created so we waiting for the
+    // quicksight needs these to be created so we're waiting for the creation of these resources
     quicksightS3DataSource.node.addDependency(managedPolicy);
     quicksightS3DataSource.node.addDependency(deployment);
 
+    /**
+     * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-physicaltable.html
+     */
     const physicalTableProperties: CfnDataSet.PhysicalTableProperty = {
       s3Source: {
         dataSourceArn: quicksightS3DataSource.attrArn,
@@ -170,8 +175,9 @@ export class QuicksightExampleStack extends Stack {
         }
       }
     }
+
     /**
-     * @see https://docs.aws.amazon.com/quicksight/latest/APIReference/API_LogicalTable.html
+     * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-logicaltable.html
      */
     const logicalTableProperties: CfnDataSet.LogicalTableProperty = {
       alias: 's3-extract-data-cast',

typescript/quicksight/package.json

@@ -13,9 +13,9 @@
   "devDependencies": {
     "@types/jest": "^29.5.12",
     "@types/node": "20.14.9",
+    "aws-cdk": "2.156.0",
     "jest": "^29.7.0",
     "ts-jest": "^29.1.5",
-    "aws-cdk": "2.156.0",
     "ts-node": "^10.9.2",
     "typescript": "~5.5.3"
   },
@@ -24,4 +24,4 @@
     "constructs": "^10.0.0",
     "source-map-support": "^0.5.21"
   }
-}
+}