Skip to content

Commit

Permalink
chore(lambda): improve tsdoc for handler property (aws#5338)
Browse files Browse the repository at this point in the history
  • Loading branch information
nija-at authored and mergify[bot] committed Dec 8, 2019
1 parent c552960 commit 4631be1
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions packages/@aws-cdk/aws-lambda/lib/function.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,10 @@ export interface FunctionProps {
readonly description?: string;

/**
* The name of the function (within your source code) that Lambda calls to
* start running your code. For more information, see the Handler property
* in the AWS Lambda Developer Guide.
* The name of the method within your code that Lambda calls to execute
* your function. The format includes the file name. It can also include
* namespaces and other qualifiers, depending on the runtime.
* For more information, see https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-features.html#gettingstarted-features-programmingmodel.
*
* NOTE: If you specify your source code as inline text by specifying the
* ZipFile property within the Code property, specify index.function_name as
Expand Down

0 comments on commit 4631be1

Please sign in to comment.