Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ssm
  5. MaintenanceWindowTask
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.ssm.MaintenanceWindowTask

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Provides an SSM Maintenance Window Task resource

Example Usage

Automation Tasks

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

const example = new aws.ssm.MaintenanceWindowTask("example", {
    maxConcurrency: "2",
    maxErrors: "1",
    priority: 1,
    taskArn: "AWS-RestartEC2Instance",
    taskType: "AUTOMATION",
    windowId: exampleAwsSsmMaintenanceWindow.id,
    targets: [{
        key: "InstanceIds",
        values: [exampleAwsInstance.id],
    }],
    taskInvocationParameters: {
        automationParameters: {
            documentVersion: "$LATEST",
            parameters: [{
                name: "InstanceId",
                values: [exampleAwsInstance.id],
            }],
        },
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.ssm.MaintenanceWindowTask("example",
    max_concurrency="2",
    max_errors="1",
    priority=1,
    task_arn="AWS-RestartEC2Instance",
    task_type="AUTOMATION",
    window_id=example_aws_ssm_maintenance_window["id"],
    targets=[{
        "key": "InstanceIds",
        "values": [example_aws_instance["id"]],
    }],
    task_invocation_parameters={
        "automation_parameters": {
            "document_version": "$LATEST",
            "parameters": [{
                "name": "InstanceId",
                "values": [example_aws_instance["id"]],
            }],
        },
    })
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewMaintenanceWindowTask(ctx, "example", &ssm.MaintenanceWindowTaskArgs{
			MaxConcurrency: pulumi.String("2"),
			MaxErrors:      pulumi.String("1"),
			Priority:       pulumi.Int(1),
			TaskArn:        pulumi.String("AWS-RestartEC2Instance"),
			TaskType:       pulumi.String("AUTOMATION"),
			WindowId:       pulumi.Any(exampleAwsSsmMaintenanceWindow.Id),
			Targets: ssm.MaintenanceWindowTaskTargetArray{
				&ssm.MaintenanceWindowTaskTargetArgs{
					Key: pulumi.String("InstanceIds"),
					Values: pulumi.StringArray{
						exampleAwsInstance.Id,
					},
				},
			},
			TaskInvocationParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersArgs{
				AutomationParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersArgs{
					DocumentVersion: pulumi.String("$LATEST"),
					Parameters: ssm.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameterArray{
						&ssm.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameterArgs{
							Name: pulumi.String("InstanceId"),
							Values: pulumi.StringArray{
								exampleAwsInstance.Id,
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ssm.MaintenanceWindowTask("example", new()
    {
        MaxConcurrency = "2",
        MaxErrors = "1",
        Priority = 1,
        TaskArn = "AWS-RestartEC2Instance",
        TaskType = "AUTOMATION",
        WindowId = exampleAwsSsmMaintenanceWindow.Id,
        Targets = new[]
        {
            new Aws.Ssm.Inputs.MaintenanceWindowTaskTargetArgs
            {
                Key = "InstanceIds",
                Values = new[]
                {
                    exampleAwsInstance.Id,
                },
            },
        },
        TaskInvocationParameters = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersArgs
        {
            AutomationParameters = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersArgs
            {
                DocumentVersion = "$LATEST",
                Parameters = new[]
                {
                    new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameterArgs
                    {
                        Name = "InstanceId",
                        Values = new[]
                        {
                            exampleAwsInstance.Id,
                        },
                    },
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssm.MaintenanceWindowTask;
import com.pulumi.aws.ssm.MaintenanceWindowTaskArgs;
import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTargetArgs;
import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTaskInvocationParametersArgs;
import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersArgs;
import java.util.List;
import java.util.ArrayList;
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 example = new MaintenanceWindowTask("example", MaintenanceWindowTaskArgs.builder()
            .maxConcurrency(2)
            .maxErrors(1)
            .priority(1)
            .taskArn("AWS-RestartEC2Instance")
            .taskType("AUTOMATION")
            .windowId(exampleAwsSsmMaintenanceWindow.id())
            .targets(MaintenanceWindowTaskTargetArgs.builder()
                .key("InstanceIds")
                .values(exampleAwsInstance.id())
                .build())
            .taskInvocationParameters(MaintenanceWindowTaskTaskInvocationParametersArgs.builder()
                .automationParameters(MaintenanceWindowTaskTaskInvocationParametersAutomationParametersArgs.builder()
                    .documentVersion("$LATEST")
                    .parameters(MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameterArgs.builder()
                        .name("InstanceId")
                        .values(exampleAwsInstance.id())
                        .build())
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:ssm:MaintenanceWindowTask
    properties:
      maxConcurrency: 2
      maxErrors: 1
      priority: 1
      taskArn: AWS-RestartEC2Instance
      taskType: AUTOMATION
      windowId: ${exampleAwsSsmMaintenanceWindow.id}
      targets:
        - key: InstanceIds
          values:
            - ${exampleAwsInstance.id}
      taskInvocationParameters:
        automationParameters:
          documentVersion: $LATEST
          parameters:
            - name: InstanceId
              values:
                - ${exampleAwsInstance.id}
Copy

Lambda Tasks

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

const example = new aws.ssm.MaintenanceWindowTask("example", {
    maxConcurrency: "2",
    maxErrors: "1",
    priority: 1,
    taskArn: exampleAwsLambdaFunction.arn,
    taskType: "LAMBDA",
    windowId: exampleAwsSsmMaintenanceWindow.id,
    targets: [{
        key: "InstanceIds",
        values: [exampleAwsInstance.id],
    }],
    taskInvocationParameters: {
        lambdaParameters: {
            clientContext: std.base64encode({
                input: "{\"key1\":\"value1\"}",
            }).then(invoke => invoke.result),
            payload: "{\"key1\":\"value1\"}",
        },
    },
});
Copy
import pulumi
import pulumi_aws as aws
import pulumi_std as std

example = aws.ssm.MaintenanceWindowTask("example",
    max_concurrency="2",
    max_errors="1",
    priority=1,
    task_arn=example_aws_lambda_function["arn"],
    task_type="LAMBDA",
    window_id=example_aws_ssm_maintenance_window["id"],
    targets=[{
        "key": "InstanceIds",
        "values": [example_aws_instance["id"]],
    }],
    task_invocation_parameters={
        "lambda_parameters": {
            "client_context": std.base64encode(input="{\"key1\":\"value1\"}").result,
            "payload": "{\"key1\":\"value1\"}",
        },
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssm"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		invokeBase64encode, err := std.Base64encode(ctx, &std.Base64encodeArgs{
			Input: "{\"key1\":\"value1\"}",
		}, nil)
		if err != nil {
			return err
		}
		_, err = ssm.NewMaintenanceWindowTask(ctx, "example", &ssm.MaintenanceWindowTaskArgs{
			MaxConcurrency: pulumi.String("2"),
			MaxErrors:      pulumi.String("1"),
			Priority:       pulumi.Int(1),
			TaskArn:        pulumi.Any(exampleAwsLambdaFunction.Arn),
			TaskType:       pulumi.String("LAMBDA"),
			WindowId:       pulumi.Any(exampleAwsSsmMaintenanceWindow.Id),
			Targets: ssm.MaintenanceWindowTaskTargetArray{
				&ssm.MaintenanceWindowTaskTargetArgs{
					Key: pulumi.String("InstanceIds"),
					Values: pulumi.StringArray{
						exampleAwsInstance.Id,
					},
				},
			},
			TaskInvocationParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersArgs{
				LambdaParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersLambdaParametersArgs{
					ClientContext: pulumi.String(invokeBase64encode.Result),
					Payload:       pulumi.String("{\"key1\":\"value1\"}"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Std = Pulumi.Std;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ssm.MaintenanceWindowTask("example", new()
    {
        MaxConcurrency = "2",
        MaxErrors = "1",
        Priority = 1,
        TaskArn = exampleAwsLambdaFunction.Arn,
        TaskType = "LAMBDA",
        WindowId = exampleAwsSsmMaintenanceWindow.Id,
        Targets = new[]
        {
            new Aws.Ssm.Inputs.MaintenanceWindowTaskTargetArgs
            {
                Key = "InstanceIds",
                Values = new[]
                {
                    exampleAwsInstance.Id,
                },
            },
        },
        TaskInvocationParameters = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersArgs
        {
            LambdaParameters = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersLambdaParametersArgs
            {
                ClientContext = Std.Base64encode.Invoke(new()
                {
                    Input = "{\"key1\":\"value1\"}",
                }).Apply(invoke => invoke.Result),
                Payload = "{\"key1\":\"value1\"}",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssm.MaintenanceWindowTask;
import com.pulumi.aws.ssm.MaintenanceWindowTaskArgs;
import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTargetArgs;
import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTaskInvocationParametersArgs;
import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTaskInvocationParametersLambdaParametersArgs;
import java.util.List;
import java.util.ArrayList;
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 example = new MaintenanceWindowTask("example", MaintenanceWindowTaskArgs.builder()
            .maxConcurrency(2)
            .maxErrors(1)
            .priority(1)
            .taskArn(exampleAwsLambdaFunction.arn())
            .taskType("LAMBDA")
            .windowId(exampleAwsSsmMaintenanceWindow.id())
            .targets(MaintenanceWindowTaskTargetArgs.builder()
                .key("InstanceIds")
                .values(exampleAwsInstance.id())
                .build())
            .taskInvocationParameters(MaintenanceWindowTaskTaskInvocationParametersArgs.builder()
                .lambdaParameters(MaintenanceWindowTaskTaskInvocationParametersLambdaParametersArgs.builder()
                    .clientContext(StdFunctions.base64encode(Base64encodeArgs.builder()
                        .input("{\"key1\":\"value1\"}")
                        .build()).result())
                    .payload("{\"key1\":\"value1\"}")
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:ssm:MaintenanceWindowTask
    properties:
      maxConcurrency: 2
      maxErrors: 1
      priority: 1
      taskArn: ${exampleAwsLambdaFunction.arn}
      taskType: LAMBDA
      windowId: ${exampleAwsSsmMaintenanceWindow.id}
      targets:
        - key: InstanceIds
          values:
            - ${exampleAwsInstance.id}
      taskInvocationParameters:
        lambdaParameters:
          clientContext:
            fn::invoke:
              function: std:base64encode
              arguments:
                input: '{"key1":"value1"}'
              return: result
          payload: '{"key1":"value1"}'
Copy

Run Command Tasks

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

const example = new aws.ssm.MaintenanceWindowTask("example", {
    maxConcurrency: "2",
    maxErrors: "1",
    priority: 1,
    taskArn: "AWS-RunShellScript",
    taskType: "RUN_COMMAND",
    windowId: exampleAwsSsmMaintenanceWindow.id,
    targets: [{
        key: "InstanceIds",
        values: [exampleAwsInstance.id],
    }],
    taskInvocationParameters: {
        runCommandParameters: {
            outputS3Bucket: exampleAwsS3Bucket.id,
            outputS3KeyPrefix: "output",
            serviceRoleArn: exampleAwsIamRole.arn,
            timeoutSeconds: 600,
            notificationConfig: {
                notificationArn: exampleAwsSnsTopic.arn,
                notificationEvents: ["All"],
                notificationType: "Command",
            },
            parameters: [{
                name: "commands",
                values: ["date"],
            }],
        },
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.ssm.MaintenanceWindowTask("example",
    max_concurrency="2",
    max_errors="1",
    priority=1,
    task_arn="AWS-RunShellScript",
    task_type="RUN_COMMAND",
    window_id=example_aws_ssm_maintenance_window["id"],
    targets=[{
        "key": "InstanceIds",
        "values": [example_aws_instance["id"]],
    }],
    task_invocation_parameters={
        "run_command_parameters": {
            "output_s3_bucket": example_aws_s3_bucket["id"],
            "output_s3_key_prefix": "output",
            "service_role_arn": example_aws_iam_role["arn"],
            "timeout_seconds": 600,
            "notification_config": {
                "notification_arn": example_aws_sns_topic["arn"],
                "notification_events": ["All"],
                "notification_type": "Command",
            },
            "parameters": [{
                "name": "commands",
                "values": ["date"],
            }],
        },
    })
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewMaintenanceWindowTask(ctx, "example", &ssm.MaintenanceWindowTaskArgs{
			MaxConcurrency: pulumi.String("2"),
			MaxErrors:      pulumi.String("1"),
			Priority:       pulumi.Int(1),
			TaskArn:        pulumi.String("AWS-RunShellScript"),
			TaskType:       pulumi.String("RUN_COMMAND"),
			WindowId:       pulumi.Any(exampleAwsSsmMaintenanceWindow.Id),
			Targets: ssm.MaintenanceWindowTaskTargetArray{
				&ssm.MaintenanceWindowTaskTargetArgs{
					Key: pulumi.String("InstanceIds"),
					Values: pulumi.StringArray{
						exampleAwsInstance.Id,
					},
				},
			},
			TaskInvocationParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersArgs{
				RunCommandParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersArgs{
					OutputS3Bucket:    pulumi.Any(exampleAwsS3Bucket.Id),
					OutputS3KeyPrefix: pulumi.String("output"),
					ServiceRoleArn:    pulumi.Any(exampleAwsIamRole.Arn),
					TimeoutSeconds:    pulumi.Int(600),
					NotificationConfig: &ssm.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfigArgs{
						NotificationArn: pulumi.Any(exampleAwsSnsTopic.Arn),
						NotificationEvents: pulumi.StringArray{
							pulumi.String("All"),
						},
						NotificationType: pulumi.String("Command"),
					},
					Parameters: ssm.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameterArray{
						&ssm.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameterArgs{
							Name: pulumi.String("commands"),
							Values: pulumi.StringArray{
								pulumi.String("date"),
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ssm.MaintenanceWindowTask("example", new()
    {
        MaxConcurrency = "2",
        MaxErrors = "1",
        Priority = 1,
        TaskArn = "AWS-RunShellScript",
        TaskType = "RUN_COMMAND",
        WindowId = exampleAwsSsmMaintenanceWindow.Id,
        Targets = new[]
        {
            new Aws.Ssm.Inputs.MaintenanceWindowTaskTargetArgs
            {
                Key = "InstanceIds",
                Values = new[]
                {
                    exampleAwsInstance.Id,
                },
            },
        },
        TaskInvocationParameters = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersArgs
        {
            RunCommandParameters = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersArgs
            {
                OutputS3Bucket = exampleAwsS3Bucket.Id,
                OutputS3KeyPrefix = "output",
                ServiceRoleArn = exampleAwsIamRole.Arn,
                TimeoutSeconds = 600,
                NotificationConfig = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfigArgs
                {
                    NotificationArn = exampleAwsSnsTopic.Arn,
                    NotificationEvents = new[]
                    {
                        "All",
                    },
                    NotificationType = "Command",
                },
                Parameters = new[]
                {
                    new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameterArgs
                    {
                        Name = "commands",
                        Values = new[]
                        {
                            "date",
                        },
                    },
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssm.MaintenanceWindowTask;
import com.pulumi.aws.ssm.MaintenanceWindowTaskArgs;
import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTargetArgs;
import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTaskInvocationParametersArgs;
import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersArgs;
import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfigArgs;
import java.util.List;
import java.util.ArrayList;
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 example = new MaintenanceWindowTask("example", MaintenanceWindowTaskArgs.builder()
            .maxConcurrency(2)
            .maxErrors(1)
            .priority(1)
            .taskArn("AWS-RunShellScript")
            .taskType("RUN_COMMAND")
            .windowId(exampleAwsSsmMaintenanceWindow.id())
            .targets(MaintenanceWindowTaskTargetArgs.builder()
                .key("InstanceIds")
                .values(exampleAwsInstance.id())
                .build())
            .taskInvocationParameters(MaintenanceWindowTaskTaskInvocationParametersArgs.builder()
                .runCommandParameters(MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersArgs.builder()
                    .outputS3Bucket(exampleAwsS3Bucket.id())
                    .outputS3KeyPrefix("output")
                    .serviceRoleArn(exampleAwsIamRole.arn())
                    .timeoutSeconds(600)
                    .notificationConfig(MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfigArgs.builder()
                        .notificationArn(exampleAwsSnsTopic.arn())
                        .notificationEvents("All")
                        .notificationType("Command")
                        .build())
                    .parameters(MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameterArgs.builder()
                        .name("commands")
                        .values("date")
                        .build())
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:ssm:MaintenanceWindowTask
    properties:
      maxConcurrency: 2
      maxErrors: 1
      priority: 1
      taskArn: AWS-RunShellScript
      taskType: RUN_COMMAND
      windowId: ${exampleAwsSsmMaintenanceWindow.id}
      targets:
        - key: InstanceIds
          values:
            - ${exampleAwsInstance.id}
      taskInvocationParameters:
        runCommandParameters:
          outputS3Bucket: ${exampleAwsS3Bucket.id}
          outputS3KeyPrefix: output
          serviceRoleArn: ${exampleAwsIamRole.arn}
          timeoutSeconds: 600
          notificationConfig:
            notificationArn: ${exampleAwsSnsTopic.arn}
            notificationEvents:
              - All
            notificationType: Command
          parameters:
            - name: commands
              values:
                - date
Copy

Step Function Tasks

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

const example = new aws.ssm.MaintenanceWindowTask("example", {
    maxConcurrency: "2",
    maxErrors: "1",
    priority: 1,
    taskArn: exampleAwsSfnActivity.id,
    taskType: "STEP_FUNCTIONS",
    windowId: exampleAwsSsmMaintenanceWindow.id,
    targets: [{
        key: "InstanceIds",
        values: [exampleAwsInstance.id],
    }],
    taskInvocationParameters: {
        stepFunctionsParameters: {
            input: "{\"key1\":\"value1\"}",
            name: "example",
        },
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.ssm.MaintenanceWindowTask("example",
    max_concurrency="2",
    max_errors="1",
    priority=1,
    task_arn=example_aws_sfn_activity["id"],
    task_type="STEP_FUNCTIONS",
    window_id=example_aws_ssm_maintenance_window["id"],
    targets=[{
        "key": "InstanceIds",
        "values": [example_aws_instance["id"]],
    }],
    task_invocation_parameters={
        "step_functions_parameters": {
            "input": "{\"key1\":\"value1\"}",
            "name": "example",
        },
    })
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssm.NewMaintenanceWindowTask(ctx, "example", &ssm.MaintenanceWindowTaskArgs{
			MaxConcurrency: pulumi.String("2"),
			MaxErrors:      pulumi.String("1"),
			Priority:       pulumi.Int(1),
			TaskArn:        pulumi.Any(exampleAwsSfnActivity.Id),
			TaskType:       pulumi.String("STEP_FUNCTIONS"),
			WindowId:       pulumi.Any(exampleAwsSsmMaintenanceWindow.Id),
			Targets: ssm.MaintenanceWindowTaskTargetArray{
				&ssm.MaintenanceWindowTaskTargetArgs{
					Key: pulumi.String("InstanceIds"),
					Values: pulumi.StringArray{
						exampleAwsInstance.Id,
					},
				},
			},
			TaskInvocationParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersArgs{
				StepFunctionsParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParametersArgs{
					Input: pulumi.String("{\"key1\":\"value1\"}"),
					Name:  pulumi.String("example"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ssm.MaintenanceWindowTask("example", new()
    {
        MaxConcurrency = "2",
        MaxErrors = "1",
        Priority = 1,
        TaskArn = exampleAwsSfnActivity.Id,
        TaskType = "STEP_FUNCTIONS",
        WindowId = exampleAwsSsmMaintenanceWindow.Id,
        Targets = new[]
        {
            new Aws.Ssm.Inputs.MaintenanceWindowTaskTargetArgs
            {
                Key = "InstanceIds",
                Values = new[]
                {
                    exampleAwsInstance.Id,
                },
            },
        },
        TaskInvocationParameters = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersArgs
        {
            StepFunctionsParameters = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParametersArgs
            {
                Input = "{\"key1\":\"value1\"}",
                Name = "example",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssm.MaintenanceWindowTask;
import com.pulumi.aws.ssm.MaintenanceWindowTaskArgs;
import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTargetArgs;
import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTaskInvocationParametersArgs;
import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParametersArgs;
import java.util.List;
import java.util.ArrayList;
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 example = new MaintenanceWindowTask("example", MaintenanceWindowTaskArgs.builder()
            .maxConcurrency(2)
            .maxErrors(1)
            .priority(1)
            .taskArn(exampleAwsSfnActivity.id())
            .taskType("STEP_FUNCTIONS")
            .windowId(exampleAwsSsmMaintenanceWindow.id())
            .targets(MaintenanceWindowTaskTargetArgs.builder()
                .key("InstanceIds")
                .values(exampleAwsInstance.id())
                .build())
            .taskInvocationParameters(MaintenanceWindowTaskTaskInvocationParametersArgs.builder()
                .stepFunctionsParameters(MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParametersArgs.builder()
                    .input("{\"key1\":\"value1\"}")
                    .name("example")
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:ssm:MaintenanceWindowTask
    properties:
      maxConcurrency: 2
      maxErrors: 1
      priority: 1
      taskArn: ${exampleAwsSfnActivity.id}
      taskType: STEP_FUNCTIONS
      windowId: ${exampleAwsSsmMaintenanceWindow.id}
      targets:
        - key: InstanceIds
          values:
            - ${exampleAwsInstance.id}
      taskInvocationParameters:
        stepFunctionsParameters:
          input: '{"key1":"value1"}'
          name: example
Copy

Create MaintenanceWindowTask Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new MaintenanceWindowTask(name: string, args: MaintenanceWindowTaskArgs, opts?: CustomResourceOptions);
@overload
def MaintenanceWindowTask(resource_name: str,
                          args: MaintenanceWindowTaskArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def MaintenanceWindowTask(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          task_arn: Optional[str] = None,
                          task_type: Optional[str] = None,
                          window_id: Optional[str] = None,
                          cutoff_behavior: Optional[str] = None,
                          description: Optional[str] = None,
                          max_concurrency: Optional[str] = None,
                          max_errors: Optional[str] = None,
                          name: Optional[str] = None,
                          priority: Optional[int] = None,
                          service_role_arn: Optional[str] = None,
                          targets: Optional[Sequence[MaintenanceWindowTaskTargetArgs]] = None,
                          task_invocation_parameters: Optional[MaintenanceWindowTaskTaskInvocationParametersArgs] = None)
func NewMaintenanceWindowTask(ctx *Context, name string, args MaintenanceWindowTaskArgs, opts ...ResourceOption) (*MaintenanceWindowTask, error)
public MaintenanceWindowTask(string name, MaintenanceWindowTaskArgs args, CustomResourceOptions? opts = null)
public MaintenanceWindowTask(String name, MaintenanceWindowTaskArgs args)
public MaintenanceWindowTask(String name, MaintenanceWindowTaskArgs args, CustomResourceOptions options)

type: aws:ssm:MaintenanceWindowTask
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MaintenanceWindowTaskArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. MaintenanceWindowTaskArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. MaintenanceWindowTaskArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MaintenanceWindowTaskArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. MaintenanceWindowTaskArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var maintenanceWindowTaskResource = new Aws.Ssm.MaintenanceWindowTask("maintenanceWindowTaskResource", new()
{
    TaskArn = "string",
    TaskType = "string",
    WindowId = "string",
    CutoffBehavior = "string",
    Description = "string",
    MaxConcurrency = "string",
    MaxErrors = "string",
    Name = "string",
    Priority = 0,
    ServiceRoleArn = "string",
    Targets = new[]
    {
        new Aws.Ssm.Inputs.MaintenanceWindowTaskTargetArgs
        {
            Key = "string",
            Values = new[]
            {
                "string",
            },
        },
    },
    TaskInvocationParameters = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersArgs
    {
        AutomationParameters = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersArgs
        {
            DocumentVersion = "string",
            Parameters = new[]
            {
                new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameterArgs
                {
                    Name = "string",
                    Values = new[]
                    {
                        "string",
                    },
                },
            },
        },
        LambdaParameters = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersLambdaParametersArgs
        {
            ClientContext = "string",
            Payload = "string",
            Qualifier = "string",
        },
        RunCommandParameters = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersArgs
        {
            CloudwatchConfig = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersCloudwatchConfigArgs
            {
                CloudwatchLogGroupName = "string",
                CloudwatchOutputEnabled = false,
            },
            Comment = "string",
            DocumentHash = "string",
            DocumentHashType = "string",
            DocumentVersion = "string",
            NotificationConfig = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfigArgs
            {
                NotificationArn = "string",
                NotificationEvents = new[]
                {
                    "string",
                },
                NotificationType = "string",
            },
            OutputS3Bucket = "string",
            OutputS3KeyPrefix = "string",
            Parameters = new[]
            {
                new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameterArgs
                {
                    Name = "string",
                    Values = new[]
                    {
                        "string",
                    },
                },
            },
            ServiceRoleArn = "string",
            TimeoutSeconds = 0,
        },
        StepFunctionsParameters = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParametersArgs
        {
            Input = "string",
            Name = "string",
        },
    },
});
Copy
example, err := ssm.NewMaintenanceWindowTask(ctx, "maintenanceWindowTaskResource", &ssm.MaintenanceWindowTaskArgs{
	TaskArn:        pulumi.String("string"),
	TaskType:       pulumi.String("string"),
	WindowId:       pulumi.String("string"),
	CutoffBehavior: pulumi.String("string"),
	Description:    pulumi.String("string"),
	MaxConcurrency: pulumi.String("string"),
	MaxErrors:      pulumi.String("string"),
	Name:           pulumi.String("string"),
	Priority:       pulumi.Int(0),
	ServiceRoleArn: pulumi.String("string"),
	Targets: ssm.MaintenanceWindowTaskTargetArray{
		&ssm.MaintenanceWindowTaskTargetArgs{
			Key: pulumi.String("string"),
			Values: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	TaskInvocationParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersArgs{
		AutomationParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersArgs{
			DocumentVersion: pulumi.String("string"),
			Parameters: ssm.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameterArray{
				&ssm.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameterArgs{
					Name: pulumi.String("string"),
					Values: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
		},
		LambdaParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersLambdaParametersArgs{
			ClientContext: pulumi.String("string"),
			Payload:       pulumi.String("string"),
			Qualifier:     pulumi.String("string"),
		},
		RunCommandParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersArgs{
			CloudwatchConfig: &ssm.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersCloudwatchConfigArgs{
				CloudwatchLogGroupName:  pulumi.String("string"),
				CloudwatchOutputEnabled: pulumi.Bool(false),
			},
			Comment:          pulumi.String("string"),
			DocumentHash:     pulumi.String("string"),
			DocumentHashType: pulumi.String("string"),
			DocumentVersion:  pulumi.String("string"),
			NotificationConfig: &ssm.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfigArgs{
				NotificationArn: pulumi.String("string"),
				NotificationEvents: pulumi.StringArray{
					pulumi.String("string"),
				},
				NotificationType: pulumi.String("string"),
			},
			OutputS3Bucket:    pulumi.String("string"),
			OutputS3KeyPrefix: pulumi.String("string"),
			Parameters: ssm.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameterArray{
				&ssm.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameterArgs{
					Name: pulumi.String("string"),
					Values: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
			ServiceRoleArn: pulumi.String("string"),
			TimeoutSeconds: pulumi.Int(0),
		},
		StepFunctionsParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParametersArgs{
			Input: pulumi.String("string"),
			Name:  pulumi.String("string"),
		},
	},
})
Copy
var maintenanceWindowTaskResource = new MaintenanceWindowTask("maintenanceWindowTaskResource", MaintenanceWindowTaskArgs.builder()
    .taskArn("string")
    .taskType("string")
    .windowId("string")
    .cutoffBehavior("string")
    .description("string")
    .maxConcurrency("string")
    .maxErrors("string")
    .name("string")
    .priority(0)
    .serviceRoleArn("string")
    .targets(MaintenanceWindowTaskTargetArgs.builder()
        .key("string")
        .values("string")
        .build())
    .taskInvocationParameters(MaintenanceWindowTaskTaskInvocationParametersArgs.builder()
        .automationParameters(MaintenanceWindowTaskTaskInvocationParametersAutomationParametersArgs.builder()
            .documentVersion("string")
            .parameters(MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameterArgs.builder()
                .name("string")
                .values("string")
                .build())
            .build())
        .lambdaParameters(MaintenanceWindowTaskTaskInvocationParametersLambdaParametersArgs.builder()
            .clientContext("string")
            .payload("string")
            .qualifier("string")
            .build())
        .runCommandParameters(MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersArgs.builder()
            .cloudwatchConfig(MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersCloudwatchConfigArgs.builder()
                .cloudwatchLogGroupName("string")
                .cloudwatchOutputEnabled(false)
                .build())
            .comment("string")
            .documentHash("string")
            .documentHashType("string")
            .documentVersion("string")
            .notificationConfig(MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfigArgs.builder()
                .notificationArn("string")
                .notificationEvents("string")
                .notificationType("string")
                .build())
            .outputS3Bucket("string")
            .outputS3KeyPrefix("string")
            .parameters(MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameterArgs.builder()
                .name("string")
                .values("string")
                .build())
            .serviceRoleArn("string")
            .timeoutSeconds(0)
            .build())
        .stepFunctionsParameters(MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParametersArgs.builder()
            .input("string")
            .name("string")
            .build())
        .build())
    .build());
Copy
maintenance_window_task_resource = aws.ssm.MaintenanceWindowTask("maintenanceWindowTaskResource",
    task_arn="string",
    task_type="string",
    window_id="string",
    cutoff_behavior="string",
    description="string",
    max_concurrency="string",
    max_errors="string",
    name="string",
    priority=0,
    service_role_arn="string",
    targets=[{
        "key": "string",
        "values": ["string"],
    }],
    task_invocation_parameters={
        "automation_parameters": {
            "document_version": "string",
            "parameters": [{
                "name": "string",
                "values": ["string"],
            }],
        },
        "lambda_parameters": {
            "client_context": "string",
            "payload": "string",
            "qualifier": "string",
        },
        "run_command_parameters": {
            "cloudwatch_config": {
                "cloudwatch_log_group_name": "string",
                "cloudwatch_output_enabled": False,
            },
            "comment": "string",
            "document_hash": "string",
            "document_hash_type": "string",
            "document_version": "string",
            "notification_config": {
                "notification_arn": "string",
                "notification_events": ["string"],
                "notification_type": "string",
            },
            "output_s3_bucket": "string",
            "output_s3_key_prefix": "string",
            "parameters": [{
                "name": "string",
                "values": ["string"],
            }],
            "service_role_arn": "string",
            "timeout_seconds": 0,
        },
        "step_functions_parameters": {
            "input": "string",
            "name": "string",
        },
    })
Copy
const maintenanceWindowTaskResource = new aws.ssm.MaintenanceWindowTask("maintenanceWindowTaskResource", {
    taskArn: "string",
    taskType: "string",
    windowId: "string",
    cutoffBehavior: "string",
    description: "string",
    maxConcurrency: "string",
    maxErrors: "string",
    name: "string",
    priority: 0,
    serviceRoleArn: "string",
    targets: [{
        key: "string",
        values: ["string"],
    }],
    taskInvocationParameters: {
        automationParameters: {
            documentVersion: "string",
            parameters: [{
                name: "string",
                values: ["string"],
            }],
        },
        lambdaParameters: {
            clientContext: "string",
            payload: "string",
            qualifier: "string",
        },
        runCommandParameters: {
            cloudwatchConfig: {
                cloudwatchLogGroupName: "string",
                cloudwatchOutputEnabled: false,
            },
            comment: "string",
            documentHash: "string",
            documentHashType: "string",
            documentVersion: "string",
            notificationConfig: {
                notificationArn: "string",
                notificationEvents: ["string"],
                notificationType: "string",
            },
            outputS3Bucket: "string",
            outputS3KeyPrefix: "string",
            parameters: [{
                name: "string",
                values: ["string"],
            }],
            serviceRoleArn: "string",
            timeoutSeconds: 0,
        },
        stepFunctionsParameters: {
            input: "string",
            name: "string",
        },
    },
});
Copy
type: aws:ssm:MaintenanceWindowTask
properties:
    cutoffBehavior: string
    description: string
    maxConcurrency: string
    maxErrors: string
    name: string
    priority: 0
    serviceRoleArn: string
    targets:
        - key: string
          values:
            - string
    taskArn: string
    taskInvocationParameters:
        automationParameters:
            documentVersion: string
            parameters:
                - name: string
                  values:
                    - string
        lambdaParameters:
            clientContext: string
            payload: string
            qualifier: string
        runCommandParameters:
            cloudwatchConfig:
                cloudwatchLogGroupName: string
                cloudwatchOutputEnabled: false
            comment: string
            documentHash: string
            documentHashType: string
            documentVersion: string
            notificationConfig:
                notificationArn: string
                notificationEvents:
                    - string
                notificationType: string
            outputS3Bucket: string
            outputS3KeyPrefix: string
            parameters:
                - name: string
                  values:
                    - string
            serviceRoleArn: string
            timeoutSeconds: 0
        stepFunctionsParameters:
            input: string
            name: string
    taskType: string
    windowId: string
Copy

MaintenanceWindowTask Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The MaintenanceWindowTask resource accepts the following input properties:

TaskArn This property is required. string
The ARN of the task to execute.
TaskType
This property is required.
Changes to this property will trigger replacement.
string
The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.
WindowId
This property is required.
Changes to this property will trigger replacement.
string
The Id of the maintenance window to register the task with.
CutoffBehavior string
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. Valid values are CONTINUE_TASK and CANCEL_TASK.
Description string
The description of the maintenance window task.
MaxConcurrency string
The maximum number of targets this task can be run for in parallel.
MaxErrors string
The maximum number of errors allowed before this task stops being scheduled.
Name string
The name of the maintenance window task.
Priority int
The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
ServiceRoleArn string
The role that should be assumed when executing the task. If a role is not provided, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created for you.
Targets List<MaintenanceWindowTaskTarget>
The targets (either instances or window target ids). Instances are specified using Key=InstanceIds,Values=instanceid1,instanceid2. Window target ids are specified using Key=WindowTargetIds,Values=window target id1, window target id2.
TaskInvocationParameters MaintenanceWindowTaskTaskInvocationParameters
Configuration block with parameters for task execution.
TaskArn This property is required. string
The ARN of the task to execute.
TaskType
This property is required.
Changes to this property will trigger replacement.
string
The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.
WindowId
This property is required.
Changes to this property will trigger replacement.
string
The Id of the maintenance window to register the task with.
CutoffBehavior string
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. Valid values are CONTINUE_TASK and CANCEL_TASK.
Description string
The description of the maintenance window task.
MaxConcurrency string
The maximum number of targets this task can be run for in parallel.
MaxErrors string
The maximum number of errors allowed before this task stops being scheduled.
Name string
The name of the maintenance window task.
Priority int
The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
ServiceRoleArn string
The role that should be assumed when executing the task. If a role is not provided, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created for you.
Targets []MaintenanceWindowTaskTargetArgs
The targets (either instances or window target ids). Instances are specified using Key=InstanceIds,Values=instanceid1,instanceid2. Window target ids are specified using Key=WindowTargetIds,Values=window target id1, window target id2.
TaskInvocationParameters MaintenanceWindowTaskTaskInvocationParametersArgs
Configuration block with parameters for task execution.
taskArn This property is required. String
The ARN of the task to execute.
taskType
This property is required.
Changes to this property will trigger replacement.
String
The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.
windowId
This property is required.
Changes to this property will trigger replacement.
String
The Id of the maintenance window to register the task with.
cutoffBehavior String
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. Valid values are CONTINUE_TASK and CANCEL_TASK.
description String
The description of the maintenance window task.
maxConcurrency String
The maximum number of targets this task can be run for in parallel.
maxErrors String
The maximum number of errors allowed before this task stops being scheduled.
name String
The name of the maintenance window task.
priority Integer
The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
serviceRoleArn String
The role that should be assumed when executing the task. If a role is not provided, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created for you.
targets List<MaintenanceWindowTaskTarget>
The targets (either instances or window target ids). Instances are specified using Key=InstanceIds,Values=instanceid1,instanceid2. Window target ids are specified using Key=WindowTargetIds,Values=window target id1, window target id2.
taskInvocationParameters MaintenanceWindowTaskTaskInvocationParameters
Configuration block with parameters for task execution.
taskArn This property is required. string
The ARN of the task to execute.
taskType
This property is required.
Changes to this property will trigger replacement.
string
The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.
windowId
This property is required.
Changes to this property will trigger replacement.
string
The Id of the maintenance window to register the task with.
cutoffBehavior string
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. Valid values are CONTINUE_TASK and CANCEL_TASK.
description string
The description of the maintenance window task.
maxConcurrency string
The maximum number of targets this task can be run for in parallel.
maxErrors string
The maximum number of errors allowed before this task stops being scheduled.
name string
The name of the maintenance window task.
priority number
The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
serviceRoleArn string
The role that should be assumed when executing the task. If a role is not provided, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created for you.
targets MaintenanceWindowTaskTarget[]
The targets (either instances or window target ids). Instances are specified using Key=InstanceIds,Values=instanceid1,instanceid2. Window target ids are specified using Key=WindowTargetIds,Values=window target id1, window target id2.
taskInvocationParameters MaintenanceWindowTaskTaskInvocationParameters
Configuration block with parameters for task execution.
task_arn This property is required. str
The ARN of the task to execute.
task_type
This property is required.
Changes to this property will trigger replacement.
str
The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.
window_id
This property is required.
Changes to this property will trigger replacement.
str
The Id of the maintenance window to register the task with.
cutoff_behavior str
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. Valid values are CONTINUE_TASK and CANCEL_TASK.
description str
The description of the maintenance window task.
max_concurrency str
The maximum number of targets this task can be run for in parallel.
max_errors str
The maximum number of errors allowed before this task stops being scheduled.
name str
The name of the maintenance window task.
priority int
The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
service_role_arn str
The role that should be assumed when executing the task. If a role is not provided, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created for you.
targets Sequence[MaintenanceWindowTaskTargetArgs]
The targets (either instances or window target ids). Instances are specified using Key=InstanceIds,Values=instanceid1,instanceid2. Window target ids are specified using Key=WindowTargetIds,Values=window target id1, window target id2.
task_invocation_parameters MaintenanceWindowTaskTaskInvocationParametersArgs
Configuration block with parameters for task execution.
taskArn This property is required. String
The ARN of the task to execute.
taskType
This property is required.
Changes to this property will trigger replacement.
String
The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.
windowId
This property is required.
Changes to this property will trigger replacement.
String
The Id of the maintenance window to register the task with.
cutoffBehavior String
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. Valid values are CONTINUE_TASK and CANCEL_TASK.
description String
The description of the maintenance window task.
maxConcurrency String
The maximum number of targets this task can be run for in parallel.
maxErrors String
The maximum number of errors allowed before this task stops being scheduled.
name String
The name of the maintenance window task.
priority Number
The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
serviceRoleArn String
The role that should be assumed when executing the task. If a role is not provided, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created for you.
targets List<Property Map>
The targets (either instances or window target ids). Instances are specified using Key=InstanceIds,Values=instanceid1,instanceid2. Window target ids are specified using Key=WindowTargetIds,Values=window target id1, window target id2.
taskInvocationParameters Property Map
Configuration block with parameters for task execution.

Outputs

All input properties are implicitly available as output properties. Additionally, the MaintenanceWindowTask resource produces the following output properties:

Arn string
The ARN of the maintenance window task.
Id string
The provider-assigned unique ID for this managed resource.
WindowTaskId string
The ID of the maintenance window task.
Arn string
The ARN of the maintenance window task.
Id string
The provider-assigned unique ID for this managed resource.
WindowTaskId string
The ID of the maintenance window task.
arn String
The ARN of the maintenance window task.
id String
The provider-assigned unique ID for this managed resource.
windowTaskId String
The ID of the maintenance window task.
arn string
The ARN of the maintenance window task.
id string
The provider-assigned unique ID for this managed resource.
windowTaskId string
The ID of the maintenance window task.
arn str
The ARN of the maintenance window task.
id str
The provider-assigned unique ID for this managed resource.
window_task_id str
The ID of the maintenance window task.
arn String
The ARN of the maintenance window task.
id String
The provider-assigned unique ID for this managed resource.
windowTaskId String
The ID of the maintenance window task.

Look up Existing MaintenanceWindowTask Resource

Get an existing MaintenanceWindowTask 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?: MaintenanceWindowTaskState, opts?: CustomResourceOptions): MaintenanceWindowTask
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        cutoff_behavior: Optional[str] = None,
        description: Optional[str] = None,
        max_concurrency: Optional[str] = None,
        max_errors: Optional[str] = None,
        name: Optional[str] = None,
        priority: Optional[int] = None,
        service_role_arn: Optional[str] = None,
        targets: Optional[Sequence[MaintenanceWindowTaskTargetArgs]] = None,
        task_arn: Optional[str] = None,
        task_invocation_parameters: Optional[MaintenanceWindowTaskTaskInvocationParametersArgs] = None,
        task_type: Optional[str] = None,
        window_id: Optional[str] = None,
        window_task_id: Optional[str] = None) -> MaintenanceWindowTask
func GetMaintenanceWindowTask(ctx *Context, name string, id IDInput, state *MaintenanceWindowTaskState, opts ...ResourceOption) (*MaintenanceWindowTask, error)
public static MaintenanceWindowTask Get(string name, Input<string> id, MaintenanceWindowTaskState? state, CustomResourceOptions? opts = null)
public static MaintenanceWindowTask get(String name, Output<String> id, MaintenanceWindowTaskState state, CustomResourceOptions options)
resources:  _:    type: aws:ssm:MaintenanceWindowTask    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Arn string
The ARN of the maintenance window task.
CutoffBehavior string
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. Valid values are CONTINUE_TASK and CANCEL_TASK.
Description string
The description of the maintenance window task.
MaxConcurrency string
The maximum number of targets this task can be run for in parallel.
MaxErrors string
The maximum number of errors allowed before this task stops being scheduled.
Name string
The name of the maintenance window task.
Priority int
The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
ServiceRoleArn string
The role that should be assumed when executing the task. If a role is not provided, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created for you.
Targets List<MaintenanceWindowTaskTarget>
The targets (either instances or window target ids). Instances are specified using Key=InstanceIds,Values=instanceid1,instanceid2. Window target ids are specified using Key=WindowTargetIds,Values=window target id1, window target id2.
TaskArn string
The ARN of the task to execute.
TaskInvocationParameters MaintenanceWindowTaskTaskInvocationParameters
Configuration block with parameters for task execution.
TaskType Changes to this property will trigger replacement. string
The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.
WindowId Changes to this property will trigger replacement. string
The Id of the maintenance window to register the task with.
WindowTaskId string
The ID of the maintenance window task.
Arn string
The ARN of the maintenance window task.
CutoffBehavior string
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. Valid values are CONTINUE_TASK and CANCEL_TASK.
Description string
The description of the maintenance window task.
MaxConcurrency string
The maximum number of targets this task can be run for in parallel.
MaxErrors string
The maximum number of errors allowed before this task stops being scheduled.
Name string
The name of the maintenance window task.
Priority int
The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
ServiceRoleArn string
The role that should be assumed when executing the task. If a role is not provided, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created for you.
Targets []MaintenanceWindowTaskTargetArgs
The targets (either instances or window target ids). Instances are specified using Key=InstanceIds,Values=instanceid1,instanceid2. Window target ids are specified using Key=WindowTargetIds,Values=window target id1, window target id2.
TaskArn string
The ARN of the task to execute.
TaskInvocationParameters MaintenanceWindowTaskTaskInvocationParametersArgs
Configuration block with parameters for task execution.
TaskType Changes to this property will trigger replacement. string
The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.
WindowId Changes to this property will trigger replacement. string
The Id of the maintenance window to register the task with.
WindowTaskId string
The ID of the maintenance window task.
arn String
The ARN of the maintenance window task.
cutoffBehavior String
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. Valid values are CONTINUE_TASK and CANCEL_TASK.
description String
The description of the maintenance window task.
maxConcurrency String
The maximum number of targets this task can be run for in parallel.
maxErrors String
The maximum number of errors allowed before this task stops being scheduled.
name String
The name of the maintenance window task.
priority Integer
The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
serviceRoleArn String
The role that should be assumed when executing the task. If a role is not provided, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created for you.
targets List<MaintenanceWindowTaskTarget>
The targets (either instances or window target ids). Instances are specified using Key=InstanceIds,Values=instanceid1,instanceid2. Window target ids are specified using Key=WindowTargetIds,Values=window target id1, window target id2.
taskArn String
The ARN of the task to execute.
taskInvocationParameters MaintenanceWindowTaskTaskInvocationParameters
Configuration block with parameters for task execution.
taskType Changes to this property will trigger replacement. String
The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.
windowId Changes to this property will trigger replacement. String
The Id of the maintenance window to register the task with.
windowTaskId String
The ID of the maintenance window task.
arn string
The ARN of the maintenance window task.
cutoffBehavior string
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. Valid values are CONTINUE_TASK and CANCEL_TASK.
description string
The description of the maintenance window task.
maxConcurrency string
The maximum number of targets this task can be run for in parallel.
maxErrors string
The maximum number of errors allowed before this task stops being scheduled.
name string
The name of the maintenance window task.
priority number
The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
serviceRoleArn string
The role that should be assumed when executing the task. If a role is not provided, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created for you.
targets MaintenanceWindowTaskTarget[]
The targets (either instances or window target ids). Instances are specified using Key=InstanceIds,Values=instanceid1,instanceid2. Window target ids are specified using Key=WindowTargetIds,Values=window target id1, window target id2.
taskArn string
The ARN of the task to execute.
taskInvocationParameters MaintenanceWindowTaskTaskInvocationParameters
Configuration block with parameters for task execution.
taskType Changes to this property will trigger replacement. string
The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.
windowId Changes to this property will trigger replacement. string
The Id of the maintenance window to register the task with.
windowTaskId string
The ID of the maintenance window task.
arn str
The ARN of the maintenance window task.
cutoff_behavior str
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. Valid values are CONTINUE_TASK and CANCEL_TASK.
description str
The description of the maintenance window task.
max_concurrency str
The maximum number of targets this task can be run for in parallel.
max_errors str
The maximum number of errors allowed before this task stops being scheduled.
name str
The name of the maintenance window task.
priority int
The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
service_role_arn str
The role that should be assumed when executing the task. If a role is not provided, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created for you.
targets Sequence[MaintenanceWindowTaskTargetArgs]
The targets (either instances or window target ids). Instances are specified using Key=InstanceIds,Values=instanceid1,instanceid2. Window target ids are specified using Key=WindowTargetIds,Values=window target id1, window target id2.
task_arn str
The ARN of the task to execute.
task_invocation_parameters MaintenanceWindowTaskTaskInvocationParametersArgs
Configuration block with parameters for task execution.
task_type Changes to this property will trigger replacement. str
The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.
window_id Changes to this property will trigger replacement. str
The Id of the maintenance window to register the task with.
window_task_id str
The ID of the maintenance window task.
arn String
The ARN of the maintenance window task.
cutoffBehavior String
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. Valid values are CONTINUE_TASK and CANCEL_TASK.
description String
The description of the maintenance window task.
maxConcurrency String
The maximum number of targets this task can be run for in parallel.
maxErrors String
The maximum number of errors allowed before this task stops being scheduled.
name String
The name of the maintenance window task.
priority Number
The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
serviceRoleArn String
The role that should be assumed when executing the task. If a role is not provided, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created for you.
targets List<Property Map>
The targets (either instances or window target ids). Instances are specified using Key=InstanceIds,Values=instanceid1,instanceid2. Window target ids are specified using Key=WindowTargetIds,Values=window target id1, window target id2.
taskArn String
The ARN of the task to execute.
taskInvocationParameters Property Map
Configuration block with parameters for task execution.
taskType Changes to this property will trigger replacement. String
The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.
windowId Changes to this property will trigger replacement. String
The Id of the maintenance window to register the task with.
windowTaskId String
The ID of the maintenance window task.

Supporting Types

MaintenanceWindowTaskTarget
, MaintenanceWindowTaskTargetArgs

Key This property is required. string
Values This property is required. List<string>
The array of strings.
Key This property is required. string
Values This property is required. []string
The array of strings.
key This property is required. String
values This property is required. List<String>
The array of strings.
key This property is required. string
values This property is required. string[]
The array of strings.
key This property is required. str
values This property is required. Sequence[str]
The array of strings.
key This property is required. String
values This property is required. List<String>
The array of strings.

MaintenanceWindowTaskTaskInvocationParameters
, MaintenanceWindowTaskTaskInvocationParametersArgs

AutomationParameters MaintenanceWindowTaskTaskInvocationParametersAutomationParameters
The parameters for an AUTOMATION task type. Documented below.
LambdaParameters MaintenanceWindowTaskTaskInvocationParametersLambdaParameters
The parameters for a LAMBDA task type. Documented below.
RunCommandParameters MaintenanceWindowTaskTaskInvocationParametersRunCommandParameters
The parameters for a RUN_COMMAND task type. Documented below.
StepFunctionsParameters MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParameters
The parameters for a STEP_FUNCTIONS task type. Documented below.
AutomationParameters MaintenanceWindowTaskTaskInvocationParametersAutomationParameters
The parameters for an AUTOMATION task type. Documented below.
LambdaParameters MaintenanceWindowTaskTaskInvocationParametersLambdaParameters
The parameters for a LAMBDA task type. Documented below.
RunCommandParameters MaintenanceWindowTaskTaskInvocationParametersRunCommandParameters
The parameters for a RUN_COMMAND task type. Documented below.
StepFunctionsParameters MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParameters
The parameters for a STEP_FUNCTIONS task type. Documented below.
automationParameters MaintenanceWindowTaskTaskInvocationParametersAutomationParameters
The parameters for an AUTOMATION task type. Documented below.
lambdaParameters MaintenanceWindowTaskTaskInvocationParametersLambdaParameters
The parameters for a LAMBDA task type. Documented below.
runCommandParameters MaintenanceWindowTaskTaskInvocationParametersRunCommandParameters
The parameters for a RUN_COMMAND task type. Documented below.
stepFunctionsParameters MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParameters
The parameters for a STEP_FUNCTIONS task type. Documented below.
automationParameters MaintenanceWindowTaskTaskInvocationParametersAutomationParameters
The parameters for an AUTOMATION task type. Documented below.
lambdaParameters MaintenanceWindowTaskTaskInvocationParametersLambdaParameters
The parameters for a LAMBDA task type. Documented below.
runCommandParameters MaintenanceWindowTaskTaskInvocationParametersRunCommandParameters
The parameters for a RUN_COMMAND task type. Documented below.
stepFunctionsParameters MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParameters
The parameters for a STEP_FUNCTIONS task type. Documented below.
automation_parameters MaintenanceWindowTaskTaskInvocationParametersAutomationParameters
The parameters for an AUTOMATION task type. Documented below.
lambda_parameters MaintenanceWindowTaskTaskInvocationParametersLambdaParameters
The parameters for a LAMBDA task type. Documented below.
run_command_parameters MaintenanceWindowTaskTaskInvocationParametersRunCommandParameters
The parameters for a RUN_COMMAND task type. Documented below.
step_functions_parameters MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParameters
The parameters for a STEP_FUNCTIONS task type. Documented below.
automationParameters Property Map
The parameters for an AUTOMATION task type. Documented below.
lambdaParameters Property Map
The parameters for a LAMBDA task type. Documented below.
runCommandParameters Property Map
The parameters for a RUN_COMMAND task type. Documented below.
stepFunctionsParameters Property Map
The parameters for a STEP_FUNCTIONS task type. Documented below.

MaintenanceWindowTaskTaskInvocationParametersAutomationParameters
, MaintenanceWindowTaskTaskInvocationParametersAutomationParametersArgs

DocumentVersion string
The version of an Automation document to use during task execution.
Parameters List<MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameter>
The parameters for the RUN_COMMAND task execution. Documented below.
DocumentVersion string
The version of an Automation document to use during task execution.
Parameters []MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameter
The parameters for the RUN_COMMAND task execution. Documented below.
documentVersion String
The version of an Automation document to use during task execution.
parameters List<MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameter>
The parameters for the RUN_COMMAND task execution. Documented below.
documentVersion string
The version of an Automation document to use during task execution.
parameters MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameter[]
The parameters for the RUN_COMMAND task execution. Documented below.
document_version str
The version of an Automation document to use during task execution.
parameters Sequence[MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameter]
The parameters for the RUN_COMMAND task execution. Documented below.
documentVersion String
The version of an Automation document to use during task execution.
parameters List<Property Map>
The parameters for the RUN_COMMAND task execution. Documented below.

MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameter
, MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameterArgs

Name This property is required. string
The parameter name.
Values This property is required. List<string>
The array of strings.
Name This property is required. string
The parameter name.
Values This property is required. []string
The array of strings.
name This property is required. String
The parameter name.
values This property is required. List<String>
The array of strings.
name This property is required. string
The parameter name.
values This property is required. string[]
The array of strings.
name This property is required. str
The parameter name.
values This property is required. Sequence[str]
The array of strings.
name This property is required. String
The parameter name.
values This property is required. List<String>
The array of strings.

MaintenanceWindowTaskTaskInvocationParametersLambdaParameters
, MaintenanceWindowTaskTaskInvocationParametersLambdaParametersArgs

ClientContext string
Pass client-specific information to the Lambda function that you are invoking.
Payload string
JSON to provide to your Lambda function as input.
Qualifier string
Specify a Lambda function version or alias name.
ClientContext string
Pass client-specific information to the Lambda function that you are invoking.
Payload string
JSON to provide to your Lambda function as input.
Qualifier string
Specify a Lambda function version or alias name.
clientContext String
Pass client-specific information to the Lambda function that you are invoking.
payload String
JSON to provide to your Lambda function as input.
qualifier String
Specify a Lambda function version or alias name.
clientContext string
Pass client-specific information to the Lambda function that you are invoking.
payload string
JSON to provide to your Lambda function as input.
qualifier string
Specify a Lambda function version or alias name.
client_context str
Pass client-specific information to the Lambda function that you are invoking.
payload str
JSON to provide to your Lambda function as input.
qualifier str
Specify a Lambda function version or alias name.
clientContext String
Pass client-specific information to the Lambda function that you are invoking.
payload String
JSON to provide to your Lambda function as input.
qualifier String
Specify a Lambda function version or alias name.

MaintenanceWindowTaskTaskInvocationParametersRunCommandParameters
, MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersArgs

CloudwatchConfig MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersCloudwatchConfig
Configuration options for sending command output to CloudWatch Logs. Documented below.
Comment string
Information about the command(s) to execute.
DocumentHash string
The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
DocumentHashType string
SHA-256 or SHA-1. SHA-1 hashes have been deprecated. Valid values: Sha256 and Sha1
DocumentVersion string
The version of an Automation document to use during task execution.
NotificationConfig MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfig
Configurations for sending notifications about command status changes on a per-instance basis. Documented below.
OutputS3Bucket string
The name of the Amazon S3 bucket.
OutputS3KeyPrefix string
The Amazon S3 bucket subfolder.
Parameters List<MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameter>
The parameters for the RUN_COMMAND task execution. Documented below.
ServiceRoleArn string
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
TimeoutSeconds int
If this time is reached and the command has not already started executing, it doesn't run.
CloudwatchConfig MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersCloudwatchConfig
Configuration options for sending command output to CloudWatch Logs. Documented below.
Comment string
Information about the command(s) to execute.
DocumentHash string
The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
DocumentHashType string
SHA-256 or SHA-1. SHA-1 hashes have been deprecated. Valid values: Sha256 and Sha1
DocumentVersion string
The version of an Automation document to use during task execution.
NotificationConfig MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfig
Configurations for sending notifications about command status changes on a per-instance basis. Documented below.
OutputS3Bucket string
The name of the Amazon S3 bucket.
OutputS3KeyPrefix string
The Amazon S3 bucket subfolder.
Parameters []MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameter
The parameters for the RUN_COMMAND task execution. Documented below.
ServiceRoleArn string
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
TimeoutSeconds int
If this time is reached and the command has not already started executing, it doesn't run.
cloudwatchConfig MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersCloudwatchConfig
Configuration options for sending command output to CloudWatch Logs. Documented below.
comment String
Information about the command(s) to execute.
documentHash String
The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
documentHashType String
SHA-256 or SHA-1. SHA-1 hashes have been deprecated. Valid values: Sha256 and Sha1
documentVersion String
The version of an Automation document to use during task execution.
notificationConfig MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfig
Configurations for sending notifications about command status changes on a per-instance basis. Documented below.
outputS3Bucket String
The name of the Amazon S3 bucket.
outputS3KeyPrefix String
The Amazon S3 bucket subfolder.
parameters List<MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameter>
The parameters for the RUN_COMMAND task execution. Documented below.
serviceRoleArn String
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
timeoutSeconds Integer
If this time is reached and the command has not already started executing, it doesn't run.
cloudwatchConfig MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersCloudwatchConfig
Configuration options for sending command output to CloudWatch Logs. Documented below.
comment string
Information about the command(s) to execute.
documentHash string
The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
documentHashType string
SHA-256 or SHA-1. SHA-1 hashes have been deprecated. Valid values: Sha256 and Sha1
documentVersion string
The version of an Automation document to use during task execution.
notificationConfig MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfig
Configurations for sending notifications about command status changes on a per-instance basis. Documented below.
outputS3Bucket string
The name of the Amazon S3 bucket.
outputS3KeyPrefix string
The Amazon S3 bucket subfolder.
parameters MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameter[]
The parameters for the RUN_COMMAND task execution. Documented below.
serviceRoleArn string
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
timeoutSeconds number
If this time is reached and the command has not already started executing, it doesn't run.
cloudwatch_config MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersCloudwatchConfig
Configuration options for sending command output to CloudWatch Logs. Documented below.
comment str
Information about the command(s) to execute.
document_hash str
The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
document_hash_type str
SHA-256 or SHA-1. SHA-1 hashes have been deprecated. Valid values: Sha256 and Sha1
document_version str
The version of an Automation document to use during task execution.
notification_config MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfig
Configurations for sending notifications about command status changes on a per-instance basis. Documented below.
output_s3_bucket str
The name of the Amazon S3 bucket.
output_s3_key_prefix str
The Amazon S3 bucket subfolder.
parameters Sequence[MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameter]
The parameters for the RUN_COMMAND task execution. Documented below.
service_role_arn str
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
timeout_seconds int
If this time is reached and the command has not already started executing, it doesn't run.
cloudwatchConfig Property Map
Configuration options for sending command output to CloudWatch Logs. Documented below.
comment String
Information about the command(s) to execute.
documentHash String
The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
documentHashType String
SHA-256 or SHA-1. SHA-1 hashes have been deprecated. Valid values: Sha256 and Sha1
documentVersion String
The version of an Automation document to use during task execution.
notificationConfig Property Map
Configurations for sending notifications about command status changes on a per-instance basis. Documented below.
outputS3Bucket String
The name of the Amazon S3 bucket.
outputS3KeyPrefix String
The Amazon S3 bucket subfolder.
parameters List<Property Map>
The parameters for the RUN_COMMAND task execution. Documented below.
serviceRoleArn String
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
timeoutSeconds Number
If this time is reached and the command has not already started executing, it doesn't run.

MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersCloudwatchConfig
, MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersCloudwatchConfigArgs

CloudwatchLogGroupName string
The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.
CloudwatchOutputEnabled bool
Enables Systems Manager to send command output to CloudWatch Logs.
CloudwatchLogGroupName string
The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.
CloudwatchOutputEnabled bool
Enables Systems Manager to send command output to CloudWatch Logs.
cloudwatchLogGroupName String
The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.
cloudwatchOutputEnabled Boolean
Enables Systems Manager to send command output to CloudWatch Logs.
cloudwatchLogGroupName string
The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.
cloudwatchOutputEnabled boolean
Enables Systems Manager to send command output to CloudWatch Logs.
cloudwatch_log_group_name str
The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.
cloudwatch_output_enabled bool
Enables Systems Manager to send command output to CloudWatch Logs.
cloudwatchLogGroupName String
The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.
cloudwatchOutputEnabled Boolean
Enables Systems Manager to send command output to CloudWatch Logs.

MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfig
, MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfigArgs

NotificationArn string
An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.
NotificationEvents List<string>
The different events for which you can receive notifications. Valid values: All, InProgress, Success, TimedOut, Cancelled, and Failed
NotificationType string
When specified with Command, receive notification when the status of a command changes. When specified with Invocation, for commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes. Valid values: Command and Invocation
NotificationArn string
An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.
NotificationEvents []string
The different events for which you can receive notifications. Valid values: All, InProgress, Success, TimedOut, Cancelled, and Failed
NotificationType string
When specified with Command, receive notification when the status of a command changes. When specified with Invocation, for commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes. Valid values: Command and Invocation
notificationArn String
An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.
notificationEvents List<String>
The different events for which you can receive notifications. Valid values: All, InProgress, Success, TimedOut, Cancelled, and Failed
notificationType String
When specified with Command, receive notification when the status of a command changes. When specified with Invocation, for commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes. Valid values: Command and Invocation
notificationArn string
An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.
notificationEvents string[]
The different events for which you can receive notifications. Valid values: All, InProgress, Success, TimedOut, Cancelled, and Failed
notificationType string
When specified with Command, receive notification when the status of a command changes. When specified with Invocation, for commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes. Valid values: Command and Invocation
notification_arn str
An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.
notification_events Sequence[str]
The different events for which you can receive notifications. Valid values: All, InProgress, Success, TimedOut, Cancelled, and Failed
notification_type str
When specified with Command, receive notification when the status of a command changes. When specified with Invocation, for commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes. Valid values: Command and Invocation
notificationArn String
An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.
notificationEvents List<String>
The different events for which you can receive notifications. Valid values: All, InProgress, Success, TimedOut, Cancelled, and Failed
notificationType String
When specified with Command, receive notification when the status of a command changes. When specified with Invocation, for commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes. Valid values: Command and Invocation

MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameter
, MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameterArgs

Name This property is required. string
The parameter name.
Values This property is required. List<string>
The array of strings.
Name This property is required. string
The parameter name.
Values This property is required. []string
The array of strings.
name This property is required. String
The parameter name.
values This property is required. List<String>
The array of strings.
name This property is required. string
The parameter name.
values This property is required. string[]
The array of strings.
name This property is required. str
The parameter name.
values This property is required. Sequence[str]
The array of strings.
name This property is required. String
The parameter name.
values This property is required. List<String>
The array of strings.

MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParameters
, MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParametersArgs

Input string
The inputs for the STEP_FUNCTION task.
Name string
The name of the STEP_FUNCTION task.
Input string
The inputs for the STEP_FUNCTION task.
Name string
The name of the STEP_FUNCTION task.
input String
The inputs for the STEP_FUNCTION task.
name String
The name of the STEP_FUNCTION task.
input string
The inputs for the STEP_FUNCTION task.
name string
The name of the STEP_FUNCTION task.
input str
The inputs for the STEP_FUNCTION task.
name str
The name of the STEP_FUNCTION task.
input String
The inputs for the STEP_FUNCTION task.
name String
The name of the STEP_FUNCTION task.

Import

Using pulumi import, import AWS Maintenance Window Task using the window_id and window_task_id separated by /. For example:

$ pulumi import aws:ssm/maintenanceWindowTask:MaintenanceWindowTask task <window_id>/<window_task_id>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws