1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getFederatedQueryLimit
Viewing docs for MongoDB Atlas v4.5.0
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

mongodbatlas.getFederatedQueryLimit

mongodbatlas logo
Viewing docs for MongoDB Atlas v4.5.0
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

    mongodbatlas.FederatedQueryLimit provides a Federated Database Instance Query Limit data source. To learn more about Atlas Data Federation see https://www.mongodb.com/docs/atlas/data-federation/overview/.

    NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const test = mongodbatlas.getFederatedQueryLimit({
    projectId: "PROJECT_ID",
    tenantName: "FEDERATED_DATABASE_INSTANCE_NAME",
    limitName: "LIMIT_NAME",
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.get_federated_query_limit(project_id="PROJECT_ID",
    tenant_name="FEDERATED_DATABASE_INSTANCE_NAME",
    limit_name="LIMIT_NAME")

    package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v4/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.LookupFederatedQueryLimit(ctx, &mongodbatlas.LookupFederatedQueryLimitArgs{
			ProjectId:  "PROJECT_ID",
			TenantName: "FEDERATED_DATABASE_INSTANCE_NAME",
			LimitName:  "LIMIT_NAME",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var test = Mongodbatlas.GetFederatedQueryLimit.Invoke(new()
    {
        ProjectId = "PROJECT_ID",
        TenantName = "FEDERATED_DATABASE_INSTANCE_NAME",
        LimitName = "LIMIT_NAME",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetFederatedQueryLimitArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var test = MongodbatlasFunctions.getFederatedQueryLimit(GetFederatedQueryLimitArgs.builder()
            .projectId("PROJECT_ID")
            .tenantName("FEDERATED_DATABASE_INSTANCE_NAME")
            .limitName("LIMIT_NAME")
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      function: mongodbatlas:getFederatedQueryLimit
      arguments:
        projectId: PROJECT_ID
        tenantName: FEDERATED_DATABASE_INSTANCE_NAME
        limitName: LIMIT_NAME

    Using getFederatedQueryLimit

    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 getFederatedQueryLimit(args: GetFederatedQueryLimitArgs, opts?: InvokeOptions): Promise<GetFederatedQueryLimitResult>
function getFederatedQueryLimitOutput(args: GetFederatedQueryLimitOutputArgs, opts?: InvokeOptions): Output<GetFederatedQueryLimitResult>
    def get_federated_query_limit(limit_name: Optional[str] = None,
                              project_id: Optional[str] = None,
                              tenant_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetFederatedQueryLimitResult
def get_federated_query_limit_output(limit_name: Optional[pulumi.Input[str]] = None,
                              project_id: Optional[pulumi.Input[str]] = None,
                              tenant_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetFederatedQueryLimitResult]
    func LookupFederatedQueryLimit(ctx *Context, args *LookupFederatedQueryLimitArgs, opts ...InvokeOption) (*LookupFederatedQueryLimitResult, error)
func LookupFederatedQueryLimitOutput(ctx *Context, args *LookupFederatedQueryLimitOutputArgs, opts ...InvokeOption) LookupFederatedQueryLimitResultOutput

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

    public static class GetFederatedQueryLimit 
{
    public static Task<GetFederatedQueryLimitResult> InvokeAsync(GetFederatedQueryLimitArgs args, InvokeOptions? opts = null)
    public static Output<GetFederatedQueryLimitResult> Invoke(GetFederatedQueryLimitInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFederatedQueryLimitResult> getFederatedQueryLimit(GetFederatedQueryLimitArgs args, InvokeOptions options)
public static Output<GetFederatedQueryLimitResult> getFederatedQueryLimit(GetFederatedQueryLimitArgs args, InvokeOptions options)

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

    The following arguments are supported:

    LimitName string
    String enum that indicates whether the identity provider is active or not. Accepted values are:

    • bytesProcessed.query: Limit on the number of bytes processed during a single data federation query.
    • bytesProcessed.daily: Limit on the number of bytes processed for the data federation instance for the current day.
    • bytesProcessed.weekly: Limit on the number of bytes processed for the data federation instance for the current week.
    • bytesProcessed.monthly: Limit on the number of bytes processed for the data federation instance for the current month.
    ProjectId string
    The unique ID for the project to create a Federated Database Instance.
    TenantName string
    Name of the Atlas Federated Database Instance.
    LimitName string
    String enum that indicates whether the identity provider is active or not. Accepted values are:

    • bytesProcessed.query: Limit on the number of bytes processed during a single data federation query.
    • bytesProcessed.daily: Limit on the number of bytes processed for the data federation instance for the current day.
    • bytesProcessed.weekly: Limit on the number of bytes processed for the data federation instance for the current week.
    • bytesProcessed.monthly: Limit on the number of bytes processed for the data federation instance for the current month.
    ProjectId string
    The unique ID for the project to create a Federated Database Instance.
    TenantName string
    Name of the Atlas Federated Database Instance.
    limitName String
    String enum that indicates whether the identity provider is active or not. Accepted values are:

    • bytesProcessed.query: Limit on the number of bytes processed during a single data federation query.
    • bytesProcessed.daily: Limit on the number of bytes processed for the data federation instance for the current day.
    • bytesProcessed.weekly: Limit on the number of bytes processed for the data federation instance for the current week.
    • bytesProcessed.monthly: Limit on the number of bytes processed for the data federation instance for the current month.
    projectId String
    The unique ID for the project to create a Federated Database Instance.
    tenantName String
    Name of the Atlas Federated Database Instance.
    limitName string
    String enum that indicates whether the identity provider is active or not. Accepted values are:

    • bytesProcessed.query: Limit on the number of bytes processed during a single data federation query.
    • bytesProcessed.daily: Limit on the number of bytes processed for the data federation instance for the current day.
    • bytesProcessed.weekly: Limit on the number of bytes processed for the data federation instance for the current week.
    • bytesProcessed.monthly: Limit on the number of bytes processed for the data federation instance for the current month.
    projectId string
    The unique ID for the project to create a Federated Database Instance.
    tenantName string
    Name of the Atlas Federated Database Instance.
    limit_name str
    String enum that indicates whether the identity provider is active or not. Accepted values are:

    • bytesProcessed.query: Limit on the number of bytes processed during a single data federation query.
    • bytesProcessed.daily: Limit on the number of bytes processed for the data federation instance for the current day.
    • bytesProcessed.weekly: Limit on the number of bytes processed for the data federation instance for the current week.
    • bytesProcessed.monthly: Limit on the number of bytes processed for the data federation instance for the current month.
    project_id str
    The unique ID for the project to create a Federated Database Instance.
    tenant_name str
    Name of the Atlas Federated Database Instance.
    limitName String
    String enum that indicates whether the identity provider is active or not. Accepted values are:

    • bytesProcessed.query: Limit on the number of bytes processed during a single data federation query.
    • bytesProcessed.daily: Limit on the number of bytes processed for the data federation instance for the current day.
    • bytesProcessed.weekly: Limit on the number of bytes processed for the data federation instance for the current week.
    • bytesProcessed.monthly: Limit on the number of bytes processed for the data federation instance for the current month.
    projectId String
    The unique ID for the project to create a Federated Database Instance.
    tenantName String
    Name of the Atlas Federated Database Instance.

    getFederatedQueryLimit Result

    The following output properties are available:

    CurrentUsage int
    Amount that indicates the current usage of the limit.
    DefaultLimit int
    Default value of the limit.

    • lastModifiedDate - Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.
    • maximumLimit - Maximum value of the limit.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedDate string
    LimitName string
    MaximumLimit int
    OverrunPolicy string
    ProjectId string
    TenantName string
    Value int
    CurrentUsage int
    Amount that indicates the current usage of the limit.
    DefaultLimit int
    Default value of the limit.

    • lastModifiedDate - Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.
    • maximumLimit - Maximum value of the limit.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedDate string
    LimitName string
    MaximumLimit int
    OverrunPolicy string
    ProjectId string
    TenantName string
    Value int
    currentUsage Integer
    Amount that indicates the current usage of the limit.
    defaultLimit Integer
    Default value of the limit.

    • lastModifiedDate - Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.
    • maximumLimit - Maximum value of the limit.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedDate String
    limitName String
    maximumLimit Integer
    overrunPolicy String
    projectId String
    tenantName String
    value Integer
    currentUsage number
    Amount that indicates the current usage of the limit.
    defaultLimit number
    Default value of the limit.

    • lastModifiedDate - Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.
    • maximumLimit - Maximum value of the limit.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedDate string
    limitName string
    maximumLimit number
    overrunPolicy string
    projectId string
    tenantName string
    value number
    current_usage int
    Amount that indicates the current usage of the limit.
    default_limit int
    Default value of the limit.

    • lastModifiedDate - Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.
    • maximumLimit - Maximum value of the limit.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_date str
    limit_name str
    maximum_limit int
    overrun_policy str
    project_id str
    tenant_name str
    value int
    currentUsage Number
    Amount that indicates the current usage of the limit.
    defaultLimit Number
    Default value of the limit.

    • lastModifiedDate - Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.
    • maximumLimit - Maximum value of the limit.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedDate String
    limitName String
    maximumLimit Number
    overrunPolicy String
    projectId String
    tenantName String
    value Number

    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
    Viewing docs for MongoDB Atlas v4.5.0
    published on Thursday, Mar 12, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-mongodbatlas
      Try Pulumi Cloud free. Your team will thank you.