Docs Packages
  1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getFederatedQueryLimits
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getFederatedQueryLimits

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

    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",
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

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

    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
	})
}

    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",
    });

});

    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());

    }
}

    variables:
  test:
    fn::invoke:
      Function: mongodbatlas:getFederatedQueryLimits
      Arguments:
        projectId: PROJECT_ID
        tenantName: FEDERATED_DATABASE_INSTANCE_NAME

    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>
    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]
    func LookupFederatedQueryLimits(ctx *Context, args *LookupFederatedQueryLimitsArgs, opts ...InvokeOption) (*LookupFederatedQueryLimitsResult, error)
func LookupFederatedQueryLimitsOutput(ctx *Context, args *LookupFederatedQueryLimitsOutputArgs, opts ...InvokeOption) LookupFederatedQueryLimitsResultOutput

    > 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)
}
    public static CompletableFuture<GetFederatedQueryLimitsResult> getFederatedQueryLimits(GetFederatedQueryLimitsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    ProjectId string
    The unique ID for the project to create a Federated Database Instance.
    TenantName string
    Name of the Atlas Federated Database Instance.
    ProjectId string
    The unique ID for the project to create a Federated Database Instance.
    TenantName string
    Name of the Atlas Federated Database Instance.
    projectId String
    The unique ID for the project to create a Federated Database Instance.
    tenantName String
    Name of the Atlas Federated Database Instance.
    projectId string
    The unique ID for the project to create a Federated Database Instance.
    tenantName string
    Name of the Atlas Federated Database Instance.
    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.
    projectId String
    The unique ID for the project to create a Federated Database Instance.
    tenantName 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 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
    MaximumLimit int
    OverrunPolicy string
    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
    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
    MaximumLimit int
    OverrunPolicy string
    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
    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
    maximumLimit Integer
    overrunPolicy String
    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
    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
    maximumLimit number
    overrunPolicy string
    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
    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
    maximum_limit int
    overrun_policy str
    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
    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
    maximumLimit Number
    overrunPolicy String
    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

    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.16.2 published on Friday, Jun 21, 2024 by Pulumi
    pulumi/pulumi-mongodbatlas