MongoDB Atlas

v3.5.1 published on Thursday, Sep 15, 2022 by Pulumi

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.

Using getMaintenanceWindow

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 getMaintenanceWindow(args: GetMaintenanceWindowArgs, opts?: InvokeOptions): Promise<GetMaintenanceWindowResult>
function getMaintenanceWindowOutput(args: GetMaintenanceWindowOutputArgs, opts?: InvokeOptions): Output<GetMaintenanceWindowResult>
def get_maintenance_window(project_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetMaintenanceWindowResult
def get_maintenance_window_output(project_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetMaintenanceWindowResult]
func LookupMaintenanceWindow(ctx *Context, args *LookupMaintenanceWindowArgs, opts ...InvokeOption) (*LookupMaintenanceWindowResult, error)
func LookupMaintenanceWindowOutput(ctx *Context, args *LookupMaintenanceWindowOutputArgs, opts ...InvokeOption) LookupMaintenanceWindowResultOutput

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

public static class GetMaintenanceWindow 
{
    public static Task<GetMaintenanceWindowResult> InvokeAsync(GetMaintenanceWindowArgs args, InvokeOptions? opts = null)
    public static Output<GetMaintenanceWindowResult> Invoke(GetMaintenanceWindowInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetMaintenanceWindowResult> getMaintenanceWindow(GetMaintenanceWindowArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: mongodbatlas:index/getMaintenanceWindow:getMaintenanceWindow
  Arguments:
    # Arguments dictionary

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.

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.

projectId String

The unique identifier of the project for the Maintenance Window.

getMaintenanceWindow Result

The following output properties are available:

AutoDeferOnceEnabled bool

Flag that indicates whether you want to defer all maintenance windows one week they would be triggered. For more information see: MongoDB Atlas API Reference.

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.

AutoDeferOnceEnabled bool

Flag that indicates whether you want to defer all maintenance windows one week they would be triggered. For more information see: MongoDB Atlas API Reference.

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.

autoDeferOnceEnabled Boolean

Flag that indicates whether you want to defer all maintenance windows one week they would be triggered. For more information see: MongoDB Atlas API Reference.

dayOfWeek Integer

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 Integer

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 Integer

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.

autoDeferOnceEnabled boolean

Flag that indicates whether you want to defer all maintenance windows one week they would be triggered. For more information see: MongoDB Atlas API Reference.

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.

auto_defer_once_enabled bool

Flag that indicates whether you want to defer all maintenance windows one week they would be triggered. For more information see: MongoDB Atlas API Reference.

day_of_week 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.

hour_of_day 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 str

The provider-assigned unique ID for this managed resource.

number_of_deferrals int

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.

autoDeferOnceEnabled Boolean

Flag that indicates whether you want to defer all maintenance windows one week they would be triggered. For more information see: MongoDB Atlas API Reference.

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.

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes

This Pulumi package is based on the mongodbatlas Terraform Provider.