aws logo
AWS Classic v5.28.0, Jan 23 23

aws.ssm.MaintenanceWindowTask

Provides an SSM Maintenance Window Task resource

Example Usage

Automation Tasks

using System.Collections.Generic;
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 = aws_ssm_maintenance_window.Example.Id,
        Targets = new[]
        {
            new Aws.Ssm.Inputs.MaintenanceWindowTaskTargetArgs
            {
                Key = "InstanceIds",
                Values = new[]
                {
                    aws_instance.Example.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[]
                        {
                            aws_instance.Example.Id,
                        },
                    },
                },
            },
        },
    });

});
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v5/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(aws_ssm_maintenance_window.Example.Id),
			Targets: ssm.MaintenanceWindowTaskTargetArray{
				&ssm.MaintenanceWindowTaskTargetArgs{
					Key: pulumi.String("InstanceIds"),
					Values: pulumi.StringArray{
						aws_instance.Example.Id,
					},
				},
			},
			TaskInvocationParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersArgs{
				AutomationParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersArgs{
					DocumentVersion: pulumi.String(fmt.Sprintf("$LATEST")),
					Parameters: ssm.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameterArray{
						&ssm.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameterArgs{
							Name: pulumi.String("InstanceId"),
							Values: pulumi.StringArray{
								aws_instance.Example.Id,
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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(aws_ssm_maintenance_window.example().id())
            .targets(MaintenanceWindowTaskTargetArgs.builder()
                .key("InstanceIds")
                .values(aws_instance.example().id())
                .build())
            .taskInvocationParameters(MaintenanceWindowTaskTaskInvocationParametersArgs.builder()
                .automationParameters(MaintenanceWindowTaskTaskInvocationParametersAutomationParametersArgs.builder()
                    .documentVersion("$LATEST")
                    .parameters(MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameterArgs.builder()
                        .name("InstanceId")
                        .values(aws_instance.example().id())
                        .build())
                    .build())
                .build())
            .build());

    }
}
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=aws_ssm_maintenance_window["example"]["id"],
    targets=[aws.ssm.MaintenanceWindowTaskTargetArgs(
        key="InstanceIds",
        values=[aws_instance["example"]["id"]],
    )],
    task_invocation_parameters=aws.ssm.MaintenanceWindowTaskTaskInvocationParametersArgs(
        automation_parameters=aws.ssm.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersArgs(
            document_version="$LATEST",
            parameters=[aws.ssm.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameterArgs(
                name="InstanceId",
                values=[aws_instance["example"]["id"]],
            )],
        ),
    ))
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: aws_ssm_maintenance_window.example.id,
    targets: [{
        key: "InstanceIds",
        values: [aws_instance.example.id],
    }],
    taskInvocationParameters: {
        automationParameters: {
            documentVersion: `$LATEST`,
            parameters: [{
                name: "InstanceId",
                values: [aws_instance.example.id],
            }],
        },
    },
});
resources:
  example:
    type: aws:ssm:MaintenanceWindowTask
    properties:
      maxConcurrency: 2
      maxErrors: 1
      priority: 1
      taskArn: AWS-RestartEC2Instance
      taskType: AUTOMATION
      windowId: ${aws_ssm_maintenance_window.example.id}
      targets:
        - key: InstanceIds
          values:
            - ${aws_instance.example.id}
      taskInvocationParameters:
        automationParameters:
          documentVersion: $LATEST
          parameters:
            - name: InstanceId
              values:
                - ${aws_instance.example.id}

Run Command Tasks

