published on Thursday, Sep 17, 2026 by Pulumi
published on Thursday, Sep 17, 2026 by Pulumi
mongodbatlas.OrgMaintenanceSettings provides a resource to manage organization-level maintenance wave settings for a MongoDB Atlas organization. Use this resource to control how Atlas assigns projects to maintenance waves, either explicitly by project (MANUAL mode) or automatically based on each project’s environment tag (ENV_TAG_MAPPING mode).
NOTE: Only one
mongodbatlas.OrgMaintenanceSettingsresource can be defined per organization.
Example Usage
Manual wave assignment
Set the organization to MANUAL mode so you can assign each project to a specific maintenance wave using the waveAssignment attribute on mongodbatlas.MaintenanceWindow.
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const example = new mongodbatlas.OrgMaintenanceSettings("example", {
orgId: orgId,
waveAssignmentMode: "MANUAL",
});
import pulumi
import pulumi_mongodbatlas as mongodbatlas
example = mongodbatlas.OrgMaintenanceSettings("example",
org_id=org_id,
wave_assignment_mode="MANUAL")
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 {
_, err := mongodbatlas.NewOrgMaintenanceSettings(ctx, "example", &mongodbatlas.OrgMaintenanceSettingsArgs{
OrgId: pulumi.Any(orgId),
WaveAssignmentMode: pulumi.String("MANUAL"),
})
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 example = new Mongodbatlas.OrgMaintenanceSettings("example", new()
{
OrgId = orgId,
WaveAssignmentMode = "MANUAL",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.OrgMaintenanceSettings;
import com.pulumi.mongodbatlas.OrgMaintenanceSettingsArgs;
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) {
var example = new OrgMaintenanceSettings("example", OrgMaintenanceSettingsArgs.builder()
.orgId(orgId)
.waveAssignmentMode("MANUAL")
.build());
}
}
resources:
example:
type: mongodbatlas:OrgMaintenanceSettings
properties:
orgId: ${orgId}
waveAssignmentMode: MANUAL
pulumi {
required_providers {
mongodbatlas = {
source = "pulumi/mongodbatlas"
}
}
}
resource "mongodbatlas_orgmaintenancesettings" "example" {
org_id = orgId
wave_assignment_mode = "MANUAL"
}
Automatic wave assignment based on environment tags
Set the organization to ENV_TAG_MAPPING mode to have Atlas derive the maintenance wave from each project’s environment tag. The tag key must be environment. The tag value determines the wave: development or test maps to Wave 1, staging maps to Wave 2, and production maps to Wave 3.
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const example = new mongodbatlas.OrgMaintenanceSettings("example", {
orgId: orgId,
waveAssignmentMode: "ENV_TAG_MAPPING",
});
import pulumi
import pulumi_mongodbatlas as mongodbatlas
example = mongodbatlas.OrgMaintenanceSettings("example",
org_id=org_id,
wave_assignment_mode="ENV_TAG_MAPPING")
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 {
_, err := mongodbatlas.NewOrgMaintenanceSettings(ctx, "example", &mongodbatlas.OrgMaintenanceSettingsArgs{
OrgId: pulumi.Any(orgId),
WaveAssignmentMode: pulumi.String("ENV_TAG_MAPPING"),
})
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 example = new Mongodbatlas.OrgMaintenanceSettings("example", new()
{
OrgId = orgId,
WaveAssignmentMode = "ENV_TAG_MAPPING",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.OrgMaintenanceSettings;
import com.pulumi.mongodbatlas.OrgMaintenanceSettingsArgs;
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) {
var example = new OrgMaintenanceSettings("example", OrgMaintenanceSettingsArgs.builder()
.orgId(orgId)
.waveAssignmentMode("ENV_TAG_MAPPING")
.build());
}
}
resources:
example:
type: mongodbatlas:OrgMaintenanceSettings
properties:
orgId: ${orgId}
waveAssignmentMode: ENV_TAG_MAPPING
pulumi {
required_providers {
mongodbatlas = {
source = "pulumi/mongodbatlas"
}
}
}
resource "mongodbatlas_orgmaintenancesettings" "example" {
org_id = orgId
wave_assignment_mode = "ENV_TAG_MAPPING"
}
Further Examples
- Configure Organization Maintenance Settings: Manual Wave Assignment
- Configure Organization Maintenance Settings: Automatic Wave Assignment
Create OrgMaintenanceSettings Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OrgMaintenanceSettings(name: string, args: OrgMaintenanceSettingsArgs, opts?: CustomResourceOptions);@overload
def OrgMaintenanceSettings(resource_name: str,
args: OrgMaintenanceSettingsArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OrgMaintenanceSettings(resource_name: str,
opts: Optional[ResourceOptions] = None,
org_id: Optional[str] = None,
wave_assignment_mode: Optional[str] = None)func NewOrgMaintenanceSettings(ctx *Context, name string, args OrgMaintenanceSettingsArgs, opts ...ResourceOption) (*OrgMaintenanceSettings, error)public OrgMaintenanceSettings(string name, OrgMaintenanceSettingsArgs args, CustomResourceOptions? opts = null)
public OrgMaintenanceSettings(String name, OrgMaintenanceSettingsArgs args)
public OrgMaintenanceSettings(String name, OrgMaintenanceSettingsArgs args, CustomResourceOptions options)
type: mongodbatlas:OrgMaintenanceSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "mongodbatlas_org_maintenance_settings" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args OrgMaintenanceSettingsArgs
- 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 OrgMaintenanceSettingsArgs
- 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 OrgMaintenanceSettingsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OrgMaintenanceSettingsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OrgMaintenanceSettingsArgs
- 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 orgMaintenanceSettingsResource = new Mongodbatlas.OrgMaintenanceSettings("orgMaintenanceSettingsResource", new()
{
OrgId = "string",
WaveAssignmentMode = "string",
});
example, err := mongodbatlas.NewOrgMaintenanceSettings(ctx, "orgMaintenanceSettingsResource", &mongodbatlas.OrgMaintenanceSettingsArgs{
OrgId: pulumi.String("string"),
WaveAssignmentMode: pulumi.String("string"),
})
resource "mongodbatlas_org_maintenance_settings" "orgMaintenanceSettingsResource" {
lifecycle {
create_before_destroy = true
}
org_id = "string"
wave_assignment_mode = "string"
}
var orgMaintenanceSettingsResource = new OrgMaintenanceSettings("orgMaintenanceSettingsResource", OrgMaintenanceSettingsArgs.builder()
.orgId("string")
.waveAssignmentMode("string")
.build());
org_maintenance_settings_resource = mongodbatlas.OrgMaintenanceSettings("orgMaintenanceSettingsResource",
org_id="string",
wave_assignment_mode="string")
const orgMaintenanceSettingsResource = new mongodbatlas.OrgMaintenanceSettings("orgMaintenanceSettingsResource", {
orgId: "string",
waveAssignmentMode: "string",
});
type: mongodbatlas:OrgMaintenanceSettings
properties:
orgId: string
waveAssignmentMode: string
OrgMaintenanceSettings 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 OrgMaintenanceSettings resource accepts the following input properties:
- Org
Id string - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- Wave
Assignment stringMode - Mode configured for this organization that determines how maintenance waves are assigned to projects. Possible values are
MANUALandENV_TAG_MAPPING. Defaults toMANUALwhen unset. Set the organization toENV_TAG_MAPPINGmode to have Atlas derive the maintenance wave from each project's environment tag. The tag key must beenvironment. The tag value determines the wave:developmentortestmaps to Wave 1,stagingmaps to Wave 2, andproductionmaps to Wave 3. Only this field can be updated; Atlas derives read-onlyeffectiveWaveAssignmentModeon GET responses and uses that value for scheduling when it differs fromwaveAssignmentMode. Omit this field to leave the current value unchanged. Specify null to reset to the default value (MANUAL).
- Org
Id string - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- Wave
Assignment stringMode - Mode configured for this organization that determines how maintenance waves are assigned to projects. Possible values are
MANUALandENV_TAG_MAPPING. Defaults toMANUALwhen unset. Set the organization toENV_TAG_MAPPINGmode to have Atlas derive the maintenance wave from each project's environment tag. The tag key must beenvironment. The tag value determines the wave:developmentortestmaps to Wave 1,stagingmaps to Wave 2, andproductionmaps to Wave 3. Only this field can be updated; Atlas derives read-onlyeffectiveWaveAssignmentModeon GET responses and uses that value for scheduling when it differs fromwaveAssignmentMode. Omit this field to leave the current value unchanged. Specify null to reset to the default value (MANUAL).
- org_
id string - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- wave_
assignment_ stringmode - Mode configured for this organization that determines how maintenance waves are assigned to projects. Possible values are
MANUALandENV_TAG_MAPPING. Defaults toMANUALwhen unset. Set the organization toENV_TAG_MAPPINGmode to have Atlas derive the maintenance wave from each project's environment tag. The tag key must beenvironment. The tag value determines the wave:developmentortestmaps to Wave 1,stagingmaps to Wave 2, andproductionmaps to Wave 3. Only this field can be updated; Atlas derives read-onlyeffectiveWaveAssignmentModeon GET responses and uses that value for scheduling when it differs fromwaveAssignmentMode. Omit this field to leave the current value unchanged. Specify null to reset to the default value (MANUAL).
- org
Id String - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- wave
Assignment StringMode - Mode configured for this organization that determines how maintenance waves are assigned to projects. Possible values are
MANUALandENV_TAG_MAPPING. Defaults toMANUALwhen unset. Set the organization toENV_TAG_MAPPINGmode to have Atlas derive the maintenance wave from each project's environment tag. The tag key must beenvironment. The tag value determines the wave:developmentortestmaps to Wave 1,stagingmaps to Wave 2, andproductionmaps to Wave 3. Only this field can be updated; Atlas derives read-onlyeffectiveWaveAssignmentModeon GET responses and uses that value for scheduling when it differs fromwaveAssignmentMode. Omit this field to leave the current value unchanged. Specify null to reset to the default value (MANUAL).
- org
Id string - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- wave
Assignment stringMode - Mode configured for this organization that determines how maintenance waves are assigned to projects. Possible values are
MANUALandENV_TAG_MAPPING. Defaults toMANUALwhen unset. Set the organization toENV_TAG_MAPPINGmode to have Atlas derive the maintenance wave from each project's environment tag. The tag key must beenvironment. The tag value determines the wave:developmentortestmaps to Wave 1,stagingmaps to Wave 2, andproductionmaps to Wave 3. Only this field can be updated; Atlas derives read-onlyeffectiveWaveAssignmentModeon GET responses and uses that value for scheduling when it differs fromwaveAssignmentMode. Omit this field to leave the current value unchanged. Specify null to reset to the default value (MANUAL).
- org_
id str - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- wave_
assignment_ strmode - Mode configured for this organization that determines how maintenance waves are assigned to projects. Possible values are
MANUALandENV_TAG_MAPPING. Defaults toMANUALwhen unset. Set the organization toENV_TAG_MAPPINGmode to have Atlas derive the maintenance wave from each project's environment tag. The tag key must beenvironment. The tag value determines the wave:developmentortestmaps to Wave 1,stagingmaps to Wave 2, andproductionmaps to Wave 3. Only this field can be updated; Atlas derives read-onlyeffectiveWaveAssignmentModeon GET responses and uses that value for scheduling when it differs fromwaveAssignmentMode. Omit this field to leave the current value unchanged. Specify null to reset to the default value (MANUAL).
- org
Id String - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- wave
Assignment StringMode - Mode configured for this organization that determines how maintenance waves are assigned to projects. Possible values are
MANUALandENV_TAG_MAPPING. Defaults toMANUALwhen unset. Set the organization toENV_TAG_MAPPINGmode to have Atlas derive the maintenance wave from each project's environment tag. The tag key must beenvironment. The tag value determines the wave:developmentortestmaps to Wave 1,stagingmaps to Wave 2, andproductionmaps to Wave 3. Only this field can be updated; Atlas derives read-onlyeffectiveWaveAssignmentModeon GET responses and uses that value for scheduling when it differs fromwaveAssignmentMode. Omit this field to leave the current value unchanged. Specify null to reset to the default value (MANUAL).
Outputs
All input properties are implicitly available as output properties. Additionally, the OrgMaintenanceSettings resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing OrgMaintenanceSettings Resource
Get an existing OrgMaintenanceSettings 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?: OrgMaintenanceSettingsState, opts?: CustomResourceOptions): OrgMaintenanceSettings@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
org_id: Optional[str] = None,
wave_assignment_mode: Optional[str] = None) -> OrgMaintenanceSettingsfunc GetOrgMaintenanceSettings(ctx *Context, name string, id IDInput, state *OrgMaintenanceSettingsState, opts ...ResourceOption) (*OrgMaintenanceSettings, error)public static OrgMaintenanceSettings Get(string name, Input<string> id, OrgMaintenanceSettingsState? state, CustomResourceOptions? opts = null)public static OrgMaintenanceSettings get(String name, Output<String> id, OrgMaintenanceSettingsState state, CustomResourceOptions options)resources: _: type: mongodbatlas:OrgMaintenanceSettings get: id: ${id}import {
to = mongodbatlas_org_maintenance_settings.example
id = "${id}"
}
- 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.
- Org
Id string - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- Wave
Assignment stringMode - Mode configured for this organization that determines how maintenance waves are assigned to projects. Possible values are
MANUALandENV_TAG_MAPPING. Defaults toMANUALwhen unset. Set the organization toENV_TAG_MAPPINGmode to have Atlas derive the maintenance wave from each project's environment tag. The tag key must beenvironment. The tag value determines the wave:developmentortestmaps to Wave 1,stagingmaps to Wave 2, andproductionmaps to Wave 3. Only this field can be updated; Atlas derives read-onlyeffectiveWaveAssignmentModeon GET responses and uses that value for scheduling when it differs fromwaveAssignmentMode. Omit this field to leave the current value unchanged. Specify null to reset to the default value (MANUAL).
- Org
Id string - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- Wave
Assignment stringMode - Mode configured for this organization that determines how maintenance waves are assigned to projects. Possible values are
MANUALandENV_TAG_MAPPING. Defaults toMANUALwhen unset. Set the organization toENV_TAG_MAPPINGmode to have Atlas derive the maintenance wave from each project's environment tag. The tag key must beenvironment. The tag value determines the wave:developmentortestmaps to Wave 1,stagingmaps to Wave 2, andproductionmaps to Wave 3. Only this field can be updated; Atlas derives read-onlyeffectiveWaveAssignmentModeon GET responses and uses that value for scheduling when it differs fromwaveAssignmentMode. Omit this field to leave the current value unchanged. Specify null to reset to the default value (MANUAL).
- org_
id string - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- wave_
assignment_ stringmode - Mode configured for this organization that determines how maintenance waves are assigned to projects. Possible values are
MANUALandENV_TAG_MAPPING. Defaults toMANUALwhen unset. Set the organization toENV_TAG_MAPPINGmode to have Atlas derive the maintenance wave from each project's environment tag. The tag key must beenvironment. The tag value determines the wave:developmentortestmaps to Wave 1,stagingmaps to Wave 2, andproductionmaps to Wave 3. Only this field can be updated; Atlas derives read-onlyeffectiveWaveAssignmentModeon GET responses and uses that value for scheduling when it differs fromwaveAssignmentMode. Omit this field to leave the current value unchanged. Specify null to reset to the default value (MANUAL).
- org
Id String - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- wave
Assignment StringMode - Mode configured for this organization that determines how maintenance waves are assigned to projects. Possible values are
MANUALandENV_TAG_MAPPING. Defaults toMANUALwhen unset. Set the organization toENV_TAG_MAPPINGmode to have Atlas derive the maintenance wave from each project's environment tag. The tag key must beenvironment. The tag value determines the wave:developmentortestmaps to Wave 1,stagingmaps to Wave 2, andproductionmaps to Wave 3. Only this field can be updated; Atlas derives read-onlyeffectiveWaveAssignmentModeon GET responses and uses that value for scheduling when it differs fromwaveAssignmentMode. Omit this field to leave the current value unchanged. Specify null to reset to the default value (MANUAL).
- org
Id string - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- wave
Assignment stringMode - Mode configured for this organization that determines how maintenance waves are assigned to projects. Possible values are
MANUALandENV_TAG_MAPPING. Defaults toMANUALwhen unset. Set the organization toENV_TAG_MAPPINGmode to have Atlas derive the maintenance wave from each project's environment tag. The tag key must beenvironment. The tag value determines the wave:developmentortestmaps to Wave 1,stagingmaps to Wave 2, andproductionmaps to Wave 3. Only this field can be updated; Atlas derives read-onlyeffectiveWaveAssignmentModeon GET responses and uses that value for scheduling when it differs fromwaveAssignmentMode. Omit this field to leave the current value unchanged. Specify null to reset to the default value (MANUAL).
- org_
id str - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- wave_
assignment_ strmode - Mode configured for this organization that determines how maintenance waves are assigned to projects. Possible values are
MANUALandENV_TAG_MAPPING. Defaults toMANUALwhen unset. Set the organization toENV_TAG_MAPPINGmode to have Atlas derive the maintenance wave from each project's environment tag. The tag key must beenvironment. The tag value determines the wave:developmentortestmaps to Wave 1,stagingmaps to Wave 2, andproductionmaps to Wave 3. Only this field can be updated; Atlas derives read-onlyeffectiveWaveAssignmentModeon GET responses and uses that value for scheduling when it differs fromwaveAssignmentMode. Omit this field to leave the current value unchanged. Specify null to reset to the default value (MANUAL).
- org
Id String - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- wave
Assignment StringMode - Mode configured for this organization that determines how maintenance waves are assigned to projects. Possible values are
MANUALandENV_TAG_MAPPING. Defaults toMANUALwhen unset. Set the organization toENV_TAG_MAPPINGmode to have Atlas derive the maintenance wave from each project's environment tag. The tag key must beenvironment. The tag value determines the wave:developmentortestmaps to Wave 1,stagingmaps to Wave 2, andproductionmaps to Wave 3. Only this field can be updated; Atlas derives read-onlyeffectiveWaveAssignmentModeon GET responses and uses that value for scheduling when it differs fromwaveAssignmentMode. Omit this field to leave the current value unchanged. Specify null to reset to the default value (MANUAL).
Import
Organization maintenance settings can be imported using the organization ID, in the format ORG_ID, e.g.
$ pulumi import mongodbatlas:index/orgMaintenanceSettings:OrgMaintenanceSettings example 5d09d6a59ccf6445652a444a
For more information, see: MongoDB Atlas API Reference.
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
mongodbatlasTerraform Provider.
published on Thursday, Sep 17, 2026 by Pulumi