Docs Packages
  1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. FederatedQueryLimit
MongoDB Atlas v3.10.1 published on Wednesday, Sep 6, 2023 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.FederatedQueryLimit

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.10.1 published on Wednesday, Sep 6, 2023 by Pulumi
pulumi/pulumi-mongodbatlas

    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

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

return await Deployment.RunAsync(() => 
{
    var test = new Mongodbatlas.FederatedQueryLimit("test", new()
    {
        LimitName = "bytesProcessed.weekly",
        OverrunPolicy = "BLOCK",
        ProjectId = "64707f06c519c20c3a2b1b03",
        TenantName = "FederatedDatabseInstance0",
        Value = 5147483648,
    });

});

    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{
			LimitName:     pulumi.String("bytesProcessed.weekly"),
			OverrunPolicy: pulumi.String("BLOCK"),
			ProjectId:     pulumi.String("64707f06c519c20c3a2b1b03"),
			TenantName:    pulumi.String("FederatedDatabseInstance0"),
			Value:         pulumi.Int(5147483648),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()        
            .limitName("bytesProcessed.weekly")
            .overrunPolicy("BLOCK")
            .projectId("64707f06c519c20c3a2b1b03")
            .tenantName("FederatedDatabseInstance0")
            .value(5147483648)
            .build());

    }
}

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.FederatedQueryLimit("test",
    limit_name="bytesProcessed.weekly",
    overrun_policy="BLOCK",
    project_id="64707f06c519c20c3a2b1b03",
    tenant_name="FederatedDatabseInstance0",
    value=5147483648)

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

const test = new mongodbatlas.FederatedQueryLimit("test", {
    limitName: "bytesProcessed.weekly",
    overrunPolicy: "BLOCK",
    projectId: "64707f06c519c20c3a2b1b03",
    tenantName: "FederatedDatabseInstance0",
    value: 5147483648,
});

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

    Create FederatedQueryLimit Resource

    new FederatedQueryLimit(name: string, args: FederatedQueryLimitArgs, opts?: CustomResourceOptions);
    @overload
def FederatedQueryLimit(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        default_limit: Optional[int] = 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)
@overload
def FederatedQueryLimit(resource_name: str,
                        args: FederatedQueryLimitArgs,
                        opts: Optional[ResourceOptions] = 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.
    name string
    The unique name of the resource.
    args FederatedQueryLimitArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args FederatedQueryLimitArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FederatedQueryLimitArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FederatedQueryLimitArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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

    The FederatedQueryLimit resource accepts the following input properties:

    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.
    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.

    DefaultLimit int

    Default value of the limit.

    MaximumLimit int
    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.
    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.

    DefaultLimit int

    Default value of the limit.

    MaximumLimit int
    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.
    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.

    defaultLimit Integer

    Default value of the limit.

    maximumLimit Integer
    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.
    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.

    defaultLimit number

    Default value of the limit.

    maximumLimit number
    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.
    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.

    default_limit int

    Default value of the limit.

    maximum_limit int
    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.
    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.

    defaultLimit Number

    Default 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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 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 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 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 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.

    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 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 formatproject_id–tenant_name–limit_name, e.g.

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

    See MongoDB Atlas API Documentation for more information.

    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.10.1 published on Wednesday, Sep 6, 2023 by Pulumi
    pulumi/pulumi-mongodbatlas