MaintenanceWindow

Provides an SSM Maintenance Window resource

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var production = new Aws.Ssm.MaintenanceWindow("production", new Aws.Ssm.MaintenanceWindowArgs
        {
            Cutoff = 1,
            Duration = 3,
            Schedule = "cron(0 16 ? * TUE *)",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/ssm"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := ssm.NewMaintenanceWindow(ctx, "production", &ssm.MaintenanceWindowArgs{
            Cutoff:   pulumi.Int(1),
            Duration: pulumi.Int(3),
            Schedule: pulumi.String("cron(0 16 ? * TUE *)"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

production = aws.ssm.MaintenanceWindow("production",
    cutoff=1,
    duration=3,
    schedule="cron(0 16 ? * TUE *)")

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

const production = new aws.ssm.MaintenanceWindow("production", {
    cutoff: 1,
    duration: 3,
    schedule: "cron(0 16 ? * TUE *)",
});

Create a MaintenanceWindow Resource

new MaintenanceWindow(name: string, args: MaintenanceWindowArgs, opts?: CustomResourceOptions);

def MaintenanceWindow(resource_name, opts=None, allow_unassociated_targets=None, cutoff=None, description=None, duration=None, enabled=None, end_date=None, name=None, schedule=None, schedule_timezone=None, start_date=None, tags=None, __props__=None);

func NewMaintenanceWindow(ctx *Context, name string, args MaintenanceWindowArgs, opts ...ResourceOption) (*MaintenanceWindow, error)

public MaintenanceWindow(string name, MaintenanceWindowArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

MaintenanceWindow Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The MaintenanceWindow resource accepts the following input properties:

Cutoff int: The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
Duration int: The duration of the Maintenance Window in hours.
Schedule string: The schedule of the Maintenance Window in the form of a cron or rate expression.
AllowUnassociatedTargets bool: Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
Description string: A description for the maintenance window.
Enabled bool: Whether the maintenance window is enabled. Default: true.
EndDate string: Timestamp in ISO-8601 extended format when to no longer run the maintenance window.
Name string: The name of the maintenance window.
ScheduleTimezone string: Timezone for schedule in Internet Assigned Numbers Authority (IANA) Time Zone Database format. For example: America/Los_Angeles, etc/UTC, or Asia/Seoul.
StartDate string: Timestamp in ISO-8601 extended format when to begin the maintenance window.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

Cutoff int: The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
Duration int: The duration of the Maintenance Window in hours.
Schedule string: The schedule of the Maintenance Window in the form of a cron or rate expression.
AllowUnassociatedTargets bool: Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
Description string: A description for the maintenance window.
Enabled bool: Whether the maintenance window is enabled. Default: true.
EndDate string: Timestamp in ISO-8601 extended format when to no longer run the maintenance window.
Name string: The name of the maintenance window.
ScheduleTimezone string: Timezone for schedule in Internet Assigned Numbers Authority (IANA) Time Zone Database format. For example: America/Los_Angeles, etc/UTC, or Asia/Seoul.
StartDate string: Timestamp in ISO-8601 extended format when to begin the maintenance window.
Tags map[string]string: A map of tags to assign to the resource.

cutoff number: The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
duration number: The duration of the Maintenance Window in hours.
schedule string: The schedule of the Maintenance Window in the form of a cron or rate expression.
allowUnassociatedTargets boolean: Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
description string: A description for the maintenance window.
enabled boolean: Whether the maintenance window is enabled. Default: true.
endDate string: Timestamp in ISO-8601 extended format when to no longer run the maintenance window.
name string: The name of the maintenance window.
scheduleTimezone string: Timezone for schedule in Internet Assigned Numbers Authority (IANA) Time Zone Database format. For example: America/Los_Angeles, etc/UTC, or Asia/Seoul.
startDate string: Timestamp in ISO-8601 extended format when to begin the maintenance window.
tags {[key: string]: string}: A map of tags to assign to the resource.

cutoff float: The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
duration float: The duration of the Maintenance Window in hours.
schedule str: The schedule of the Maintenance Window in the form of a cron or rate expression.
allow_unassociated_targets bool: Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
description str: A description for the maintenance window.
enabled bool: Whether the maintenance window is enabled. Default: true.
end_date str: Timestamp in ISO-8601 extended format when to no longer run the maintenance window.
name str: The name of the maintenance window.
schedule_timezone str: Timezone for schedule in Internet Assigned Numbers Authority (IANA) Time Zone Database format. For example: America/Los_Angeles, etc/UTC, or Asia/Seoul.
start_date str: Timestamp in ISO-8601 extended format when to begin the maintenance window.
tags Dict[str, str]: A map of tags to assign to the resource.

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.

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.

Look up an 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

static get(resource_name, id, opts=None, allow_unassociated_targets=None, cutoff=None, description=None, duration=None, enabled=None, end_date=None, name=None, schedule=None, schedule_timezone=None, start_date=None, tags=None, __props__=None);

func 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)

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.

The following state arguments are supported:

AllowUnassociatedTargets bool: Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
Cutoff int: The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
Description string: A description for the maintenance window.
Duration int: The duration of the Maintenance Window in hours.
Enabled bool: Whether the maintenance window is enabled. Default: true.
EndDate string: Timestamp in ISO-8601 extended format when to no longer run the maintenance window.
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.
ScheduleTimezone string: Timezone for schedule in Internet Assigned Numbers Authority (IANA) Time Zone Database format. For example: America/Los_Angeles, etc/UTC, or Asia/Seoul.
StartDate string: Timestamp in ISO-8601 extended format when to begin the maintenance window.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

AllowUnassociatedTargets bool: Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
Cutoff int: The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
Description string: A description for the maintenance window.
Duration int: The duration of the Maintenance Window in hours.
Enabled bool: Whether the maintenance window is enabled. Default: true.
EndDate string: Timestamp in ISO-8601 extended format when to no longer run the maintenance window.
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.
ScheduleTimezone string: Timezone for schedule in Internet Assigned Numbers Authority (IANA) Time Zone Database format. For example: America/Los_Angeles, etc/UTC, or Asia/Seoul.
StartDate string: Timestamp in ISO-8601 extended format when to begin the maintenance window.
Tags map[string]string: A map of tags to assign to the resource.

allowUnassociatedTargets boolean: Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
cutoff number: The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
description string: A description for the maintenance window.
duration number: The duration of the Maintenance Window in hours.
enabled boolean: Whether the maintenance window is enabled. Default: true.
endDate string: Timestamp in ISO-8601 extended format when to no longer run the maintenance window.
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.
scheduleTimezone string: Timezone for schedule in Internet Assigned Numbers Authority (IANA) Time Zone Database format. For example: America/Los_Angeles, etc/UTC, or Asia/Seoul.
startDate string: Timestamp in ISO-8601 extended format when to begin the maintenance window.
tags {[key: string]: string}: A map of tags to assign to the resource.

allow_unassociated_targets bool: Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
cutoff float: The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
description str: A description for the maintenance window.
duration float: The duration of the Maintenance Window in hours.
enabled bool: Whether the maintenance window is enabled. Default: true.
end_date str: Timestamp in ISO-8601 extended format when to no longer run the maintenance window.
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_timezone str: Timezone for schedule in Internet Assigned Numbers Authority (IANA) Time Zone Database format. For example: America/Los_Angeles, etc/UTC, or Asia/Seoul.
start_date str: Timestamp in ISO-8601 extended format when to begin the maintenance window.
tags Dict[str, str]: A map of tags to assign to the resource.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud