Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--mongodb-atlas-trigger.json
Parent schema serverless-framework-configuration
Type: object

Properties

AppId string | Aws_CF_FunctionString required

App Services Application ID

ProjectId string | Aws_CF_FunctionString required

Project Id for application services

Profile string | Aws_CF_FunctionString

The profile is defined in AWS Secret manager. See Secret Manager Profile setup.

DatabaseTrigger object
10 nested properties
ServiceId string | Aws_CF_FunctionString

The _id value of a linked MongoDB data source.

See Get a Data Source.

Database string | Aws_CF_FunctionString

The name of a database in the linked data source.

Collection string | Aws_CF_FunctionString

The name of a collection in the specified database. The trigger listens to events from this collection.

OperationTypes string[]

The type(s) of MongoDB change event that the trigger listens for.

minItems=1
Match object

A $match expression filters change events. The trigger will only fire if the expression evaluates to true for a given change event.

FullDocument boolean

If true, indicates that UPDATE change events should include the most current majority-committed version of the modified document in the fullDocument field.

Default: false
FullDocumentBeforeChange boolean

If true, indicates that UPDATE change events should include a snapshot of the modified document from immediately before the update was applied.

You must enable document preimages for your cluster to include these snapshots.

Default: false
SkipCatchupEvents boolean

If true, enabling the Trigger after it was disabled will not invoke events that occurred while the Trigger was disabled.

Default: false
TolerateResumeErrors boolean

If true, when this Trigger's resume token cannot be found in the cluster's oplog, the Trigger automatically resumes processing events at the next relevant change stream event. All change stream events from when the Trigger was suspended until the Trigger resumes execution do not have the Trigger fire for them.

Default: false
Unordered boolean

If true, event ordering is disabled and this Trigger can process events in parallel. If false, event ordering is enabled and the Trigger executes events serially.

AuthTrigger object
2 nested properties
OperationType string | Aws_CF_FunctionString required

The type of authentication event that the trigger listens for.

Providers string[] required

The type(s) of authentication provider that the trigger listens to.

minItems=1
ScheduleTrigger object
2 nested properties
Schedule string | Aws_CF_FunctionString

A cron expression that specifies when the trigger executes.

SkipcatchupEvents boolean

If true, enabling the trigger after it was disabled will not invoke events that occurred while the trigger was disabled.

Name string | Aws_CF_FunctionString

The trigger's name.

Type string | Aws_CF_FunctionString

The trigger's type.

Disabled boolean

If true, the trigger is disabled and does not listen for events or execute.

Default: false
FunctionId string | Aws_CF_FunctionString

The ID of the function that the trigger calls when it fires.

This value is the same as event_processors.FUNCTION.function_id. You can either define the value here or in event_processors.FUNCTION.function_id. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define function_id, the backend duplicates it to event_processors.FUNCTION.function_id.

FunctionName string | Aws_CF_FunctionString

The name of the function that the trigger calls when it fires, i.e. the function described by function_id.

This value is the same as event_processors.FUNCTION.function_name. You can either define the value here or in event_processors.FUNCTION.function_name. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define function_name, the backend duplicates it to event_processors.FUNCTION.function_name.

EventProcessors object
2 nested properties
FUNCTION object
1 nested properties
FuncConfig object
2 nested properties
FunctionId string | Aws_CF_FunctionString

The ID of the function that the trigger calls when it fires.

This value is the same as the root-level function_id. You can either define the value here or in function_id. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define event_processors.FUNCTION.function_id, the backend duplicates it to function_id.

FunctionName string | Aws_CF_FunctionString

The name of the function that the trigger calls when it fires, i.e. the function described by function_id.

This value is the same as the root-level function_name. You can either define the value here or in function_name. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define event_processors.FUNCTION.function_name, the backend duplicates it to function_name.

AWSEVENTBRIDGE object
1 nested properties
AWSConfig object
3 nested properties
AccountId string | Aws_CF_FunctionString

An AWS Account ID.

Region string | Aws_CF_FunctionString

An AWS region.

ExtendedJsonEnabled boolean

If true, event objects are serialized using EJSON.

Definitions

AuthConfig object
OperationType string | Aws_CF_FunctionString required

The type of authentication event that the trigger listens for.

Providers string[] required

The type(s) of authentication provider that the trigger listens to.

minItems=1
Event object
FUNCTION object
1 nested properties
FuncConfig object
2 nested properties
FunctionId string | Aws_CF_FunctionString

The ID of the function that the trigger calls when it fires.

This value is the same as the root-level function_id. You can either define the value here or in function_id. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define event_processors.FUNCTION.function_id, the backend duplicates it to function_id.

FunctionName string | Aws_CF_FunctionString

The name of the function that the trigger calls when it fires, i.e. the function described by function_id.

This value is the same as the root-level function_name. You can either define the value here or in function_name. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define event_processors.FUNCTION.function_name, the backend duplicates it to function_name.

AWSEVENTBRIDGE object
1 nested properties
AWSConfig object
3 nested properties
AccountId string | Aws_CF_FunctionString

An AWS Account ID.

Region string | Aws_CF_FunctionString

An AWS region.

ExtendedJsonEnabled boolean

If true, event objects are serialized using EJSON.

DatabaseConfig object
ServiceId string | Aws_CF_FunctionString

The _id value of a linked MongoDB data source.

See Get a Data Source.

Database string | Aws_CF_FunctionString

The name of a database in the linked data source.

Collection string | Aws_CF_FunctionString

The name of a collection in the specified database. The trigger listens to events from this collection.

OperationTypes string[]

The type(s) of MongoDB change event that the trigger listens for.

minItems=1
Match object

A $match expression filters change events. The trigger will only fire if the expression evaluates to true for a given change event.

FullDocument boolean

If true, indicates that UPDATE change events should include the most current majority-committed version of the modified document in the fullDocument field.

Default: false
FullDocumentBeforeChange boolean

If true, indicates that UPDATE change events should include a snapshot of the modified document from immediately before the update was applied.

You must enable document preimages for your cluster to include these snapshots.

Default: false
SkipCatchupEvents boolean

If true, enabling the Trigger after it was disabled will not invoke events that occurred while the Trigger was disabled.

Default: false
TolerateResumeErrors boolean

If true, when this Trigger's resume token cannot be found in the cluster's oplog, the Trigger automatically resumes processing events at the next relevant change stream event. All change stream events from when the Trigger was suspended until the Trigger resumes execution do not have the Trigger fire for them.

Default: false
Unordered boolean

If true, event ordering is disabled and this Trigger can process events in parallel. If false, event ordering is enabled and the Trigger executes events serially.

ScheduleConfig object
Schedule string | Aws_CF_FunctionString

A cron expression that specifies when the trigger executes.

SkipcatchupEvents boolean

If true, enabling the trigger after it was disabled will not invoke events that occurred while the trigger was disabled.