Help Center/ FunctionGraph/ Developer Guide/ Development Tools/ Serverless Devs/ Using Commands/ YAML File/ Description of the triggers Field
Updated on 2024-04-12 GMT+08:00
View PDF
Share

Description of the triggers Field

trigger Field

Table 1 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 configuration, including APIG Trigger and Timer Trigger.

triggerTypeCode supports APIG and TIMER.

APIG Trigger

Table 2 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.

protocol

False

Enum

Request protocol. Default: HTTPS.

timeout

False

Number

Backend timeout in milliseconds. Range: 1–60,000. Default: 5000.
  • auth
    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

    Options:

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

Timer Trigger

Table 3 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
Parent topic: YAML File