1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getFederatedQueryLimits
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

mongodbatlas.getFederatedQueryLimits

Explore with Pulumi AI

# Data Source: mongodbatlas.getFederatedQueryLimits

mongodbatlas.getFederatedQueryLimits provides a Federated Database Instance Query Limits 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

S

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

const test = mongodbatlas.getFederatedQueryLimits({
    projectId: "PROJECT_ID",
    tenantName: "FEDERATED_DATABASE_INSTANCE_NAME",
});
Copy
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.get_federated_query_limits(project_id="PROJECT_ID",
    tenant_name="FEDERATED_DATABASE_INSTANCE_NAME")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.LookupFederatedQueryLimits(ctx, &mongodbatlas.LookupFederatedQueryLimitsArgs{
			ProjectId:  "PROJECT_ID",
			TenantName: "FEDERATED_DATABASE_INSTANCE_NAME",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

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

});
Copy
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.GetFederatedQueryLimitsArgs;
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.getFederatedQueryLimits(GetFederatedQueryLimitsArgs.builder()
            .projectId("PROJECT_ID")
            .tenantName("FEDERATED_DATABASE_INSTANCE_NAME")
            .build());

    }
}
Copy
variables:
  test:
    fn::invoke:
      function: mongodbatlas:getFederatedQueryLimits
      arguments:
        projectId: PROJECT_ID
        tenantName: FEDERATED_DATABASE_INSTANCE_NAME
Copy

