Class 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 *)",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

MaintenanceWindow

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Ssm

Assembly: Pulumi.Aws.dll

Syntax

public class MaintenanceWindow : CustomResource

Constructors

MaintenanceWindow(String, MaintenanceWindowArgs, CustomResourceOptions)

Create a MaintenanceWindow resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
MaintenanceWindowArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AllowUnassociatedTargets

Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.

Declaration

public Output<bool?> AllowUnassociatedTargets { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Cutoff

The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

Declaration

public Output<int> Cutoff { get; }

Property Value

Type	Description
Output<System.Int32>

Description

A description for the maintenance window.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Duration

The duration of the Maintenance Window in hours.

Declaration

public Output<int> Duration { get; }

Property Value

Type	Description
Output<System.Int32>

Enabled

Whether the maintenance window is enabled. Default: true.

Declaration

public Output<bool?> Enabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

EndDate

Timestamp in ISO-8601 extended format when to no longer run the maintenance window.

Declaration

public Output<string> EndDate { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the maintenance window.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Schedule

The schedule of the Maintenance Window in the form of a cron or rate expression.

Declaration

public Output<string> Schedule { get; }

Property Value

Type	Description
Output<System.String>

ScheduleTimezone

Timezone for schedule in Internet Assigned Numbers Authority (IANA) Time Zone Database format. For example: America/Los_Angeles, etc/UTC, or Asia/Seoul.

Declaration

public Output<string> ScheduleTimezone { get; }

Property Value

Type	Description
Output<System.String>

StartDate

Timestamp in ISO-8601 extended format when to begin the maintenance window.

Declaration

public Output<string> StartDate { get; }

Property Value

Type	Description
Output<System.String>

Tags

A map of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

Get(String, Input<String>, MaintenanceWindowState, CustomResourceOptions)

Get an existing MaintenanceWindow resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static MaintenanceWindow Get(string name, Input<string> id, MaintenanceWindowState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
MaintenanceWindowState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
MaintenanceWindow