Please enable JavaScript.

Coggle requires JavaScript to display documents.

Structure of a typical project - Coggle Diagram

- - - - which extends NodejsFunction
        
        a construct
        
        used to create lambda functions
      - constructor expects
        
        a scope
        
        in this case, a stack
        
        an id for the lambda
        
        a properties object
    - - class CmsImagesImportProcessor extends UktvFunction { constructor( scope: UktvStack, id: string, { bus }: CmsImagesImportProcessorProps, ) { super(scope, id, { entry: 'src/functions/cmsImagesImportProcessor/index.ts', ...
      - that points to the code to be run
  - - - which extends Stack
    - - the Construct
      - an id for the stack
      - a properties object
    - - such as
        
        S3 buckets
        
        event buses
        
        secrets
  - - - needed within the stack
      - such as
        
        DualRunningConfiguration
        
        a Construct that contains
        
        a Rule
        
        that watches for events from an event bus
        
        on a given Schedule
        
        with a Target
        
        the resource to be invoked
        
        of an SqsQueue
- - - - in a folder of same name as the lambda function
      - and all export a function called lambdaHandler, which
        
        receives an event of various types
        
        examples
        
        APIGatewayEvent
        
        returns a result
        
        via a Promise
        
        examples
        
        an APIGatewayProxyResult
      - export const lambdaHandler = async ( event: EventBridgeEvent<string, ImportImagesEventDetail>, ): Promise<string> => { ...
  - - - receives an XML string
      - returns a class/type
        
        via a Promise
      - does the following
        
        converts the XML to JSON
        
        formats it to create one or more objects
- - - - adds to the end of the name
        
        either
        
        for a branch
        
        first word of the stage
        
        JIRA id from the stage
        
        for master
        
        nothing
    - - addStageToName( this, `freeway-${this.environmentName}-dual-running-comparison`, )
      - creates
        
        freeway-preproduction-dual-running-comparison