Using getFederatedQueryLimits

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 getFederatedQueryLimits(args: GetFederatedQueryLimitsArgs, opts?: InvokeOptions): Promise<GetFederatedQueryLimitsResult>
function getFederatedQueryLimitsOutput(args: GetFederatedQueryLimitsOutputArgs, opts?: InvokeOptions): Output<GetFederatedQueryLimitsResult>
Copy
def get_federated_query_limits(project_id: Optional[str] = None,
                               tenant_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetFederatedQueryLimitsResult
def get_federated_query_limits_output(project_id: Optional[pulumi.Input[str]] = None,
                               tenant_name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetFederatedQueryLimitsResult]
Copy
func LookupFederatedQueryLimits(ctx *Context, args *LookupFederatedQueryLimitsArgs, opts ...InvokeOption) (*LookupFederatedQueryLimitsResult, error)
func LookupFederatedQueryLimitsOutput(ctx *Context, args *LookupFederatedQueryLimitsOutputArgs, opts ...InvokeOption) LookupFederatedQueryLimitsResultOutput
Copy

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

public static class GetFederatedQueryLimits 
{
    public static Task<GetFederatedQueryLimitsResult> InvokeAsync(GetFederatedQueryLimitsArgs args, InvokeOptions? opts = null)
    public static Output<GetFederatedQueryLimitsResult> Invoke(GetFederatedQueryLimitsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFederatedQueryLimitsResult> getFederatedQueryLimits(GetFederatedQueryLimitsArgs args, InvokeOptions options)
public static Output<GetFederatedQueryLimitsResult> getFederatedQueryLimits(GetFederatedQueryLimitsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: mongodbatlas:index/getFederatedQueryLimits:getFederatedQueryLimits
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ProjectId This property is required. string
The unique ID for the project to create a Federated Database Instance.
TenantName This property is required. string
Name of the Atlas Federated Database Instance.
ProjectId This property is required. string
The unique ID for the project to create a Federated Database Instance.
TenantName This property is required. string
Name of the Atlas Federated Database Instance.
projectId This property is required. String
The unique ID for the project to create a Federated Database Instance.
tenantName This property is required. String
Name of the Atlas Federated Database Instance.
projectId This property is required. string
The unique ID for the project to create a Federated Database Instance.
tenantName This property is required. string
Name of the Atlas Federated Database Instance.
project_id This property is required. str
The unique ID for the project to create a Federated Database Instance.
tenant_name This property is required. str
Name of the Atlas Federated Database Instance.
projectId This property is required. String
The unique ID for the project to create a Federated Database Instance.
tenantName This property is required. String
Name of the Atlas Federated Database Instance.

getFederatedQueryLimits Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
ProjectId string
Results List<GetFederatedQueryLimitsResult>
Includes Federated Database instance query limits for each item detailed in the results array section.
TenantName string
Id string
The provider-assigned unique ID for this managed resource.
ProjectId string
Results []GetFederatedQueryLimitsResult
Includes Federated Database instance query limits for each item detailed in the results array section.
TenantName string
id String
The provider-assigned unique ID for this managed resource.
projectId String
results List<GetFederatedQueryLimitsResult>
Includes Federated Database instance query limits for each item detailed in the results array section.
tenantName String
id string
The provider-assigned unique ID for this managed resource.
projectId string
results GetFederatedQueryLimitsResult[]
Includes Federated Database instance query limits for each item detailed in the results array section.
tenantName string
id str
The provider-assigned unique ID for this managed resource.
project_id str
results Sequence[GetFederatedQueryLimitsResult]
Includes Federated Database instance query limits for each item detailed in the results array section.
tenant_name str
id String
The provider-assigned unique ID for this managed resource.
projectId String
results List<Property Map>
Includes Federated Database instance query limits for each item detailed in the results array section.
tenantName String

Supporting Types

GetFederatedQueryLimitsResult

CurrentUsage This property is required. int
Amount that indicates the current usage of the limit.
DefaultLimit This property is required. 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.
LastModifiedDate This property is required. string
LimitName This property is required. string
MaximumLimit This property is required. int
OverrunPolicy This property is required. string
ProjectId This property is required. string
The unique ID for the project to create a Federated Database Instance.
TenantName This property is required. string
Name of the Atlas Federated Database Instance.
Value This property is required. int
CurrentUsage This property is required. int
Amount that indicates the current usage of the limit.
DefaultLimit This property is required. 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.
LastModifiedDate This property is required. string
LimitName This property is required. string
MaximumLimit This property is required. int
OverrunPolicy This property is required. string
ProjectId This property is required. string
The unique ID for the project to create a Federated Database Instance.
TenantName This property is required. string
Name of the Atlas Federated Database Instance.
Value This property is required. int
currentUsage This property is required. Integer
Amount that indicates the current usage of the limit.
defaultLimit This property is required. 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.
lastModifiedDate This property is required. String
limitName This property is required. String
maximumLimit This property is required. Integer
overrunPolicy This property is required. String
projectId This property is required. String
The unique ID for the project to create a Federated Database Instance.
tenantName This property is required. String
Name of the Atlas Federated Database Instance.
value This property is required. Integer
currentUsage This property is required. number
Amount that indicates the current usage of the limit.
defaultLimit This property is required. 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.
lastModifiedDate This property is required. string
limitName This property is required. string
maximumLimit This property is required. number
overrunPolicy This property is required. string
projectId This property is required. string
The unique ID for the project to create a Federated Database Instance.
tenantName This property is required. string
Name of the Atlas Federated Database Instance.
value This property is required. number
current_usage This property is required. int
Amount that indicates the current usage of the limit.
default_limit This property is required. 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.
last_modified_date This property is required. str
limit_name This property is required. str
maximum_limit This property is required. int
overrun_policy This property is required. str
project_id This property is required. str
The unique ID for the project to create a Federated Database Instance.
tenant_name This property is required. str
Name of the Atlas Federated Database Instance.
value This property is required. int
currentUsage This property is required. Number
Amount that indicates the current usage of the limit.
defaultLimit This property is required. 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.
lastModifiedDate This property is required. String
limitName This property is required. String
maximumLimit This property is required. Number
overrunPolicy This property is required. String
projectId This property is required. String
The unique ID for the project to create a Federated Database Instance.
tenantName This property is required. String
Name of the Atlas Federated Database Instance.
value This property is required. Number

Package Details

Repository
MongoDB Atlas pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.