added doc strings and rename argument

aws · Feb 29, 2020 · 29f25e6 · 29f25e6
1 parent 6ec4d50
commit 29f25e6
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/packages/@aws-cdk/custom-resources/lib/aws-custom-resource/aws-custom-resource.ts b/packages/@aws-cdk/custom-resources/lib/aws-custom-resource/aws-custom-resource.ts
@@ -31,11 +31,15 @@ export class PhysicalResourceId {
   /**
    * Construct a resource id from an explicit id.
    */
-  public static fromId(id: string): PhysicalResourceId {
-    return new PhysicalResourceId(undefined, id);
+  public static fromLiteralString(literalId: string): PhysicalResourceId {
+    return new PhysicalResourceId(undefined, literalId);
   }
 
-  private constructor(public readonly responsePath?: string, public readonly id?: string) { }
+  /**
+   * @param responsePath Path to a response data element to be used as the physical id.
+   * @param literalId Literal string to be used as the physical id.
+   */
+  private constructor(public readonly responsePath?: string, public readonly literalId?: string) { }
 }
 
 /**