MaintenanceWindowTarget class

Provides an SSM Maintenance Window Target resource

Example Usage

Instance Target

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

const window = new aws.ssm.MaintenanceWindow("window", {
    name: "maintenance-window-webapp",
    schedule: "cron(0 16 ? * TUE *)",
    duration: 3,
    cutoff: 1,
});
const target1 = new aws.ssm.MaintenanceWindowTarget("target1", {
    targets: [{
        key: "tag:Name",
        values: ["acceptance_test"],
    }],
    windowId: window.id,
    name: "maintenance-window-target",
    description: "This is a maintenance window target",
    resourceType: "INSTANCE",
});
import pulumi
import pulumi_aws as aws

window = aws.ssm.MaintenanceWindow("window",
    name="maintenance-window-webapp",
    schedule="cron(0 16 ? * TUE *)",
    duration=3,
    cutoff=1)
target1 = aws.ssm.MaintenanceWindowTarget("target1",
    targets=[{
        "key": "tag:Name",
        "values": ["acceptance_test"],
    }],
    window_id=window.id,
    name="maintenance-window-target",
    description="This is a maintenance window target",
    resource_type="INSTANCE")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var window = new Aws.Ssm.MaintenanceWindow("window", new()
    {
        Name = "maintenance-window-webapp",
        Schedule = "cron(0 16 ? * TUE *)",
        Duration = 3,
        Cutoff = 1,
    });

    var target1 = new Aws.Ssm.MaintenanceWindowTarget("target1", new()
    {
        Targets = new[]
        {
            new Aws.Ssm.Inputs.MaintenanceWindowTargetTargetArgs
            {
                Key = "tag:Name",
                Values = new[]
                {
                    "acceptance_test",
                },
            },
        },
        WindowId = window.Id,
        Name = "maintenance-window-target",
        Description = "This is a maintenance window target",
        ResourceType = "INSTANCE",
    });

});
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 {
		window, err := ssm.NewMaintenanceWindow(ctx, "window", &ssm.MaintenanceWindowArgs{
			Name:     pulumi.String("maintenance-window-webapp"),
			Schedule: pulumi.String("cron(0 16 ? * TUE *)"),
			Duration: pulumi.Int(3),
			Cutoff:   pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		_, err = ssm.NewMaintenanceWindowTarget(ctx, "target1", &ssm.MaintenanceWindowTargetArgs{
			Targets: ssm.MaintenanceWindowTargetTargetArray{
				&ssm.MaintenanceWindowTargetTargetArgs{
					Key: pulumi.String("tag:Name"),
					Values: pulumi.StringArray{
						pulumi.String("acceptance_test"),
					},
				},
			},
			WindowId:     window.ID().ToIDOutput().ToStringOutput(),
			Name:         pulumi.String("maintenance-window-target"),
			Description:  pulumi.String("This is a maintenance window target"),
			ResourceType: pulumi.String("INSTANCE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ssm_maintenancewindow" "window" {
  name     = "maintenance-window-webapp"
  schedule = "cron(0 16 ? * TUE *)"
  duration = 3
  cutoff   = 1
}
resource "aws_ssm_maintenancewindowtarget" "target1" {
  targets {
    key    = "tag:Name"
    values = ["acceptance_test"]
  }
  window_id     = aws_ssm_maintenancewindow.window.id
  name          = "maintenance-window-target"
  description   = "This is a maintenance window target"
  resource_type = "INSTANCE"
}
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 com.pulumi.aws.ssm.MaintenanceWindowTarget;
import com.pulumi.aws.ssm.MaintenanceWindowTargetArgs;
import com.pulumi.aws.ssm.inputs.MaintenanceWindowTargetTargetArgs;
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 window = new MaintenanceWindow("window", MaintenanceWindowArgs.builder()
            .name("maintenance-window-webapp")
            .schedule("cron(0 16 ? * TUE *)")
            .duration(3)
            .cutoff(1)
            .build());

        var target1 = new MaintenanceWindowTarget("target1", MaintenanceWindowTargetArgs.builder()
            .targets(MaintenanceWindowTargetTargetArgs.builder()
                .key("tag:Name")
                .values("acceptance_test")
                .build())
            .windowId(window.id())
            .name("maintenance-window-target")
            .description("This is a maintenance window target")
            .resourceType("INSTANCE")
            .build());

    }
}
resources:
  window:
    type: aws:ssm:MaintenanceWindow
    properties:
      name: maintenance-window-webapp
      schedule: cron(0 16 ? * TUE *)
      duration: 3
      cutoff: 1
  target1:
    type: aws:ssm:MaintenanceWindowTarget
    properties:
      targets:
        - key: tag:Name
          values:
            - acceptance_test
      windowId: ${window.id}
      name: maintenance-window-target
      description: This is a maintenance window target
      resourceType: INSTANCE

Resource Group Target

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

const window = new aws.ssm.MaintenanceWindow("window", {
    name: "maintenance-window-webapp",
    schedule: "cron(0 16 ? * TUE *)",
    duration: 3,
    cutoff: 1,
});
const target1 = new aws.ssm.MaintenanceWindowTarget("target1", {
    targets: [{
        key: "resource-groups:ResourceTypeFilters",
        values: ["AWS::EC2::Instance"],
    }],
    windowId: window.id,
    name: "maintenance-window-target",
    description: "This is a maintenance window target",
    resourceType: "RESOURCE_GROUP",
});
import pulumi
import pulumi_aws as aws

window = aws.ssm.MaintenanceWindow("window",
    name="maintenance-window-webapp",
    schedule="cron(0 16 ? * TUE *)",
    duration=3,
    cutoff=1)
target1 = aws.ssm.MaintenanceWindowTarget("target1",
    targets=[{
        "key": "resource-groups:ResourceTypeFilters",
        "values": ["AWS::EC2::Instance"],
    }],
    window_id=window.id,
    name="maintenance-window-target",
    description="This is a maintenance window target",
    resource_type="RESOURCE_GROUP")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var window = new Aws.Ssm.MaintenanceWindow("window", new()
    {
        Name = "maintenance-window-webapp",
        Schedule = "cron(0 16 ? * TUE *)",
        Duration = 3,
        Cutoff = 1,
    });

    var target1 = new Aws.Ssm.MaintenanceWindowTarget("target1", new()
    {
        Targets = new[]
        {
            new Aws.Ssm.Inputs.MaintenanceWindowTargetTargetArgs
            {
                Key = "resource-groups:ResourceTypeFilters",
                Values = new[]
                {
                    "AWS::EC2::Instance",
                },
            },
        },
        WindowId = window.Id,
        Name = "maintenance-window-target",
        Description = "This is a maintenance window target",
        ResourceType = "RESOURCE_GROUP",
    });

});
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 {
		window, err := ssm.NewMaintenanceWindow(ctx, "window", &ssm.MaintenanceWindowArgs{
			Name:     pulumi.String("maintenance-window-webapp"),
			Schedule: pulumi.String("cron(0 16 ? * TUE *)"),
			Duration: pulumi.Int(3),
			Cutoff:   pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		_, err = ssm.NewMaintenanceWindowTarget(ctx, "target1", &ssm.MaintenanceWindowTargetArgs{
			Targets: ssm.MaintenanceWindowTargetTargetArray{
				&ssm.MaintenanceWindowTargetTargetArgs{
					Key: pulumi.String("resource-groups:ResourceTypeFilters"),
					Values: pulumi.StringArray{
						pulumi.String("AWS::EC2::Instance"),
					},
				},
			},
			WindowId:     window.ID().ToIDOutput().ToStringOutput(),
			Name:         pulumi.String("maintenance-window-target"),
			Description:  pulumi.String("This is a maintenance window target"),
			ResourceType: pulumi.String("RESOURCE_GROUP"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ssm_maintenancewindow" "window" {
  name     = "maintenance-window-webapp"
  schedule = "cron(0 16 ? * TUE *)"
  duration = 3
  cutoff   = 1
}
resource "aws_ssm_maintenancewindowtarget" "target1" {
  targets {
    key    = "resource-groups:ResourceTypeFilters"
    values = ["AWS::EC2::Instance"]
  }
  window_id     = aws_ssm_maintenancewindow.window.id
  name          = "maintenance-window-target"
  description   = "This is a maintenance window target"
  resource_type = "RESOURCE_GROUP"
}
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 com.pulumi.aws.ssm.MaintenanceWindowTarget;
import com.pulumi.aws.ssm.MaintenanceWindowTargetArgs;
import com.pulumi.aws.ssm.inputs.MaintenanceWindowTargetTargetArgs;
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 window = new MaintenanceWindow("window", MaintenanceWindowArgs.builder()
            .name("maintenance-window-webapp")
            .schedule("cron(0 16 ? * TUE *)")
            .duration(3)
            .cutoff(1)
            .build());

        var target1 = new MaintenanceWindowTarget("target1", MaintenanceWindowTargetArgs.builder()
            .targets(MaintenanceWindowTargetTargetArgs.builder()
                .key("resource-groups:ResourceTypeFilters")
                .values("AWS::EC2::Instance")
                .build())
            .windowId(window.id())
            .name("maintenance-window-target")
            .description("This is a maintenance window target")
            .resourceType("RESOURCE_GROUP")
            .build());

    }
}
resources:
  window:
    type: aws:ssm:MaintenanceWindow
    properties:
      name: maintenance-window-webapp
      schedule: cron(0 16 ? * TUE *)
      duration: 3
      cutoff: 1
  target1:
    type: aws:ssm:MaintenanceWindowTarget
    properties:
      targets:
        - key: resource-groups:ResourceTypeFilters
          values:
            - AWS::EC2::Instance
      windowId: ${window.id}
      name: maintenance-window-target
      description: This is a maintenance window target
      resourceType: RESOURCE_GROUP

Import

Identity Schema

Required

  • windowId - (String) ID of the maintenance window.
  • id - (String) ID of the maintenance window target.

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

Using pulumi import, import SSM Maintenance Window targets using WINDOW_ID/WINDOW_TARGET_ID. For example:

$ pulumi import aws:ssm/maintenanceWindowTarget:MaintenanceWindowTarget example mw-0c50858d01EXAMPLE/23639a0b-ddbc-4bca-9e72-78d96EXAMPLE

Constructors

MaintenanceWindowTarget(String name, {MaintenanceWindowTargetArgs? args, CustomResourceOptions? options})
Creates a new MaintenanceWindowTarget. name The Pulumi resource name. args Arguments used to configure this MaintenanceWindowTarget. The set of arguments for MaintenanceWindowTarget. options Resource options controlling this resource's behavior.
MaintenanceWindowTarget.reference(String urn)
Creates a typed reference to an existing MaintenanceWindowTarget resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
description ↔ Output<String?>
The description of the maintenance window target.
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 target.
latefinal
ownerInformation ↔ Output<String?>
User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this 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
resourceType ↔ Output<String>
The type of target being registered with the Maintenance Window. Possible values are INSTANCE and RESOURCE_GROUP.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
targets ↔ Output<List<MaintenanceWindowTargetTarget>>
The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs. You can specify targets using instance IDs, resource group names, or tags that have been applied to instances. For more information about these examples formats see (https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html)
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
windowId ↔ Output<String>
The Id of the maintenance window to register the target with.
latefinal

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, {MaintenanceWindowTargetState? state, CustomResourceOptions? options}) → MaintenanceWindowTarget
Gets an existing MaintenanceWindowTarget resource's state with the given name and id.