Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. FederatedQueryLimit
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.FederatedQueryLimit

Explore with Pulumi AI

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

# Resource: mongodbatlas.FederatedQueryLimit

mongodbatlas.FederatedQueryLimit provides a Federated Database Instance Query Limits resource. 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 = new mongodbatlas.FederatedQueryLimit("test", {
    projectId: "64707f06c519c20c3a2b1b03",
    tenantName: "FederatedDatabseInstance0",
    limitName: "bytesProcessed.weekly",
    overrunPolicy: "BLOCK",
    value: 5147483648,
});
Copy
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.FederatedQueryLimit("test",
    project_id="64707f06c519c20c3a2b1b03",
    tenant_name="FederatedDatabseInstance0",
    limit_name="bytesProcessed.weekly",
    overrun_policy="BLOCK",
    value=5147483648)
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.NewFederatedQueryLimit(ctx, "test", &mongodbatlas.FederatedQueryLimitArgs{
			ProjectId:     pulumi.String("64707f06c519c20c3a2b1b03"),
			TenantName:    pulumi.String("FederatedDatabseInstance0"),
			LimitName:     pulumi.String("bytesProcessed.weekly"),
			OverrunPolicy: pulumi.String("BLOCK"),
			Value:         pulumi.Int(5147483648),
		})
		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 = new Mongodbatlas.FederatedQueryLimit("test", new()
    {
        ProjectId = "64707f06c519c20c3a2b1b03",
        TenantName = "FederatedDatabseInstance0",
        LimitName = "bytesProcessed.weekly",
        OverrunPolicy = "BLOCK",
        Value = 5147483648,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.FederatedQueryLimit;
import com.pulumi.mongodbatlas.FederatedQueryLimitArgs;
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) {
        var test = new FederatedQueryLimit("test", FederatedQueryLimitArgs.builder()
            .projectId("64707f06c519c20c3a2b1b03")
            .tenantName("FederatedDatabseInstance0")
            .limitName("bytesProcessed.weekly")
            .overrunPolicy("BLOCK")
            .value(5147483648)
            .build());

    }
}
Copy
resources:
  test:
    type: mongodbatlas:FederatedQueryLimit
    properties:
      projectId: 64707f06c519c20c3a2b1b03
      tenantName: FederatedDatabseInstance0
      limitName: bytesProcessed.weekly
      overrunPolicy: BLOCK
      value: 5.147483648e+09
Copy

