1. Registry
  2. Packages
  3. Mongodbatlas Provider
  4. API Docs
  5. getOrgMaintenanceSettings
Viewing docs for MongoDB Atlas v4.16.0
published on Thursday, Sep 17, 2026 by Pulumi
mongodbatlas logo mongodbatlas logo
Viewing docs for MongoDB Atlas v4.16.0
published on Thursday, Sep 17, 2026 by Pulumi

    mongodbatlas.OrgMaintenanceSettings provides a data source to read the organization-level maintenance wave settings for a MongoDB Atlas organization.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const example = mongodbatlas.getOrgMaintenanceSettings({
        orgId: orgId,
    });
    export const maintenanceSettings = {
        waveAssignmentMode: example.then(example => example.waveAssignmentMode),
        effectiveWaveAssignmentMode: example.then(example => example.effectiveWaveAssignmentMode),
    };
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    example = mongodbatlas.get_org_maintenance_settings(org_id=org_id)
    pulumi.export("maintenanceSettings", {
        "waveAssignmentMode": example.wave_assignment_mode,
        "effectiveWaveAssignmentMode": example.effective_wave_assignment_mode,
    })
    
    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 {
    		example, err := mongodbatlas.GetOrgMaintenanceSettings(ctx, &mongodbatlas.LookupOrgMaintenanceSettingsArgs{
    			OrgId: orgId,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("maintenanceSettings", pulumi.StringMap{
    			"waveAssignmentMode":          example.WaveAssignmentMode,
    			"effectiveWaveAssignmentMode": example.EffectiveWaveAssignmentMode,
    		})
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Mongodbatlas.GetOrgMaintenanceSettings.Invoke(new()
        {
            OrgId = orgId,
        });
    
        return new Dictionary<string, object?>
        {
            ["maintenanceSettings"] = 
            {
                { "waveAssignmentMode", example.Apply(getOrgMaintenanceSettingsResult => getOrgMaintenanceSettingsResult.WaveAssignmentMode) },
                { "effectiveWaveAssignmentMode", example.Apply(getOrgMaintenanceSettingsResult => getOrgMaintenanceSettingsResult.EffectiveWaveAssignmentMode) },
            },
        };
    });
    
    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.GetOrgMaintenanceSettingsArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 example = MongodbatlasFunctions.getOrgMaintenanceSettings(GetOrgMaintenanceSettingsArgs.builder()
                .orgId(orgId)
                .build());
    
            ctx.export("maintenanceSettings", Map.ofEntries(
                Map.entry("waveAssignmentMode", example.waveAssignmentMode()),
                Map.entry("effectiveWaveAssignmentMode", example.effectiveWaveAssignmentMode())
            ));
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: mongodbatlas:getOrgMaintenanceSettings
          arguments:
            orgId: ${orgId}
    outputs:
      maintenanceSettings:
        waveAssignmentMode: ${example.waveAssignmentMode}
        effectiveWaveAssignmentMode: ${example.effectiveWaveAssignmentMode}
    
    pulumi {
      required_providers {
        mongodbatlas = {
          source = "pulumi/mongodbatlas"
        }
      }
    }
    
    data "mongodbatlas_getorgmaintenancesettings" "example" {
      org_id = orgId
    }
    
    output "maintenanceSettings" {
      value = {
        "waveAssignmentMode"          = data.mongodbatlas_getorgmaintenancesettings.example.wave_assignment_mode
        "effectiveWaveAssignmentMode" = data.mongodbatlas_getorgmaintenancesettings.example.effective_wave_assignment_mode
      }
    }
    

    Using getOrgMaintenanceSettings

    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 getOrgMaintenanceSettings(args: GetOrgMaintenanceSettingsArgs, opts?: InvokeOptions): Promise<GetOrgMaintenanceSettingsResult>
    function getOrgMaintenanceSettingsOutput(args: GetOrgMaintenanceSettingsOutputArgs, opts?: InvokeOutputOptions): Output<GetOrgMaintenanceSettingsResult>
    def get_org_maintenance_settings(org_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetOrgMaintenanceSettingsResult
    def get_org_maintenance_settings_output(org_id: pulumi.Input[Optional[str]] = None,
                                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetOrgMaintenanceSettingsResult]
    func LookupOrgMaintenanceSettings(ctx *Context, args *LookupOrgMaintenanceSettingsArgs, opts ...InvokeOption) (*LookupOrgMaintenanceSettingsResult, error)
    func LookupOrgMaintenanceSettingsOutput(ctx *Context, args *LookupOrgMaintenanceSettingsOutputArgs, opts ...InvokeOption) LookupOrgMaintenanceSettingsResultOutput

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

    public static class GetOrgMaintenanceSettings 
    {
        public static Task<GetOrgMaintenanceSettingsResult> InvokeAsync(GetOrgMaintenanceSettingsArgs args, InvokeOptions? opts = null)
        public static Output<GetOrgMaintenanceSettingsResult> Invoke(GetOrgMaintenanceSettingsInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetOrgMaintenanceSettingsResult> Invoke(GetOrgMaintenanceSettingsInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetOrgMaintenanceSettingsResult> getOrgMaintenanceSettings(GetOrgMaintenanceSettingsArgs args, InvokeOptions options)
    public static Output<GetOrgMaintenanceSettingsResult> getOrgMaintenanceSettings(GetOrgMaintenanceSettingsArgs args, InvokeOptions options)
    public static Output<GetOrgMaintenanceSettingsResult> getOrgMaintenanceSettings(GetOrgMaintenanceSettingsArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: mongodbatlas:index/getOrgMaintenanceSettings:getOrgMaintenanceSettings
      arguments:
        # arguments dictionary
    data "mongodbatlas_get_org_maintenance_settings" "name" {
        # arguments
    }

    The following arguments are supported:

    OrgId string
    Unique 24-hexadecimal digit string that identifies the Atlas organization.
    OrgId string
    Unique 24-hexadecimal digit string that identifies the Atlas organization.
    org_id string
    Unique 24-hexadecimal digit string that identifies the Atlas organization.
    orgId String
    Unique 24-hexadecimal digit string that identifies the Atlas organization.
    orgId string
    Unique 24-hexadecimal digit string that identifies the Atlas organization.
    org_id str
    Unique 24-hexadecimal digit string that identifies the Atlas organization.
    orgId String
    Unique 24-hexadecimal digit string that identifies the Atlas organization.

    getOrgMaintenanceSettings Result

    The following output properties are available:

    EffectiveWaveAssignmentMode string
    Wave assignment mode Atlas actually uses for scheduling. Matches waveAssignmentMode, except in a cross-organization billing hierarchy where the organization is a linked non-paying organization. In that case, effectiveWaveAssignmentMode inherits from the paying organization's waveAssignmentMode and the two values might differ.
    OrgId string
    WaveAssignmentMode string
    Configured wave assignment mode for the organization. Accepted values are MANUAL and ENV_TAG_MAPPING.
    EffectiveWaveAssignmentMode string
    Wave assignment mode Atlas actually uses for scheduling. Matches waveAssignmentMode, except in a cross-organization billing hierarchy where the organization is a linked non-paying organization. In that case, effectiveWaveAssignmentMode inherits from the paying organization's waveAssignmentMode and the two values might differ.
    OrgId string
    WaveAssignmentMode string
    Configured wave assignment mode for the organization. Accepted values are MANUAL and ENV_TAG_MAPPING.
    effective_wave_assignment_mode string
    Wave assignment mode Atlas actually uses for scheduling. Matches waveAssignmentMode, except in a cross-organization billing hierarchy where the organization is a linked non-paying organization. In that case, effectiveWaveAssignmentMode inherits from the paying organization's waveAssignmentMode and the two values might differ.
    org_id string
    wave_assignment_mode string
    Configured wave assignment mode for the organization. Accepted values are MANUAL and ENV_TAG_MAPPING.
    effectiveWaveAssignmentMode String
    Wave assignment mode Atlas actually uses for scheduling. Matches waveAssignmentMode, except in a cross-organization billing hierarchy where the organization is a linked non-paying organization. In that case, effectiveWaveAssignmentMode inherits from the paying organization's waveAssignmentMode and the two values might differ.
    orgId String
    waveAssignmentMode String
    Configured wave assignment mode for the organization. Accepted values are MANUAL and ENV_TAG_MAPPING.
    effectiveWaveAssignmentMode string
    Wave assignment mode Atlas actually uses for scheduling. Matches waveAssignmentMode, except in a cross-organization billing hierarchy where the organization is a linked non-paying organization. In that case, effectiveWaveAssignmentMode inherits from the paying organization's waveAssignmentMode and the two values might differ.
    orgId string
    waveAssignmentMode string
    Configured wave assignment mode for the organization. Accepted values are MANUAL and ENV_TAG_MAPPING.
    effective_wave_assignment_mode str
    Wave assignment mode Atlas actually uses for scheduling. Matches waveAssignmentMode, except in a cross-organization billing hierarchy where the organization is a linked non-paying organization. In that case, effectiveWaveAssignmentMode inherits from the paying organization's waveAssignmentMode and the two values might differ.
    org_id str
    wave_assignment_mode str
    Configured wave assignment mode for the organization. Accepted values are MANUAL and ENV_TAG_MAPPING.
    effectiveWaveAssignmentMode String
    Wave assignment mode Atlas actually uses for scheduling. Matches waveAssignmentMode, except in a cross-organization billing hierarchy where the organization is a linked non-paying organization. In that case, effectiveWaveAssignmentMode inherits from the paying organization's waveAssignmentMode and the two values might differ.
    orgId String
    waveAssignmentMode String
    Configured wave assignment mode for the organization. Accepted values are MANUAL and ENV_TAG_MAPPING.

    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 mongodbatlas logo
    Viewing docs for MongoDB Atlas v4.16.0
    published on Thursday, Sep 17, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial