1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getEventTriggers
MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi

mongodbatlas.getEventTriggers

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi

    mongodbatlas.getEventTriggers describe all Event Triggers.

    Using getEventTriggers

    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 getEventTriggers(args: GetEventTriggersArgs, opts?: InvokeOptions): Promise<GetEventTriggersResult>
    function getEventTriggersOutput(args: GetEventTriggersOutputArgs, opts?: InvokeOptions): Output<GetEventTriggersResult>
    def get_event_triggers(app_id: Optional[str] = None,
                           project_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetEventTriggersResult
    def get_event_triggers_output(app_id: Optional[pulumi.Input[str]] = None,
                           project_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetEventTriggersResult]
    func LookupEventTriggers(ctx *Context, args *LookupEventTriggersArgs, opts ...InvokeOption) (*LookupEventTriggersResult, error)
    func LookupEventTriggersOutput(ctx *Context, args *LookupEventTriggersOutputArgs, opts ...InvokeOption) LookupEventTriggersResultOutput

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

    public static class GetEventTriggers 
    {
        public static Task<GetEventTriggersResult> InvokeAsync(GetEventTriggersArgs args, InvokeOptions? opts = null)
        public static Output<GetEventTriggersResult> Invoke(GetEventTriggersInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEventTriggersResult> getEventTriggers(GetEventTriggersArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: mongodbatlas:index/getEventTriggers:getEventTriggers
      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 get all event triggers.
    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 get all event triggers.
    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 get all event triggers.
    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 get all event triggers.
    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 get all event triggers.
    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 get all event triggers.

    getEventTriggers Result

    The following output properties are available:

    AppId string
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    Results List<GetEventTriggersResult>
    A list where each represents a Event Trigger.
    AppId string
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    Results []GetEventTriggersResult
    A list where each represents a Event Trigger.
    appId String
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    results List<GetEventTriggersResult>
    A list where each represents a Event Trigger.
    appId string
    id string
    The provider-assigned unique ID for this managed resource.
    projectId string
    results GetEventTriggersResult[]
    A list where each represents a Event Trigger.
    app_id str
    id str
    The provider-assigned unique ID for this managed resource.
    project_id str
    results Sequence[GetEventTriggersResult]
    A list where each represents a Event Trigger.
    appId String
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    results List<Property Map>
    A list where each represents a Event Trigger.

    Supporting Types

    GetEventTriggersResult

    ConfigCollection string
    The name of the MongoDB collection that the trigger watches for change events.
    ConfigDatabase string
    The name of the MongoDB database to watch.
    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<GetEventTriggersResultEventProcessor>
    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.
    Name string
    The name of the trigger.
    TriggerId string
    Type string
    The type of the trigger. Possible Values: DATABASE, AUTHENTICATION
    Unordered bool
    Sort order for DATABASE type.
    ConfigCollection string
    The name of the MongoDB collection that the trigger watches for change events.
    ConfigDatabase string
    The name of the MongoDB database to watch.
    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 []GetEventTriggersResultEventProcessor
    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.
    Name string
    The name of the trigger.
    TriggerId string
    Type string
    The type of the trigger. Possible Values: DATABASE, AUTHENTICATION
    Unordered bool
    Sort order for DATABASE type.
    configCollection String
    The name of the MongoDB collection that the trigger watches for change events.
    configDatabase String
    The name of the MongoDB database to watch.
    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<GetEventTriggersResultEventProcessor>
    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.
    name String
    The name of the trigger.
    triggerId String
    type String
    The type of the trigger. Possible Values: DATABASE, AUTHENTICATION
    unordered Boolean
    Sort order for DATABASE type.
    configCollection string
    The name of the MongoDB collection that the trigger watches for change events.
    configDatabase string
    The name of the MongoDB database to watch.
    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 GetEventTriggersResultEventProcessor[]
    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.
    name string
    The name of the trigger.
    triggerId string
    type string
    The type of the trigger. Possible Values: DATABASE, AUTHENTICATION
    unordered boolean
    Sort order for DATABASE type.
    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 to watch.
    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[GetEventTriggersResultEventProcessor]
    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.
    name str
    The name of the trigger.
    trigger_id str
    type str
    The type of the trigger. Possible Values: DATABASE, AUTHENTICATION
    unordered bool
    Sort order for DATABASE type.
    configCollection String
    The name of the MongoDB collection that the trigger watches for change events.
    configDatabase String
    The name of the MongoDB database to watch.
    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.
    name String
    The name of the trigger.
    triggerId String
    type String
    The type of the trigger. Possible Values: DATABASE, AUTHENTICATION
    unordered Boolean
    Sort order for DATABASE type.

    GetEventTriggersResultEventProcessor

    GetEventTriggersResultEventProcessorAwsEventbridge

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi