aws-native.ssm.getMaintenanceWindow

AWS Cloud Control v1.57.0, Mar 9 26

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.57.0
published on Monday, Mar 9, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.57.0
published on Monday, Mar 9, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

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(window_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetMaintenanceWindowResult
def get_maintenance_window_output(window_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)
public static Output<GetMaintenanceWindowResult> getMaintenanceWindow(GetMaintenanceWindowArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:ssm:getMaintenanceWindow
  arguments:
    # arguments dictionary

The following arguments are supported:

WindowId string: The ID of the maintenance window.

WindowId string: The ID of the maintenance window.

windowId String: The ID of the maintenance window.

windowId string: The ID of the maintenance window.

window_id str: The ID of the maintenance window.

windowId String: The ID of the maintenance window.

getMaintenanceWindow Result

The following output properties are available:

AllowUnassociatedTargets bool: Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.
Cutoff int: The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.
Description string: A description of the maintenance window.
Duration int: The duration of the maintenance window in hours.
EndDate string: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
Name string: The name of the maintenance window.
Schedule string: The schedule of the maintenance window in the form of a cron or rate expression.
ScheduleOffset int: The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
ScheduleTimezone string: The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
StartDate string: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.
Tags List<Pulumi.AwsNative.Outputs.Tag>: Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in.
WindowId string: The ID of the maintenance window.

AllowUnassociatedTargets bool: Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.
Cutoff int: The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.
Description string: A description of the maintenance window.
Duration int: The duration of the maintenance window in hours.
EndDate string: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
Name string: The name of the maintenance window.
Schedule string: The schedule of the maintenance window in the form of a cron or rate expression.
ScheduleOffset int: The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
ScheduleTimezone string: The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
StartDate string: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.
Tags Tag: Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in.
WindowId string: The ID of the maintenance window.

allowUnassociatedTargets Boolean: Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.
cutoff Integer: The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.
description String: A description of the maintenance window.
duration Integer: The duration of the maintenance window in hours.
endDate String: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
name String: The name of the maintenance window.
schedule String: The schedule of the maintenance window in the form of a cron or rate expression.
scheduleOffset Integer: The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
scheduleTimezone String: The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
startDate String: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.
tags List<Tag>: Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in.
windowId String: The ID of the maintenance window.

allowUnassociatedTargets boolean: Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.
cutoff number: The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.
description string: A description of the maintenance window.
duration number: The duration of the maintenance window in hours.
endDate string: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
name string: The name of the maintenance window.
schedule string: The schedule of the maintenance window in the form of a cron or rate expression.
scheduleOffset number: The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
scheduleTimezone string: The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
startDate string: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.
tags Tag[]: Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in.
windowId string: The ID of the maintenance window.

allow_unassociated_targets bool: Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.
cutoff int: The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.
description str: A description of the maintenance window.
duration int: The duration of the maintenance window in hours.
end_date str: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
name str: The name of the maintenance window.
schedule str: The schedule of the maintenance window in the form of a cron or rate expression.
schedule_offset int: The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
schedule_timezone str: The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
start_date str: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.
tags Sequence[root_Tag]: Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in.
window_id str: The ID of the maintenance window.

allowUnassociatedTargets Boolean: Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.
cutoff Number: The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.
description String: A description of the maintenance window.
duration Number: The duration of the maintenance window in hours.
endDate String: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
name String: The name of the maintenance window.
schedule String: The schedule of the maintenance window in the form of a cron or rate expression.
scheduleOffset Number: The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
scheduleTimezone String: The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
startDate String: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.
tags List<Property Map>: Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in.
windowId String: The ID of the maintenance window.