using System.Collections.Generic;
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 = aws_ssm_maintenance_window.Example.Id,
        Targets = new[]
        {
            new Aws.Ssm.Inputs.MaintenanceWindowTaskTargetArgs
            {
                Key = "InstanceIds",
                Values = new[]
                {
                    aws_instance.Example.Id,
                },
            },
        },
        TaskInvocationParameters = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersArgs
        {
            RunCommandParameters = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersArgs
            {
                OutputS3Bucket = aws_s3_bucket.Example.Bucket,
                OutputS3KeyPrefix = "output",
                ServiceRoleArn = aws_iam_role.Example.Arn,
                TimeoutSeconds = 600,
                NotificationConfig = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfigArgs
                {
                    NotificationArn = aws_sns_topic.Example.Arn,
                    NotificationEvents = new[]
                    {
                        "All",
                    },
                    NotificationType = "Command",
                },
                Parameters = new[]
                {
                    new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameterArgs
                    {
                        Name = "commands",
                        Values = new[]
                        {
                            "date",
                        },
                    },
                },
            },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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(aws_ssm_maintenance_window.Example.Id),
			Targets: ssm.MaintenanceWindowTaskTargetArray{
				&ssm.MaintenanceWindowTaskTargetArgs{
					Key: pulumi.String("InstanceIds"),
					Values: pulumi.StringArray{
						aws_instance.Example.Id,
					},
				},
			},
			TaskInvocationParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersArgs{
				RunCommandParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersArgs{
					OutputS3Bucket:    pulumi.Any(aws_s3_bucket.Example.Bucket),
					OutputS3KeyPrefix: pulumi.String("output"),
					ServiceRoleArn:    pulumi.Any(aws_iam_role.Example.Arn),
					TimeoutSeconds:    pulumi.Int(600),
					NotificationConfig: &ssm.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfigArgs{
						NotificationArn: pulumi.Any(aws_sns_topic.Example.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
	})
}
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(aws_ssm_maintenance_window.example().id())
            .targets(MaintenanceWindowTaskTargetArgs.builder()
                .key("InstanceIds")
                .values(aws_instance.example().id())
                .build())
            .taskInvocationParameters(MaintenanceWindowTaskTaskInvocationParametersArgs.builder()
                .runCommandParameters(MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersArgs.builder()
                    .outputS3Bucket(aws_s3_bucket.example().bucket())
                    .outputS3KeyPrefix("output")
                    .serviceRoleArn(aws_iam_role.example().arn())
                    .timeoutSeconds(600)
                    .notificationConfig(MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfigArgs.builder()
                        .notificationArn(aws_sns_topic.example().arn())
                        .notificationEvents("All")
                        .notificationType("Command")
                        .build())
                    .parameters(MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameterArgs.builder()
                        .name("commands")
                        .values("date")
                        .build())
                    .build())
                .build())
            .build());

    }
}
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=aws_ssm_maintenance_window["example"]["id"],
    targets=[aws.ssm.MaintenanceWindowTaskTargetArgs(
        key="InstanceIds",
        values=[aws_instance["example"]["id"]],
    )],
    task_invocation_parameters=aws.ssm.MaintenanceWindowTaskTaskInvocationParametersArgs(
        run_command_parameters=aws.ssm.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersArgs(
            output_s3_bucket=aws_s3_bucket["example"]["bucket"],
            output_s3_key_prefix="output",
            service_role_arn=aws_iam_role["example"]["arn"],
            timeout_seconds=600,
            notification_config=aws.ssm.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfigArgs(
                notification_arn=aws_sns_topic["example"]["arn"],
                notification_events=["All"],
                notification_type="Command",
            ),
            parameters=[aws.ssm.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameterArgs(
                name="commands",
                values=["date"],
            )],
        ),
    ))
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: aws_ssm_maintenance_window.example.id,
    targets: [{
        key: "InstanceIds",
        values: [aws_instance.example.id],
    }],
    taskInvocationParameters: {
        runCommandParameters: {
            outputS3Bucket: aws_s3_bucket.example.bucket,
            outputS3KeyPrefix: "output",
            serviceRoleArn: aws_iam_role.example.arn,
            timeoutSeconds: 600,
            notificationConfig: {
                notificationArn: aws_sns_topic.example.arn,
                notificationEvents: ["All"],
                notificationType: "Command",
            },
            parameters: [{
                name: "commands",
                values: ["date"],
            }],
        },
    },
});
resources:
  example:
    type: aws:ssm:MaintenanceWindowTask
    properties:
      maxConcurrency: 2
      maxErrors: 1
      priority: 1
      taskArn: AWS-RunShellScript
      taskType: RUN_COMMAND
      windowId: ${aws_ssm_maintenance_window.example.id}
      targets:
        - key: InstanceIds
          values:
            - ${aws_instance.example.id}
      taskInvocationParameters:
        runCommandParameters:
          outputS3Bucket: ${aws_s3_bucket.example.bucket}
          outputS3KeyPrefix: output
          serviceRoleArn: ${aws_iam_role.example.arn}
          timeoutSeconds: 600
          notificationConfig:
            notificationArn: ${aws_sns_topic.example.arn}
            notificationEvents:
              - All
            notificationType: Command
          parameters:
            - name: commands
              values:
                - date

