Updates documentation

hanseartic · hanseartic · commit be93118f94e9 · 2024-03-19T11:37:06.000+01:00
* fix a typo in python example
* add properties' description to API
diff --git a/API.md b/API.md
diff --git a/README.md b/README.md
@@ -165,7 +165,7 @@ from aws_cdk import (
     Stack,
     aws_ec2 as ec2,
 )
-from consturcts import Construct
+from constructs import Construct
 from cdk_image_pipeline import ImagePipeline
 
 # ...
diff --git a/src/index.ts b/src/index.ts
@@ -129,7 +129,13 @@ export interface ImagePipelineProps {
 
 export class ImagePipeline extends Construct {
   imageRecipeComponents: imagebuilder.CfnImageRecipe.ComponentConfigurationProperty[];
+  /**
+   * The internal image pipeline created by this construct.
+   */
   readonly pipeline: imagebuilder.CfnImagePipeline;
+  /**
+   * SNS Topic where the internal ImageBuilder will notify about new builds.
+   */
   readonly builderSnsTopic: sns.Topic;
 
   constructor(scope: Construct, id: string, props: ImagePipelineProps) {

Original file line number	Diff line number	Diff line change
`@@ -165,7 +165,7 @@ from aws_cdk import (`
`165`	`165`	`Stack,`
`166`	`166`	`aws_ec2 as ec2,`
`167`	`167`	`)`
`168`		`-from consturcts import Construct`
	`168`	`+from constructs import Construct`
`169`	`169`	`from cdk_image_pipeline import ImagePipeline`
`170`	`170`
`171`	`171`	`# ...`