Create FederatedQueryLimit Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new FederatedQueryLimit(name: string, args: FederatedQueryLimitArgs, opts?: CustomResourceOptions);
@overload
def FederatedQueryLimit(resource_name: str,
                        args: FederatedQueryLimitArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def FederatedQueryLimit(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        limit_name: Optional[str] = None,
                        overrun_policy: Optional[str] = None,
                        project_id: Optional[str] = None,
                        tenant_name: Optional[str] = None,
                        value: Optional[int] = None,
                        default_limit: Optional[int] = None,
                        maximum_limit: Optional[int] = None)
func NewFederatedQueryLimit(ctx *Context, name string, args FederatedQueryLimitArgs, opts ...ResourceOption) (*FederatedQueryLimit, error)
public FederatedQueryLimit(string name, FederatedQueryLimitArgs args, CustomResourceOptions? opts = null)
public FederatedQueryLimit(String name, FederatedQueryLimitArgs args)
public FederatedQueryLimit(String name, FederatedQueryLimitArgs args, CustomResourceOptions options)

type: mongodbatlas:FederatedQueryLimit
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. FederatedQueryLimitArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. FederatedQueryLimitArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. FederatedQueryLimitArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. FederatedQueryLimitArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FederatedQueryLimitArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var federatedQueryLimitResource = new Mongodbatlas.FederatedQueryLimit("federatedQueryLimitResource", new()
{
    LimitName = "string",
    OverrunPolicy = "string",
    ProjectId = "string",
    TenantName = "string",
    Value = 0,
    DefaultLimit = 0,
    MaximumLimit = 0,
});
Copy
example, err := mongodbatlas.NewFederatedQueryLimit(ctx, "federatedQueryLimitResource", &mongodbatlas.FederatedQueryLimitArgs{
	LimitName:     pulumi.String("string"),
	OverrunPolicy: pulumi.String("string"),
	ProjectId:     pulumi.String("string"),
	TenantName:    pulumi.String("string"),
	Value:         pulumi.Int(0),
	DefaultLimit:  pulumi.Int(0),
	MaximumLimit:  pulumi.Int(0),
})
Copy
var federatedQueryLimitResource = new FederatedQueryLimit("federatedQueryLimitResource", FederatedQueryLimitArgs.builder()
    .limitName("string")
    .overrunPolicy("string")
    .projectId("string")
    .tenantName("string")
    .value(0)
    .defaultLimit(0)
    .maximumLimit(0)
    .build());
Copy
federated_query_limit_resource = mongodbatlas.FederatedQueryLimit("federatedQueryLimitResource",
    limit_name="string",
    overrun_policy="string",
    project_id="string",
    tenant_name="string",
    value=0,
    default_limit=0,
    maximum_limit=0)
Copy
const federatedQueryLimitResource = new mongodbatlas.FederatedQueryLimit("federatedQueryLimitResource", {
    limitName: "string",
    overrunPolicy: "string",
    projectId: "string",
    tenantName: "string",
    value: 0,
    defaultLimit: 0,
    maximumLimit: 0,
});
Copy
type: mongodbatlas:FederatedQueryLimit
properties:
    defaultLimit: 0
    limitName: string
    maximumLimit: 0
    overrunPolicy: string
    projectId: string
    tenantName: string
    value: 0
Copy

FederatedQueryLimit Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The FederatedQueryLimit resource accepts the following input properties:

LimitName This property is required. 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.
OverrunPolicy This property is required. string
String enum that identifies action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit. Accepted values are "BLOCK" OR "BLOCK_AND_KILL"
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
Amount to set the limit to.
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.
MaximumLimit int
LimitName This property is required. 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.
OverrunPolicy This property is required. string
String enum that identifies action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit. Accepted values are "BLOCK" OR "BLOCK_AND_KILL"
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
Amount to set the limit to.
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.
MaximumLimit int
limitName This property is required. 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.
overrunPolicy This property is required. String
String enum that identifies action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit. Accepted values are "BLOCK" OR "BLOCK_AND_KILL"
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
Amount to set the limit to.
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.
maximumLimit Integer
limitName This property is required. 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.
overrunPolicy This property is required. string
String enum that identifies action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit. Accepted values are "BLOCK" OR "BLOCK_AND_KILL"
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
Amount to set the limit to.
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.
maximumLimit number
limit_name This property is required. 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.
overrun_policy This property is required. str
String enum that identifies action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit. Accepted values are "BLOCK" OR "BLOCK_AND_KILL"
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
Amount to set the limit to.
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.
maximum_limit int
limitName This property is required. 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.
overrunPolicy This property is required. String
String enum that identifies action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit. Accepted values are "BLOCK" OR "BLOCK_AND_KILL"
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
Amount to set the limit to.
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.
maximumLimit Number

Outputs

All input properties are implicitly available as output properties. Additionally, the FederatedQueryLimit resource produces the following output properties:

CurrentUsage int
Amount that indicates the current usage of the limit.
Id string
The provider-assigned unique ID for this managed resource.
LastModifiedDate string
CurrentUsage int
Amount that indicates the current usage of the limit.
Id string
The provider-assigned unique ID for this managed resource.
LastModifiedDate string
currentUsage Integer
Amount that indicates the current usage of the limit.
id String
The provider-assigned unique ID for this managed resource.
lastModifiedDate String
currentUsage number
Amount that indicates the current usage of the limit.
id string
The provider-assigned unique ID for this managed resource.
lastModifiedDate string
current_usage int
Amount that indicates the current usage of the limit.
id str
The provider-assigned unique ID for this managed resource.
last_modified_date str
currentUsage Number
Amount that indicates the current usage of the limit.
id String
The provider-assigned unique ID for this managed resource.
lastModifiedDate String

Look up Existing FederatedQueryLimit Resource

Get an existing FederatedQueryLimit resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: FederatedQueryLimitState, opts?: CustomResourceOptions): FederatedQueryLimit
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        current_usage: Optional[int] = None,
        default_limit: Optional[int] = None,
        last_modified_date: Optional[str] = None,
        limit_name: Optional[str] = None,
        maximum_limit: Optional[int] = None,
        overrun_policy: Optional[str] = None,
        project_id: Optional[str] = None,
        tenant_name: Optional[str] = None,
        value: Optional[int] = None) -> FederatedQueryLimit