Step Function Tasks

using System.Collections.Generic;
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_sfn_activity.Example.Id,
        TaskType = "STEP_FUNCTIONS",
        WindowId = aws_ssm_maintenance_window.Example.Id,
        Targets = new[]
        {
            new Aws.Ssm.Inputs.MaintenanceWindowTaskTargetArgs
            {
                Key = "InstanceIds",
                Values = new[]
                {
                    aws_instance.Example.Id,
                },
            },
        },
        TaskInvocationParameters = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersArgs
        {
            StepFunctionsParameters = new Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParametersArgs
            {
                Input = "{\"key1\":\"value1\"}",
                Name = "example",
            },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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(aws_sfn_activity.Example.Id),
			TaskType:       pulumi.String("STEP_FUNCTIONS"),
			WindowId:       pulumi.Any(aws_ssm_maintenance_window.Example.Id),
			Targets: ssm.MaintenanceWindowTaskTargetArray{
				&ssm.MaintenanceWindowTaskTargetArgs{
					Key: pulumi.String("InstanceIds"),
					Values: pulumi.StringArray{
						aws_instance.Example.Id,
					},
				},
			},
			TaskInvocationParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersArgs{
				StepFunctionsParameters: &ssm.MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParametersArgs{
					Input: pulumi.String("{\"key1\":\"value1\"}"),
					Name:  pulumi.String("example"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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(aws_sfn_activity.example().id())
            .taskType("STEP_FUNCTIONS")
            .windowId(aws_ssm_maintenance_window.example().id())
            .targets(MaintenanceWindowTaskTargetArgs.builder()
                .key("InstanceIds")
                .values(aws_instance.example().id())
                .build())
            .taskInvocationParameters(MaintenanceWindowTaskTaskInvocationParametersArgs.builder()
                .stepFunctionsParameters(MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParametersArgs.builder()
                    .input("{\"key1\":\"value1\"}")
                    .name("example")
                    .build())
                .build())
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.ssm.MaintenanceWindowTask("example",
    max_concurrency="2",
    max_errors="1",
    priority=1,
    task_arn=aws_sfn_activity["example"]["id"],
    task_type="STEP_FUNCTIONS",
    window_id=aws_ssm_maintenance_window["example"]["id"],
    targets=[aws.ssm.MaintenanceWindowTaskTargetArgs(
        key="InstanceIds",
        values=[aws_instance["example"]["id"]],
    )],
    task_invocation_parameters=aws.ssm.MaintenanceWindowTaskTaskInvocationParametersArgs(
        step_functions_parameters=aws.ssm.MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParametersArgs(
            input="{\"key1\":\"value1\"}",
            name="example",
        ),
    ))
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_sfn_activity.example.id,
    taskType: "STEP_FUNCTIONS",
    windowId: aws_ssm_maintenance_window.example.id,
    targets: [{
        key: "InstanceIds",
        values: [aws_instance.example.id],
    }],
    taskInvocationParameters: {
        stepFunctionsParameters: {
            input: "{\"key1\":\"value1\"}",
            name: "example",
        },
    },
});
resources:
  example:
    type: aws:ssm:MaintenanceWindowTask
    properties:
      maxConcurrency: 2
      maxErrors: 1
      priority: 1
      taskArn: ${aws_sfn_activity.example.id}
      taskType: STEP_FUNCTIONS
      windowId: ${aws_ssm_maintenance_window.example.id}
      targets:
        - key: InstanceIds
          values:
            - ${aws_instance.example.id}
      taskInvocationParameters:
        stepFunctionsParameters:
          input: '{"key1":"value1"}'
          name: example

Create MaintenanceWindowTask Resource

new MaintenanceWindowTask(name: string, args: MaintenanceWindowTaskArgs, opts?: CustomResourceOptions);
@overload
def MaintenanceWindowTask(resource_name: str,
                          opts: Optional[ResourceOptions] = 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)
@overload
def MaintenanceWindowTask(resource_name: str,
                          args: MaintenanceWindowTaskArgs,
                          opts: Optional[ResourceOptions] = 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.

name string
The unique name of the resource.
args MaintenanceWindowTaskArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args 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 string
The unique name of the resource.
args MaintenanceWindowTaskArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args MaintenanceWindowTaskArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args MaintenanceWindowTaskArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The MaintenanceWindowTask resource accepts the following input properties:

TaskArn string

The ARN of the task to execute.

TaskType string

The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.

WindowId 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<Pulumi.Aws.Ssm.Inputs.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 Pulumi.Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersArgs

Configuration block with parameters for task execution.

TaskArn string

The ARN of the task to execute.

TaskType string

The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.

WindowId 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 String

The ARN of the task to execute.

taskType String

The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.

windowId 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<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 string

The ARN of the task to execute.

taskType string

The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.

windowId 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 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.

task_arn str

The ARN of the task to execute.

task_type str

The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.

window_id 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 String

The ARN of the task to execute.

taskType String

The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.

windowId 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)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
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<Pulumi.Aws.Ssm.Inputs.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 Pulumi.Aws.Ssm.Inputs.MaintenanceWindowTaskTaskInvocationParametersArgs

Configuration block with parameters for task execution.

TaskType string

The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.

WindowId 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 string

The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.

WindowId 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<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 String

The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.

windowId 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 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 string

The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.

windowId 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 str

The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.

window_id 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 String

The type of task being registered. Valid values: AUTOMATION, LAMBDA, RUN_COMMAND or STEP_FUNCTIONS.

windowId String

The Id of the maintenance window to register the task with.

windowTaskId String

The ID of the maintenance window task.

Supporting Types

MaintenanceWindowTaskTarget

Key string
Values List<string>

The array of strings.

Key string
Values []string

The array of strings.

key String
values List<String>

The array of strings.

key string
values string[]

The array of strings.

key str
values Sequence[str]

The array of strings.

key String
values List<String>

The array of strings.

MaintenanceWindowTaskTaskInvocationParameters

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

DocumentVersion string

The version of an Automation document to use during task execution.

Parameters List<Pulumi.Aws.Ssm.Inputs.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

Name string

The parameter name.

Values List<string>

The array of strings.

Name string

The parameter name.

Values []string

The array of strings.

name String

The parameter name.

values List<String>

The array of strings.

name string

The parameter name.

values string[]

The array of strings.

name str

The parameter name.

values Sequence[str]

The array of strings.

name String

The parameter name.

values List<String>

The array of strings.

MaintenanceWindowTaskTaskInvocationParametersLambdaParameters

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

CloudwatchConfig Pulumi.Aws.Ssm.Inputs.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 Pulumi.Aws.Ssm.Inputs.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<Pulumi.Aws.Ssm.Inputs.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

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

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

Name string

The parameter name.

Values List<string>

The array of strings.

Name string

The parameter name.

Values []string

The array of strings.

name String

The parameter name.

values List<String>

The array of strings.

name string

The parameter name.

values string[]

The array of strings.

name str

The parameter name.

values Sequence[str]

The array of strings.

name String

The parameter name.

values List<String>

The array of strings.

MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParameters

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

AWS Maintenance Window Task can be imported using the window_id and window_task_id separated by /.

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

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.