MaintenanceWindow class
Provides an SSM Maintenance Window resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const production = new aws.ssm.MaintenanceWindow("production", {
name: "maintenance-window-application",
schedule: "cron(0 16 ? * TUE *)",
duration: 3,
cutoff: 1,
});
import pulumi
import pulumi_aws as aws
production = aws.ssm.MaintenanceWindow("production",
name="maintenance-window-application",
schedule="cron(0 16 ? * TUE *)",
duration=3,
cutoff=1)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var production = new Aws.Ssm.MaintenanceWindow("production", new()
{
Name = "maintenance-window-application",
Schedule = "cron(0 16 ? * TUE *)",
Duration = 3,
Cutoff = 1,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ssm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ssm.NewMaintenanceWindow(ctx, "production", &ssm.MaintenanceWindowArgs{
Name: pulumi.String("maintenance-window-application"),
Schedule: pulumi.String("cron(0 16 ? * TUE *)"),
Duration: pulumi.Int(3),
Cutoff: pulumi.Int(1),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ssm_maintenancewindow" "production" {
name = "maintenance-window-application"
schedule = "cron(0 16 ? * TUE *)"
duration = 3
cutoff = 1
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssm.MaintenanceWindow;
import com.pulumi.aws.ssm.MaintenanceWindowArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var production = new MaintenanceWindow("production", MaintenanceWindowArgs.builder()
.name("maintenance-window-application")
.schedule("cron(0 16 ? * TUE *)")
.duration(3)
.cutoff(1)
.build());
}
}
resources:
production:
type: aws:ssm:MaintenanceWindow
properties:
name: maintenance-window-application
schedule: cron(0 16 ? * TUE *)
duration: 3
cutoff: 1
Import
Identity Schema
Required
id- (String) ID of the maintenance window.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import SSM Maintenance Windows using the maintenance window id. For example:
$ pulumi import aws:ssm/maintenanceWindow:MaintenanceWindow example mw-0123456789
Constructors
- MaintenanceWindow(String name, {MaintenanceWindowArgs? args, CustomResourceOptions? options})
-
Creates a new MaintenanceWindow.
nameThe Pulumi resource name.argsArguments used to configure this MaintenanceWindow. The set of arguments for MaintenanceWindow.optionsResource options controlling this resource's behavior. - MaintenanceWindow.reference(String urn)
- Creates a typed reference to an existing MaintenanceWindow resource.
Properties
-
allowUnassociatedTargets
↔ Output<
bool?> -
Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
cutoff
↔ Output<
int> -
The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
latefinal
-
description
↔ Output<
String?> -
A description for the maintenance window.
latefinal
-
duration
↔ Output<
int> -
The duration of the Maintenance Window in hours.
latefinal
-
enabled
↔ Output<
bool?> -
Whether the maintenance window is enabled. Default:
true.latefinal -
endDate
↔ Output<
String?> -
Timestamp in ISO-8601 extended format when to no longer run the maintenance window.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
The name of the maintenance window.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
schedule
↔ Output<
String> -
The schedule of the Maintenance Window in the form of a cron or rate expression.
latefinal
-
scheduleOffset
↔ Output<
int?> -
The number of days to wait after the date and time specified by a CRON expression before running the maintenance window. Valid range is
1to6.latefinal -
scheduleTimezone
↔ Output<
String?> -
Timezone for schedule in Internet Assigned Numbers Authority (IANA) Time Zone Database format. For example:
America/Los_Angeles,etc/UTC, orAsia/Seoul.latefinal -
startDate
↔ Output<
String?> -
Timestamp in ISO-8601 extended format when to begin the maintenance window.
latefinal
-
A map of tags to assign to the resource. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {MaintenanceWindowState? state, CustomResourceOptions? options}) → MaintenanceWindow -
Gets an existing MaintenanceWindow resource's state with the given
nameandid.