YAML File

Complete YAML Configuration

edition: 1.0.0 #  YAML specifications version for the command line, which complies with the Semantic Versioning specifications.
name: fg-test #  Project name
access: "default" #  Key alias

vars: # Global variables
    region: "cn-east-3"
    functionName: "start-fg-event-nodejs14"

services:
    component-test: #  Service name
        component: fgs # Component name
        props:
            region: ${vars.region}
            function:
                functionName: ${vars.functionName} # Function name
                handler: index.handler # Handler
                memorySize: 256 # Memory required for the function
                timeout: 30 # Timeout for executing the function
                runtime: Node.js14.18 # Runtime
                agencyName: fgs-vpc-test # Agency name
                environmentVariables: # Environment variables
                    test: test
                    hello: world
                vpcId: xxx-xxx # Unique ID of a Virtual Private Cloud (VPC)
                subnetId: xxx-xxx # Subnet ID
                concurrency: 10 # Maximum number of instances for the function
                concurrentNum: 10 # Maximum number of concurrent requests per instance
                codeType: zip # Function code type
                dependVersionList: # Dependency ID
                    - xxx-xxx
                code: # Local code address
                    codeUri: ./code
            trigger:
                triggerTypeCode: TIMER # Trigger type
                status: DISABLED # Trigger status
                eventData: # Trigger configuration 
                    name: APIG_test  # API name
                    groupName: APIGroup_xxx # Group name
                    auth: IAM # Security authentication
                    protocol: HTTPS # Request protocol
                    timeout: 5000 # Backend timeout duration

Table 1 Parameter description

Parameter	Required	Type	Description
region	True	Enum	Region
function	True	Struct	Function
triggers	False	Struct	Triggers

Description of function Fields

The function fields in the YAML file are described in Table 2.

Description of triggers Fields

The triggers fields in the YAML file are described in Table 4.

Table 4 trigger parameter description

Parameter Name	Required	Type	Description
triggerTypeCode	True	String	Trigger type
status	False	Enum	Trigger status. Options: ACTIVE (default) and DISABLED
eventData	True	Struct	Trigger configurations, including APIG and timer triggers

• APIG trigger

  Table 5 APIG trigger parameters

  Parameter Name	Required	Type	Description
  name	False	String	API name. The function name is used by default.
  groupName	False	String	Group. The first one is selected by default.
  auth	False	Enum	Authentication mode. Default: IAM. API authentication mode. Options: App: AppKey and AppSecret high security authentication. This authentication mode is recommended. For details, see App Authentication. IAM: IAM authentication. Only IAM users are allowed to access the system. The security level is medium. For details, see IAM Authentication. None: No authentication. This mode grants access permissions to all users.
  protocol	False	Enum	Request protocol. Default: HTTPS. Options: HTTP HTTPS
  timeout	False	Number	Backend timeout in milliseconds. Range: 1–60,000. Default: 5000.

  Example:

  trigger:
      triggerTypeCode: APIG
      status: ACTIVE
      eventData:
          name: APIG_test
          groupName: APIGroup_xxx
          auth: IAM
          protocol: HTTPS
          timeout: 5000
• Timer trigger

  Table 6 Timer trigger parameter description

  Parameter Name	Required	Type	Description
  name	False	String	Timer name.
  scheduleType	True	Enum	Trigger rule. The value can be Rate or Cron.
  schedule	True	String	Timer rule content.
  userEvent	False	String	Additional information, which will be put into the user_event field of the timer event source.

  Example:

  trigger:
      triggerTypeCode: TIMER
      status: ACTIVE
      eventData:
          name: Timer-xxx
          scheduleType: Rate
          schedule: 3m
          userEvent: xxxx
  
  trigger:
      triggerTypeCode: TIMER
      status: ACTIVE
      eventData:
          name: Timer-xxx
          scheduleType: Cron
          schedule: 0 15 2 * * ?
          userEvent: xxxx