API.md

API Reference

Classes

Name	Description
ServerlessPeriodicTimer	No description

Structs

Name	Description
ServerlessPeriodicTimerProps	No description

class ServerlessPeriodicTimer

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new ServerlessPeriodicTimer(scope: Construct, id: string, props?: ServerlessPeriodicTimerProps)

• scope (Construct) No description
• id (string) No description
• props (ServerlessPeriodicTimerProps) No description
  • eventRuleProps (RuleProps) User provided eventRuleProps to override the defaults.
  • existingLambdaObj (Function) Existing instance of Lambda Function object, if this is set then the lambdaFunctionProps is ignored. Default: None
  • lambdaFunctionProps (FunctionProps) User provided props to override the default props for the Lambda function. Default: Default props are used

Properties

Name	Type	Description
apiDeleteLambdaFunction	Function
apiGetLambdaFunction	Function
apiOptionsLambdaFunction	Function
apiPutLambdaFunction	Function
eventsRule	Rule
periodicLambdaFunction	Function
queue	Queue
restApi	RestApi
table	Table

struct ServerlessPeriodicTimerProps

Name	Type	Description
eventRuleProps	RuleProps	User provided eventRuleProps to override the defaults.
existingLambdaObj?	Function	Existing instance of Lambda Function object, if this is set then the lambdaFunctionProps is ignored. Default: None
lambdaFunctionProps?	FunctionProps	User provided props to override the default props for the Lambda function. Default: Default props are used