mongodbatlas.MaintenanceWindow provides a resource to schedule the maintenance window for your MongoDB Atlas Project and/or set to defer a scheduled maintenance up to two times. Please refer to Maintenance Windows documentation for more details.
NOTE: Only a single maintenance window resource can be defined per project.
NOTE: Groups and projects are synonymous terms. You may find
groupIdin the official documentation.
NOTE: Maintenance window times use the project’s configured timezone. To change the timezone, update the Project Time Zone setting in the Atlas Project Settings.
Maintenance Window Considerations:
- Urgent Maintenance Activities Cannot Wait: Urgent maintenance activities such as security patches cannot wait for your chosen window. Atlas will start those maintenance activities when needed.
Once maintenance is scheduled for your cluster, you cannot change your maintenance window until the current maintenance efforts have completed.
- Maintenance Requires Replica Set Elections: Atlas performs maintenance the same way as the manual maintenance procedure. This requires at least one replica set election during the maintenance window per replica set.
- Maintenance Starts As Close to the Hour As Possible: Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or expected system issues could delay the start time.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const test = new mongodbatlas.MaintenanceWindow("test", {
projectId: "<your-project-id>",
dayOfWeek: 3,
hourOfDay: 4,
protectedHours: {
startHourOfDay: 9,
endHourOfDay: 17,
},
});
import pulumi
import pulumi_mongodbatlas as mongodbatlas
test = mongodbatlas.MaintenanceWindow("test",
project_id="<your-project-id>",
day_of_week=3,
hour_of_day=4,
protected_hours={
"start_hour_of_day": 9,
"end_hour_of_day": 17,
})
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.NewMaintenanceWindow(ctx, "test", &mongodbatlas.MaintenanceWindowArgs{
ProjectId: pulumi.String("<your-project-id>"),
DayOfWeek: pulumi.Int(3),
HourOfDay: pulumi.Int(4),
ProtectedHours: &mongodbatlas.MaintenanceWindowProtectedHoursArgs{
StartHourOfDay: pulumi.Int(9),
EndHourOfDay: pulumi.Int(17),
},
})
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 = new Mongodbatlas.MaintenanceWindow("test", new()
{
ProjectId = "<your-project-id>",
DayOfWeek = 3,
HourOfDay = 4,
ProtectedHours = new Mongodbatlas.Inputs.MaintenanceWindowProtectedHoursArgs
{
StartHourOfDay = 9,
EndHourOfDay = 17,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.MaintenanceWindow;
import com.pulumi.mongodbatlas.MaintenanceWindowArgs;
import com.pulumi.mongodbatlas.inputs.MaintenanceWindowProtectedHoursArgs;
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 MaintenanceWindow("test", MaintenanceWindowArgs.builder()
.projectId("<your-project-id>")
.dayOfWeek(3)
.hourOfDay(4)
.protectedHours(MaintenanceWindowProtectedHoursArgs.builder()
.startHourOfDay(9)
.endHourOfDay(17)
.build())
.build());
}
}
resources:
test:
type: mongodbatlas:MaintenanceWindow
properties:
projectId: <your-project-id>
dayOfWeek: 3
hourOfDay: 4
protectedHours:
startHourOfDay: 9
endHourOfDay: 17
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const test = new mongodbatlas.MaintenanceWindow("test", {
projectId: "<your-project-id>",
defer: true,
});
import pulumi
import pulumi_mongodbatlas as mongodbatlas
test = mongodbatlas.MaintenanceWindow("test",
project_id="<your-project-id>",
defer=True)
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.NewMaintenanceWindow(ctx, "test", &mongodbatlas.MaintenanceWindowArgs{
ProjectId: pulumi.String("<your-project-id>"),
Defer: pulumi.Bool(true),
})
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 = new Mongodbatlas.MaintenanceWindow("test", new()
{
ProjectId = "<your-project-id>",
Defer = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.MaintenanceWindow;
import com.pulumi.mongodbatlas.MaintenanceWindowArgs;
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 MaintenanceWindow("test", MaintenanceWindowArgs.builder()
.projectId("<your-project-id>")
.defer(true)
.build());
}
}
resources:
test:
type: mongodbatlas:MaintenanceWindow
properties:
projectId: <your-project-id>
defer: true
Further Examples
- Configure Maintenance Window
Create MaintenanceWindow Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new MaintenanceWindow(name: string, args: MaintenanceWindowArgs, opts?: CustomResourceOptions);@overload
def MaintenanceWindow(resource_name: str,
args: MaintenanceWindowArgs,
opts: Optional[ResourceOptions] = None)
@overload
def MaintenanceWindow(resource_name: str,
opts: Optional[ResourceOptions] = None,
day_of_week: Optional[int] = None,
hour_of_day: Optional[int] = None,
project_id: Optional[str] = None,
auto_defer: Optional[bool] = None,
auto_defer_once_enabled: Optional[bool] = None,
defer: Optional[bool] = None,
protected_hours: Optional[MaintenanceWindowProtectedHoursArgs] = None)func NewMaintenanceWindow(ctx *Context, name string, args MaintenanceWindowArgs, opts ...ResourceOption) (*MaintenanceWindow, error)public MaintenanceWindow(string name, MaintenanceWindowArgs args, CustomResourceOptions? opts = null)
public MaintenanceWindow(String name, MaintenanceWindowArgs args)
public MaintenanceWindow(String name, MaintenanceWindowArgs args, CustomResourceOptions options)
type: mongodbatlas:MaintenanceWindow
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args MaintenanceWindowArgs
- 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 MaintenanceWindowArgs
- 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 MaintenanceWindowArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MaintenanceWindowArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args MaintenanceWindowArgs
- 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 maintenanceWindowResource = new Mongodbatlas.MaintenanceWindow("maintenanceWindowResource", new()
{
DayOfWeek = 0,
HourOfDay = 0,
ProjectId = "string",
AutoDefer = false,
AutoDeferOnceEnabled = false,
Defer = false,
ProtectedHours = new Mongodbatlas.Inputs.MaintenanceWindowProtectedHoursArgs
{
EndHourOfDay = 0,
StartHourOfDay = 0,
},
});
example, err := mongodbatlas.NewMaintenanceWindow(ctx, "maintenanceWindowResource", &mongodbatlas.MaintenanceWindowArgs{
DayOfWeek: pulumi.Int(0),
HourOfDay: pulumi.Int(0),
ProjectId: pulumi.String("string"),
AutoDefer: pulumi.Bool(false),
AutoDeferOnceEnabled: pulumi.Bool(false),
Defer: pulumi.Bool(false),
ProtectedHours: &mongodbatlas.MaintenanceWindowProtectedHoursArgs{
EndHourOfDay: pulumi.Int(0),
StartHourOfDay: pulumi.Int(0),
},
})
var maintenanceWindowResource = new MaintenanceWindow("maintenanceWindowResource", MaintenanceWindowArgs.builder()
.dayOfWeek(0)
.hourOfDay(0)
.projectId("string")
.autoDefer(false)
.autoDeferOnceEnabled(false)
.defer(false)
.protectedHours(MaintenanceWindowProtectedHoursArgs.builder()
.endHourOfDay(0)
.startHourOfDay(0)
.build())
.build());
maintenance_window_resource = mongodbatlas.MaintenanceWindow("maintenanceWindowResource",
day_of_week=0,
hour_of_day=0,
project_id="string",
auto_defer=False,
auto_defer_once_enabled=False,
defer=False,
protected_hours={
"end_hour_of_day": 0,
"start_hour_of_day": 0,
})
const maintenanceWindowResource = new mongodbatlas.MaintenanceWindow("maintenanceWindowResource", {
dayOfWeek: 0,
hourOfDay: 0,
projectId: "string",
autoDefer: false,
autoDeferOnceEnabled: false,
defer: false,
protectedHours: {
endHourOfDay: 0,
startHourOfDay: 0,
},
});
type: mongodbatlas:MaintenanceWindow
properties:
autoDefer: false
autoDeferOnceEnabled: false
dayOfWeek: 0
defer: false
hourOfDay: 0
projectId: string
protectedHours:
endHourOfDay: 0
startHourOfDay: 0
MaintenanceWindow 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 MaintenanceWindow resource accepts the following input properties:
- Day
Of intWeek - Day of the week when you would like the maintenance window to start as a 1-based integer: Su=1, M=2, T=3, W=4, T=5, F=6, Sa=7.
- Hour
Of intDay - Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12. Uses the project's configured timezone.
- Project
Id string - The unique identifier of the project for the Maintenance Window.
- Auto
Defer bool - Boolean flag to toggle automatic deferral on/off. Each change flips the current state. Achieves the same outcome as
auto_defer_once_enabledbut through a toggle operation. - Auto
Defer boolOnce Enabled - When
true, enables automatic deferral of all scheduled maintenance for the given project by one week. Achieves the same outcome asauto_deferbut by directly setting the value to true or false. Ifauto_deferis modified triggering a toggle, it will impact the value of this attribute. - Defer bool
- Defer the next scheduled maintenance event for the given project by one week. Only works when maintenance is already scheduled.
- Protected
Hours MaintenanceWindow Protected Hours - Defines the time period during which there will be no standard updates to the clusters. See Protected Hours.
- Day
Of intWeek - Day of the week when you would like the maintenance window to start as a 1-based integer: Su=1, M=2, T=3, W=4, T=5, F=6, Sa=7.
- Hour
Of intDay - Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12. Uses the project's configured timezone.
- Project
Id string - The unique identifier of the project for the Maintenance Window.
- Auto
Defer bool - Boolean flag to toggle automatic deferral on/off. Each change flips the current state. Achieves the same outcome as
auto_defer_once_enabledbut through a toggle operation. - Auto
Defer boolOnce Enabled - When
true, enables automatic deferral of all scheduled maintenance for the given project by one week. Achieves the same outcome asauto_deferbut by directly setting the value to true or false. Ifauto_deferis modified triggering a toggle, it will impact the value of this attribute. - Defer bool
- Defer the next scheduled maintenance event for the given project by one week. Only works when maintenance is already scheduled.
- Protected
Hours MaintenanceWindow Protected Hours Args - Defines the time period during which there will be no standard updates to the clusters. See Protected Hours.
- day
Of IntegerWeek - Day of the week when you would like the maintenance window to start as a 1-based integer: Su=1, M=2, T=3, W=4, T=5, F=6, Sa=7.
- hour
Of IntegerDay - Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12. Uses the project's configured timezone.
- project
Id String - The unique identifier of the project for the Maintenance Window.
- auto
Defer Boolean - Boolean flag to toggle automatic deferral on/off. Each change flips the current state. Achieves the same outcome as
auto_defer_once_enabledbut through a toggle operation. - auto
Defer BooleanOnce Enabled - When
true, enables automatic deferral of all scheduled maintenance for the given project by one week. Achieves the same outcome asauto_deferbut by directly setting the value to true or false. Ifauto_deferis modified triggering a toggle, it will impact the value of this attribute. - defer Boolean
- Defer the next scheduled maintenance event for the given project by one week. Only works when maintenance is already scheduled.
- protected
Hours MaintenanceWindow Protected Hours - Defines the time period during which there will be no standard updates to the clusters. See Protected Hours.
- day
Of numberWeek - Day of the week when you would like the maintenance window to start as a 1-based integer: Su=1, M=2, T=3, W=4, T=5, F=6, Sa=7.
- hour
Of numberDay - Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12. Uses the project's configured timezone.
- project
Id string - The unique identifier of the project for the Maintenance Window.
- auto
Defer boolean - Boolean flag to toggle automatic deferral on/off. Each change flips the current state. Achieves the same outcome as
auto_defer_once_enabledbut through a toggle operation. - auto
Defer booleanOnce Enabled - When
true, enables automatic deferral of all scheduled maintenance for the given project by one week. Achieves the same outcome asauto_deferbut by directly setting the value to true or false. Ifauto_deferis modified triggering a toggle, it will impact the value of this attribute. - defer boolean
- Defer the next scheduled maintenance event for the given project by one week. Only works when maintenance is already scheduled.
- protected
Hours MaintenanceWindow Protected Hours - Defines the time period during which there will be no standard updates to the clusters. See Protected Hours.
- day_
of_ intweek - Day of the week when you would like the maintenance window to start as a 1-based integer: Su=1, M=2, T=3, W=4, T=5, F=6, Sa=7.
- hour_
of_ intday - Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12. Uses the project's configured timezone.
- project_
id str - The unique identifier of the project for the Maintenance Window.
- auto_
defer bool - Boolean flag to toggle automatic deferral on/off. Each change flips the current state. Achieves the same outcome as
auto_defer_once_enabledbut through a toggle operation. - auto_
defer_ boolonce_ enabled - When
true, enables automatic deferral of all scheduled maintenance for the given project by one week. Achieves the same outcome asauto_deferbut by directly setting the value to true or false. Ifauto_deferis modified triggering a toggle, it will impact the value of this attribute. - defer bool
- Defer the next scheduled maintenance event for the given project by one week. Only works when maintenance is already scheduled.
- protected_
hours MaintenanceWindow Protected Hours Args - Defines the time period during which there will be no standard updates to the clusters. See Protected Hours.
- day
Of NumberWeek - Day of the week when you would like the maintenance window to start as a 1-based integer: Su=1, M=2, T=3, W=4, T=5, F=6, Sa=7.
- hour
Of NumberDay - Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12. Uses the project's configured timezone.
- project
Id String - The unique identifier of the project for the Maintenance Window.
- auto
Defer Boolean - Boolean flag to toggle automatic deferral on/off. Each change flips the current state. Achieves the same outcome as
auto_defer_once_enabledbut through a toggle operation. - auto
Defer BooleanOnce Enabled - When
true, enables automatic deferral of all scheduled maintenance for the given project by one week. Achieves the same outcome asauto_deferbut by directly setting the value to true or false. Ifauto_deferis modified triggering a toggle, it will impact the value of this attribute. - defer Boolean
- Defer the next scheduled maintenance event for the given project by one week. Only works when maintenance is already scheduled.
- protected
Hours Property Map - Defines the time period during which there will be no standard updates to the clusters. See Protected Hours.
Outputs
All input properties are implicitly available as output properties. Additionally, the MaintenanceWindow resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Number
Of intDeferrals - Number of times the current maintenance event for this project has been deferred, there can be a maximum of 2 deferrals.
- Start
Asap bool - Flag indicating whether project maintenance has been directed to start immediately. If requested, this field returns true from the time the request was made until the time the maintenance event completes.
- Time
Zone stringId - Identifier for the current time zone of the maintenance window. This can only be updated via the Project Settings UI.
- Id string
- The provider-assigned unique ID for this managed resource.
- Number
Of intDeferrals - Number of times the current maintenance event for this project has been deferred, there can be a maximum of 2 deferrals.
- Start
Asap bool - Flag indicating whether project maintenance has been directed to start immediately. If requested, this field returns true from the time the request was made until the time the maintenance event completes.
- Time
Zone stringId - Identifier for the current time zone of the maintenance window. This can only be updated via the Project Settings UI.
- id String
- The provider-assigned unique ID for this managed resource.
- number
Of IntegerDeferrals - Number of times the current maintenance event for this project has been deferred, there can be a maximum of 2 deferrals.
- start
Asap Boolean - Flag indicating whether project maintenance has been directed to start immediately. If requested, this field returns true from the time the request was made until the time the maintenance event completes.
- time
Zone StringId - Identifier for the current time zone of the maintenance window. This can only be updated via the Project Settings UI.
- id string
- The provider-assigned unique ID for this managed resource.
- number
Of numberDeferrals - Number of times the current maintenance event for this project has been deferred, there can be a maximum of 2 deferrals.
- start
Asap boolean - Flag indicating whether project maintenance has been directed to start immediately. If requested, this field returns true from the time the request was made until the time the maintenance event completes.
- time
Zone stringId - Identifier for the current time zone of the maintenance window. This can only be updated via the Project Settings UI.
- id str
- The provider-assigned unique ID for this managed resource.
- number_
of_ intdeferrals - Number of times the current maintenance event for this project has been deferred, there can be a maximum of 2 deferrals.
- start_
asap bool - Flag indicating whether project maintenance has been directed to start immediately. If requested, this field returns true from the time the request was made until the time the maintenance event completes.
- time_
zone_ strid - Identifier for the current time zone of the maintenance window. This can only be updated via the Project Settings UI.
- id String
- The provider-assigned unique ID for this managed resource.
- number
Of NumberDeferrals - Number of times the current maintenance event for this project has been deferred, there can be a maximum of 2 deferrals.
- start
Asap Boolean - Flag indicating whether project maintenance has been directed to start immediately. If requested, this field returns true from the time the request was made until the time the maintenance event completes.
- time
Zone StringId - Identifier for the current time zone of the maintenance window. This can only be updated via the Project Settings UI.
Look up Existing MaintenanceWindow Resource
Get an existing MaintenanceWindow 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?: MaintenanceWindowState, opts?: CustomResourceOptions): MaintenanceWindow@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auto_defer: Optional[bool] = None,
auto_defer_once_enabled: Optional[bool] = None,
day_of_week: Optional[int] = None,
defer: Optional[bool] = None,
hour_of_day: Optional[int] = None,
number_of_deferrals: Optional[int] = None,
project_id: Optional[str] = None,
protected_hours: Optional[MaintenanceWindowProtectedHoursArgs] = None,
start_asap: Optional[bool] = None,
time_zone_id: Optional[str] = None) -> MaintenanceWindowfunc GetMaintenanceWindow(ctx *Context, name string, id IDInput, state *MaintenanceWindowState, opts ...ResourceOption) (*MaintenanceWindow, error)public static MaintenanceWindow Get(string name, Input<string> id, MaintenanceWindowState? state, CustomResourceOptions? opts = null)public static MaintenanceWindow get(String name, Output<String> id, MaintenanceWindowState state, CustomResourceOptions options)resources: _: type: mongodbatlas:MaintenanceWindow get: 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.
- Auto
Defer bool - Boolean flag to toggle automatic deferral on/off. Each change flips the current state. Achieves the same outcome as
auto_defer_once_enabledbut through a toggle operation. - Auto
Defer boolOnce Enabled - When
true, enables automatic deferral of all scheduled maintenance for the given project by one week. Achieves the same outcome asauto_deferbut by directly setting the value to true or false. Ifauto_deferis modified triggering a toggle, it will impact the value of this attribute. - Day
Of intWeek - Day of the week when you would like the maintenance window to start as a 1-based integer: Su=1, M=2, T=3, W=4, T=5, F=6, Sa=7.
- Defer bool
- Defer the next scheduled maintenance event for the given project by one week. Only works when maintenance is already scheduled.
- Hour
Of intDay - Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12. Uses the project's configured timezone.
- Number
Of intDeferrals - Number of times the current maintenance event for this project has been deferred, there can be a maximum of 2 deferrals.
- Project
Id string - The unique identifier of the project for the Maintenance Window.
- Protected
Hours MaintenanceWindow Protected Hours - Defines the time period during which there will be no standard updates to the clusters. See Protected Hours.
- Start
Asap bool - Flag indicating whether project maintenance has been directed to start immediately. If requested, this field returns true from the time the request was made until the time the maintenance event completes.
- Time
Zone stringId - Identifier for the current time zone of the maintenance window. This can only be updated via the Project Settings UI.
- Auto
Defer bool - Boolean flag to toggle automatic deferral on/off. Each change flips the current state. Achieves the same outcome as
auto_defer_once_enabledbut through a toggle operation. - Auto
Defer boolOnce Enabled - When
true, enables automatic deferral of all scheduled maintenance for the given project by one week. Achieves the same outcome asauto_deferbut by directly setting the value to true or false. Ifauto_deferis modified triggering a toggle, it will impact the value of this attribute. - Day
Of intWeek - Day of the week when you would like the maintenance window to start as a 1-based integer: Su=1, M=2, T=3, W=4, T=5, F=6, Sa=7.
- Defer bool
- Defer the next scheduled maintenance event for the given project by one week. Only works when maintenance is already scheduled.
- Hour
Of intDay - Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12. Uses the project's configured timezone.
- Number
Of intDeferrals - Number of times the current maintenance event for this project has been deferred, there can be a maximum of 2 deferrals.
- Project
Id string - The unique identifier of the project for the Maintenance Window.
- Protected
Hours MaintenanceWindow Protected Hours Args - Defines the time period during which there will be no standard updates to the clusters. See Protected Hours.
- Start
Asap bool - Flag indicating whether project maintenance has been directed to start immediately. If requested, this field returns true from the time the request was made until the time the maintenance event completes.
- Time
Zone stringId - Identifier for the current time zone of the maintenance window. This can only be updated via the Project Settings UI.
- auto
Defer Boolean - Boolean flag to toggle automatic deferral on/off. Each change flips the current state. Achieves the same outcome as
auto_defer_once_enabledbut through a toggle operation. - auto
Defer BooleanOnce Enabled - When
true, enables automatic deferral of all scheduled maintenance for the given project by one week. Achieves the same outcome asauto_deferbut by directly setting the value to true or false. Ifauto_deferis modified triggering a toggle, it will impact the value of this attribute. - day
Of IntegerWeek - Day of the week when you would like the maintenance window to start as a 1-based integer: Su=1, M=2, T=3, W=4, T=5, F=6, Sa=7.
- defer Boolean
- Defer the next scheduled maintenance event for the given project by one week. Only works when maintenance is already scheduled.
- hour
Of IntegerDay - Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12. Uses the project's configured timezone.
- number
Of IntegerDeferrals - Number of times the current maintenance event for this project has been deferred, there can be a maximum of 2 deferrals.
- project
Id String - The unique identifier of the project for the Maintenance Window.
- protected
Hours MaintenanceWindow Protected Hours - Defines the time period during which there will be no standard updates to the clusters. See Protected Hours.
- start
Asap Boolean - Flag indicating whether project maintenance has been directed to start immediately. If requested, this field returns true from the time the request was made until the time the maintenance event completes.
- time
Zone StringId - Identifier for the current time zone of the maintenance window. This can only be updated via the Project Settings UI.
- auto
Defer boolean - Boolean flag to toggle automatic deferral on/off. Each change flips the current state. Achieves the same outcome as
auto_defer_once_enabledbut through a toggle operation. - auto
Defer booleanOnce Enabled - When
true, enables automatic deferral of all scheduled maintenance for the given project by one week. Achieves the same outcome asauto_deferbut by directly setting the value to true or false. Ifauto_deferis modified triggering a toggle, it will impact the value of this attribute. - day
Of numberWeek - Day of the week when you would like the maintenance window to start as a 1-based integer: Su=1, M=2, T=3, W=4, T=5, F=6, Sa=7.
- defer boolean
- Defer the next scheduled maintenance event for the given project by one week. Only works when maintenance is already scheduled.
- hour
Of numberDay - Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12. Uses the project's configured timezone.
- number
Of numberDeferrals - Number of times the current maintenance event for this project has been deferred, there can be a maximum of 2 deferrals.
- project
Id string - The unique identifier of the project for the Maintenance Window.
- protected
Hours MaintenanceWindow Protected Hours - Defines the time period during which there will be no standard updates to the clusters. See Protected Hours.
- start
Asap boolean - Flag indicating whether project maintenance has been directed to start immediately. If requested, this field returns true from the time the request was made until the time the maintenance event completes.
- time
Zone stringId - Identifier for the current time zone of the maintenance window. This can only be updated via the Project Settings UI.
- auto_
defer bool - Boolean flag to toggle automatic deferral on/off. Each change flips the current state. Achieves the same outcome as
auto_defer_once_enabledbut through a toggle operation. - auto_
defer_ boolonce_ enabled - When
true, enables automatic deferral of all scheduled maintenance for the given project by one week. Achieves the same outcome asauto_deferbut by directly setting the value to true or false. Ifauto_deferis modified triggering a toggle, it will impact the value of this attribute. - day_
of_ intweek - Day of the week when you would like the maintenance window to start as a 1-based integer: Su=1, M=2, T=3, W=4, T=5, F=6, Sa=7.
- defer bool
- Defer the next scheduled maintenance event for the given project by one week. Only works when maintenance is already scheduled.
- hour_
of_ intday - Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12. Uses the project's configured timezone.
- number_
of_ intdeferrals - Number of times the current maintenance event for this project has been deferred, there can be a maximum of 2 deferrals.
- project_
id str - The unique identifier of the project for the Maintenance Window.
- protected_
hours MaintenanceWindow Protected Hours Args - Defines the time period during which there will be no standard updates to the clusters. See Protected Hours.
- start_
asap bool - Flag indicating whether project maintenance has been directed to start immediately. If requested, this field returns true from the time the request was made until the time the maintenance event completes.
- time_
zone_ strid - Identifier for the current time zone of the maintenance window. This can only be updated via the Project Settings UI.
- auto
Defer Boolean - Boolean flag to toggle automatic deferral on/off. Each change flips the current state. Achieves the same outcome as
auto_defer_once_enabledbut through a toggle operation. - auto
Defer BooleanOnce Enabled - When
true, enables automatic deferral of all scheduled maintenance for the given project by one week. Achieves the same outcome asauto_deferbut by directly setting the value to true or false. Ifauto_deferis modified triggering a toggle, it will impact the value of this attribute. - day
Of NumberWeek - Day of the week when you would like the maintenance window to start as a 1-based integer: Su=1, M=2, T=3, W=4, T=5, F=6, Sa=7.
- defer Boolean
- Defer the next scheduled maintenance event for the given project by one week. Only works when maintenance is already scheduled.
- hour
Of NumberDay - Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12. Uses the project's configured timezone.
- number
Of NumberDeferrals - Number of times the current maintenance event for this project has been deferred, there can be a maximum of 2 deferrals.
- project
Id String - The unique identifier of the project for the Maintenance Window.
- protected
Hours Property Map - Defines the time period during which there will be no standard updates to the clusters. See Protected Hours.
- start
Asap Boolean - Flag indicating whether project maintenance has been directed to start immediately. If requested, this field returns true from the time the request was made until the time the maintenance event completes.
- time
Zone StringId - Identifier for the current time zone of the maintenance window. This can only be updated via the Project Settings UI.
Supporting Types
MaintenanceWindowProtectedHours, MaintenanceWindowProtectedHoursArgs
- End
Hour intOf Day - Zero-based integer that represents the end hour of the day for the protected hours window.
- Start
Hour intOf Day - Zero-based integer that represents the beginning hour of the day for the protected hours window.
- End
Hour intOf Day - Zero-based integer that represents the end hour of the day for the protected hours window.
- Start
Hour intOf Day - Zero-based integer that represents the beginning hour of the day for the protected hours window.
- end
Hour IntegerOf Day - Zero-based integer that represents the end hour of the day for the protected hours window.
- start
Hour IntegerOf Day - Zero-based integer that represents the beginning hour of the day for the protected hours window.
- end
Hour numberOf Day - Zero-based integer that represents the end hour of the day for the protected hours window.
- start
Hour numberOf Day - Zero-based integer that represents the beginning hour of the day for the protected hours window.
- end_
hour_ intof_ day - Zero-based integer that represents the end hour of the day for the protected hours window.
- start_
hour_ intof_ day - Zero-based integer that represents the beginning hour of the day for the protected hours window.
- end
Hour NumberOf Day - Zero-based integer that represents the end hour of the day for the protected hours window.
- start
Hour NumberOf Day - Zero-based integer that represents the beginning hour of the day for the protected hours window.
Import
Maintenance Window entries can be imported using project project_id, in the format PROJECTID, e.g.
$ pulumi import mongodbatlas:index/maintenanceWindow:MaintenanceWindow test 5d0f1f73cf09a29120e173cf
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.
