1. Docs
  2. Reference
  3. API
  4. mongodbatlas
  5. GetMaintenanceWindow

GetMaintenanceWindow

mongodbatlas..MaintenanceWindow provides a Maintenance Window entry datasource. Gets information regarding the configured maintenance window for a MongoDB Atlas project.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

Examples Usage

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

const testMongodbatlasMaintenanceWindow = new mongodbatlas.MaintenanceWindow("test", {
    dayOfWeek: 3,
    hourOfDay: 4,
    projectId: "<your-project-id>",
});
const testMaintenanceWindow = testMongodbatlasMaintenanceWindow.id.apply(id => mongodbatlas.getMaintenanceWindow({
    projectId: id,
}, { async: true }));
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const testMongodbatlasMaintenanceWindow = new mongodbatlas.MaintenanceWindow("test", {
    projectId: "<your-project-id>",
    startAsap: true,
});
const testMaintenanceWindow = testMongodbatlasMaintenanceWindow.id.apply(id => mongodbatlas.getMaintenanceWindow({
    projectId: id,
}, { async: true }));

Using GetMaintenanceWindow

function getMaintenanceWindow(args: GetMaintenanceWindowArgs, opts?: InvokeOptions): Promise<GetMaintenanceWindowResult>
function  get_maintenance_window(project_id=None, opts=None)
func LookupMaintenanceWindow(ctx *Context, args *LookupMaintenanceWindowArgs, opts ...InvokeOption) (*LookupMaintenanceWindowResult, error)

Note: This function is named LookupMaintenanceWindow in the Go SDK.

public static class GetMaintenanceWindow {
    public static Task<GetMaintenanceWindowResult> InvokeAsync(GetMaintenanceWindowArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ProjectId string

The unique identifier of the project for the Maintenance Window.

ProjectId string

The unique identifier of the project for the Maintenance Window.

projectId string

The unique identifier of the project for the Maintenance Window.

project_id str

The unique identifier of the project for the Maintenance Window.

GetMaintenanceWindow Result

The following output properties are available:

DayOfWeek int

Day of the week when you would like the maintenance window to start as a 1-based integer: S=1, M=2, T=3, W=4, T=5, F=6, S=7.

HourOfDay int

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 (Time zone is UTC).

Id string

The provider-assigned unique ID for this managed resource.

NumberOfDeferrals int

Number of times the current maintenance event for this project has been deferred, you can set a maximum of 2 deferrals.

ProjectId string
StartAsap bool

Flag indicating whether project maintenance has been directed to start immediately. If you request that maintenance begin immediately, this field returns true from the time the request was made until the time the maintenance event completes.

DayOfWeek int

Day of the week when you would like the maintenance window to start as a 1-based integer: S=1, M=2, T=3, W=4, T=5, F=6, S=7.

HourOfDay int

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 (Time zone is UTC).

Id string

The provider-assigned unique ID for this managed resource.

NumberOfDeferrals int

Number of times the current maintenance event for this project has been deferred, you can set a maximum of 2 deferrals.

ProjectId string
StartAsap bool

Flag indicating whether project maintenance has been directed to start immediately. If you request that maintenance begin immediately, this field returns true from the time the request was made until the time the maintenance event completes.

dayOfWeek number

Day of the week when you would like the maintenance window to start as a 1-based integer: S=1, M=2, T=3, W=4, T=5, F=6, S=7.

hourOfDay number

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 (Time zone is UTC).

id string

The provider-assigned unique ID for this managed resource.

numberOfDeferrals number

Number of times the current maintenance event for this project has been deferred, you can set a maximum of 2 deferrals.

projectId string
startAsap boolean

Flag indicating whether project maintenance has been directed to start immediately. If you request that maintenance begin immediately, this field returns true from the time the request was made until the time the maintenance event completes.

day_of_week float

Day of the week when you would like the maintenance window to start as a 1-based integer: S=1, M=2, T=3, W=4, T=5, F=6, S=7.

hour_of_day float

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 (Time zone is UTC).

id str

The provider-assigned unique ID for this managed resource.

number_of_deferrals float

Number of times the current maintenance event for this project has been deferred, you can set a maximum of 2 deferrals.

project_id str
start_asap bool

Flag indicating whether project maintenance has been directed to start immediately. If you request that maintenance begin immediately, this field returns true from the time the request was made until the time the maintenance event completes.

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.