func GetFederatedQueryLimit(ctx *Context, name string, id IDInput, state *FederatedQueryLimitState, opts ...ResourceOption) (*FederatedQueryLimit, error)
public static FederatedQueryLimit Get(string name, Input<string> id, FederatedQueryLimitState? state, CustomResourceOptions? opts = null)
public static FederatedQueryLimit get(String name, Output<String> id, FederatedQueryLimitState state, CustomResourceOptions options)
resources:  _:    type: mongodbatlas:FederatedQueryLimit    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
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.
LastModifiedDate string
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.
MaximumLimit int
OverrunPolicy string
String enum that identifies action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit. Accepted values are "BLOCK" OR "BLOCK_AND_KILL"
ProjectId string
The unique ID for the project to create a Federated Database Instance.
TenantName string
Name of the Atlas Federated Database Instance.
Value int
Amount to set the limit to.
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.
LastModifiedDate string
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.
MaximumLimit int
OverrunPolicy string
String enum that identifies action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit. Accepted values are "BLOCK" OR "BLOCK_AND_KILL"
ProjectId string
The unique ID for the project to create a Federated Database Instance.
TenantName string
Name of the Atlas Federated Database Instance.
Value int
Amount to set the limit to.
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.
lastModifiedDate String
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.
maximumLimit Integer
overrunPolicy String
String enum that identifies action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit. Accepted values are "BLOCK" OR "BLOCK_AND_KILL"
projectId String
The unique ID for the project to create a Federated Database Instance.
tenantName String
Name of the Atlas Federated Database Instance.
value Integer
Amount to set the limit to.
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.
lastModifiedDate string
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.
maximumLimit number
overrunPolicy string
String enum that identifies action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit. Accepted values are "BLOCK" OR "BLOCK_AND_KILL"
projectId string
The unique ID for the project to create a Federated Database Instance.
tenantName string
Name of the Atlas Federated Database Instance.
value number
Amount to set the limit to.
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.
last_modified_date str
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.
maximum_limit int
overrun_policy str
String enum that identifies action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit. Accepted values are "BLOCK" OR "BLOCK_AND_KILL"
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.
value int
Amount to set the limit to.
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.
lastModifiedDate String
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.
maximumLimit Number
overrunPolicy String
String enum that identifies action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit. Accepted values are "BLOCK" OR "BLOCK_AND_KILL"
projectId String
The unique ID for the project to create a Federated Database Instance.
tenantName String
Name of the Atlas Federated Database Instance.
value Number
Amount to set the limit to.

Import

The Federated Database Instance Query Limit can be imported using project ID, name of the instance and limit name, in the format: project_id–tenant_name–limit_name, e.g.

$ pulumi import mongodbatlas:index/federatedQueryLimit:FederatedQueryLimit example 1112222b3bf99403840e8934--FederatedDatabaseInstance0--bytesProcessed.daily
Copy

See MongoDB Atlas API Documentation for more information.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
MongoDB Atlas pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas