MongoDB Atlas v3.7.1, Mar 10 23

mongodbatlas.getEventTrigger

mongodbatlas.EventTrigger describe an Event Trigger.

Using getEventTrigger

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEventTrigger(args: GetEventTriggerArgs, opts?: InvokeOptions): Promise<GetEventTriggerResult>
function getEventTriggerOutput(args: GetEventTriggerOutputArgs, opts?: InvokeOptions): Output<GetEventTriggerResult>

def get_event_trigger(app_id: Optional[str] = None,
                      project_id: Optional[str] = None,
                      trigger_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetEventTriggerResult
def get_event_trigger_output(app_id: Optional[pulumi.Input[str]] = None,
                      project_id: Optional[pulumi.Input[str]] = None,
                      trigger_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetEventTriggerResult]

func LookupEventTrigger(ctx *Context, args *LookupEventTriggerArgs, opts ...InvokeOption) (*LookupEventTriggerResult, error)
func LookupEventTriggerOutput(ctx *Context, args *LookupEventTriggerOutputArgs, opts ...InvokeOption) LookupEventTriggerResultOutput

> Note: This function is named LookupEventTrigger in the Go SDK.

public static class GetEventTrigger 
{
    public static Task<GetEventTriggerResult> InvokeAsync(GetEventTriggerArgs args, InvokeOptions? opts = null)
    public static Output<GetEventTriggerResult> Invoke(GetEventTriggerInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEventTriggerResult> getEventTrigger(GetEventTriggerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: mongodbatlas:index/getEventTrigger:getEventTrigger
  arguments:
    # arguments dictionary

The following arguments are supported:

AppId string

The ObjectID of your application.

For more details on project_id and app_id see: https://www.mongodb.com/docs/atlas/app-services/admin/api/v3/#section/Project-and-Application-IDs

ProjectId string

The unique ID for the project to create the trigger.

TriggerId string

The unique ID of the trigger.

AppId string

The ObjectID of your application.

For more details on project_id and app_id see: https://www.mongodb.com/docs/atlas/app-services/admin/api/v3/#section/Project-and-Application-IDs

ProjectId string

The unique ID for the project to create the trigger.

TriggerId string

The unique ID of the trigger.

appId String

The ObjectID of your application.

For more details on project_id and app_id see: https://www.mongodb.com/docs/atlas/app-services/admin/api/v3/#section/Project-and-Application-IDs

projectId String

The unique ID for the project to create the trigger.

triggerId String

The unique ID of the trigger.

appId string

The ObjectID of your application.

For more details on project_id and app_id see: https://www.mongodb.com/docs/atlas/app-services/admin/api/v3/#section/Project-and-Application-IDs

projectId string

The unique ID for the project to create the trigger.

triggerId string

The unique ID of the trigger.

app_id str

The ObjectID of your application.

For more details on project_id and app_id see: https://www.mongodb.com/docs/atlas/app-services/admin/api/v3/#section/Project-and-Application-IDs

project_id str

The unique ID for the project to create the trigger.

trigger_id str

The unique ID of the trigger.

appId String

The ObjectID of your application.

For more details on project_id and app_id see: https://www.mongodb.com/docs/atlas/app-services/admin/api/v3/#section/Project-and-Application-IDs

projectId String

The unique ID for the project to create the trigger.

triggerId String

The unique ID of the trigger.

getEventTrigger Result

The following output properties are available:

AppId string

ConfigCollection string

The name of the MongoDB collection that the trigger watches for change events.

ConfigDatabase string

The name of the MongoDB database that contains the watched collection.

ConfigFullDocument bool

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

ConfigFullDocumentBefore bool

ConfigMatch string

A $match expression document that MongoDB Realm includes in the underlying change stream pipeline for the trigger.

ConfigOperationType string

The authentication operation type to listen for.

ConfigOperationTypes List<string>

The database event operation types to listen for.

ConfigProject string

A $project expression document that Realm uses to filter the fields that appear in change event objects.

ConfigProviders List<string>

A list of one or more authentication provider id values. The trigger will only listen for authentication events produced by these providers.

ConfigSchedule string

A cron expression that defines the trigger schedule.

ConfigScheduleType string

ConfigServiceId string

The ID of the MongoDB Service associated with the trigger.

Disabled bool

Status of a trigger.

EventProcessors List<GetEventTriggerEventProcessor>

An object where each field name is an event processor ID and each value is an object that configures its corresponding event processor.

event_processors.0.aws_eventbridge.config_account_id - AWS Account ID.
event_processors.0.aws_eventbridge.config_region - Region of AWS Account.

FunctionId string

The ID of the function associated with the trigger.

FunctionName string

The name of the function associated with the trigger.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the trigger.

ProjectId string

TriggerId string

Type string

The type of the trigger.

Unordered bool

Only Available for Database Triggers. If true, event ordering is disabled and this trigger can process events in parallel. If false, event ordering is enabled and the trigger executes serially.

AppId string

ConfigCollection string

The name of the MongoDB collection that the trigger watches for change events.

ConfigDatabase string

The name of the MongoDB database that contains the watched collection.

ConfigFullDocument bool

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

ConfigFullDocumentBefore bool

ConfigMatch string

A $match expression document that MongoDB Realm includes in the underlying change stream pipeline for the trigger.

ConfigOperationType string

The authentication operation type to listen for.

ConfigOperationTypes []string

The database event operation types to listen for.

ConfigProject string

A $project expression document that Realm uses to filter the fields that appear in change event objects.

ConfigProviders []string

A list of one or more authentication provider id values. The trigger will only listen for authentication events produced by these providers.

ConfigSchedule string

A cron expression that defines the trigger schedule.

ConfigScheduleType string

ConfigServiceId string

The ID of the MongoDB Service associated with the trigger.

Disabled bool

Status of a trigger.

EventProcessors []GetEventTriggerEventProcessor

An object where each field name is an event processor ID and each value is an object that configures its corresponding event processor.

event_processors.0.aws_eventbridge.config_account_id - AWS Account ID.
event_processors.0.aws_eventbridge.config_region - Region of AWS Account.

FunctionId string

The ID of the function associated with the trigger.

FunctionName string

The name of the function associated with the trigger.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the trigger.

ProjectId string

TriggerId string

Type string

The type of the trigger.

Unordered bool

Only Available for Database Triggers. If true, event ordering is disabled and this trigger can process events in parallel. If false, event ordering is enabled and the trigger executes serially.

appId String

configCollection String

The name of the MongoDB collection that the trigger watches for change events.

configDatabase String

The name of the MongoDB database that contains the watched collection.

configFullDocument Boolean

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

configFullDocumentBefore Boolean

configMatch String

A $match expression document that MongoDB Realm includes in the underlying change stream pipeline for the trigger.

configOperationType String

The authentication operation type to listen for.

configOperationTypes List<String>

The database event operation types to listen for.

configProject String

A $project expression document that Realm uses to filter the fields that appear in change event objects.

configProviders List<String>

A list of one or more authentication provider id values. The trigger will only listen for authentication events produced by these providers.

configSchedule String

A cron expression that defines the trigger schedule.

configScheduleType String

configServiceId String

The ID of the MongoDB Service associated with the trigger.

disabled Boolean

Status of a trigger.

eventProcessors List<GetEventTriggerEventProcessor>

An object where each field name is an event processor ID and each value is an object that configures its corresponding event processor.

event_processors.0.aws_eventbridge.config_account_id - AWS Account ID.
event_processors.0.aws_eventbridge.config_region - Region of AWS Account.

functionId String

The ID of the function associated with the trigger.

functionName String

The name of the function associated with the trigger.

id String

The provider-assigned unique ID for this managed resource.

name String

The name of the trigger.

projectId String

triggerId String

type String

The type of the trigger.

unordered Boolean

Only Available for Database Triggers. If true, event ordering is disabled and this trigger can process events in parallel. If false, event ordering is enabled and the trigger executes serially.

appId string

configCollection string

The name of the MongoDB collection that the trigger watches for change events.

configDatabase string

The name of the MongoDB database that contains the watched collection.

configFullDocument boolean

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

configFullDocumentBefore boolean

configMatch string

A $match expression document that MongoDB Realm includes in the underlying change stream pipeline for the trigger.

configOperationType string

The authentication operation type to listen for.

configOperationTypes string[]

The database event operation types to listen for.

configProject string

A $project expression document that Realm uses to filter the fields that appear in change event objects.

configProviders string[]

A list of one or more authentication provider id values. The trigger will only listen for authentication events produced by these providers.

configSchedule string

A cron expression that defines the trigger schedule.

configScheduleType string

configServiceId string

The ID of the MongoDB Service associated with the trigger.

disabled boolean

Status of a trigger.

eventProcessors GetEventTriggerEventProcessor[]

An object where each field name is an event processor ID and each value is an object that configures its corresponding event processor.

event_processors.0.aws_eventbridge.config_account_id - AWS Account ID.
event_processors.0.aws_eventbridge.config_region - Region of AWS Account.

functionId string

The ID of the function associated with the trigger.

functionName string

The name of the function associated with the trigger.

id string

The provider-assigned unique ID for this managed resource.

name string

The name of the trigger.

projectId string

triggerId string

type string

The type of the trigger.

unordered boolean

Only Available for Database Triggers. If true, event ordering is disabled and this trigger can process events in parallel. If false, event ordering is enabled and the trigger executes serially.

app_id str

config_collection str

The name of the MongoDB collection that the trigger watches for change events.

config_database str

The name of the MongoDB database that contains the watched collection.

config_full_document bool

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

config_full_document_before bool

config_match str

A $match expression document that MongoDB Realm includes in the underlying change stream pipeline for the trigger.

config_operation_type str

The authentication operation type to listen for.

config_operation_types Sequence[str]

The database event operation types to listen for.

config_project str

A $project expression document that Realm uses to filter the fields that appear in change event objects.

config_providers Sequence[str]

A list of one or more authentication provider id values. The trigger will only listen for authentication events produced by these providers.

config_schedule str

A cron expression that defines the trigger schedule.

config_schedule_type str

config_service_id str

The ID of the MongoDB Service associated with the trigger.

disabled bool

Status of a trigger.

event_processors Sequence[GetEventTriggerEventProcessor]

An object where each field name is an event processor ID and each value is an object that configures its corresponding event processor.

event_processors.0.aws_eventbridge.config_account_id - AWS Account ID.
event_processors.0.aws_eventbridge.config_region - Region of AWS Account.

function_id str

The ID of the function associated with the trigger.

function_name str

The name of the function associated with the trigger.

id str

The provider-assigned unique ID for this managed resource.

name str

The name of the trigger.

project_id str

trigger_id str

type str

The type of the trigger.

unordered bool

Only Available for Database Triggers. If true, event ordering is disabled and this trigger can process events in parallel. If false, event ordering is enabled and the trigger executes serially.

appId String

configCollection String

The name of the MongoDB collection that the trigger watches for change events.

configDatabase String

The name of the MongoDB database that contains the watched collection.

configFullDocument Boolean

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

configFullDocumentBefore Boolean

configMatch String

A $match expression document that MongoDB Realm includes in the underlying change stream pipeline for the trigger.

configOperationType String

The authentication operation type to listen for.

configOperationTypes List<String>

The database event operation types to listen for.

configProject String

A $project expression document that Realm uses to filter the fields that appear in change event objects.

configProviders List<String>

A list of one or more authentication provider id values. The trigger will only listen for authentication events produced by these providers.

configSchedule String

A cron expression that defines the trigger schedule.

configScheduleType String

configServiceId String

The ID of the MongoDB Service associated with the trigger.

disabled Boolean

Status of a trigger.

eventProcessors List<Property Map>

An object where each field name is an event processor ID and each value is an object that configures its corresponding event processor.

event_processors.0.aws_eventbridge.config_account_id - AWS Account ID.
event_processors.0.aws_eventbridge.config_region - Region of AWS Account.

functionId String

The ID of the function associated with the trigger.

functionName String

The name of the function associated with the trigger.

id String

The provider-assigned unique ID for this managed resource.

name String

The name of the trigger.

projectId String

triggerId String

type String

The type of the trigger.

unordered Boolean

Only Available for Database Triggers. If true, event ordering is disabled and this trigger can process events in parallel. If false, event ordering is enabled and the trigger executes serially.