java.lang.Object
- com.pulumi.resources.Resource
- - com.pulumi.resources.CustomResource
  - - com.pulumi.aws.ssm.MaintenanceWindowTask

public class MaintenanceWindowTask
extends com.pulumi.resources.CustomResource

Provides an SSM Maintenance Window Task resource ## Example Usage ### Automation Tasks

 
 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.MaintenanceWindowTaskTaskInvocationParametersArgs;
 import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersArgs;
 import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameterArgs;
 import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTargetArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new MaintenanceWindowTask("example", MaintenanceWindowTaskArgs.builder()
             .taskInvocationParameters(MaintenanceWindowTaskTaskInvocationParametersArgs.builder()
                 .automationParameters(MaintenanceWindowTaskTaskInvocationParametersAutomationParametersArgs.builder()
                     .parameters(MaintenanceWindowTaskTaskInvocationParametersAutomationParametersParameterArgs.builder()
                         .name("InstanceId")
                         .values(exampleAwsInstance.id())
                         .build())
                     .documentVersion("$LATEST")
                     .build())
                 .build())
             .targets(MaintenanceWindowTaskTargetArgs.builder()
                 .key("InstanceIds")
                 .values(exampleAwsInstance.id())
                 .build())
             .maxConcurrency("2")
             .maxErrors("1")
             .priority(1)
             .taskArn("AWS-RestartEC2Instance")
             .taskType("AUTOMATION")
             .windowId(exampleAwsSsmMaintenanceWindow.id())
             .build());
 
     }
 }

### Lambda Tasks

 
 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.MaintenanceWindowTaskTaskInvocationParametersArgs;
 import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTaskInvocationParametersLambdaParametersArgs;
 import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTargetArgs;
 import com.pulumi.std.StdFunctions;
 import com.pulumi.std.inputs.Base64encodeArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new MaintenanceWindowTask("example", MaintenanceWindowTaskArgs.builder()
             .taskInvocationParameters(MaintenanceWindowTaskTaskInvocationParametersArgs.builder()
                 .lambdaParameters(MaintenanceWindowTaskTaskInvocationParametersLambdaParametersArgs.builder()
                     .clientContext(StdFunctions.base64encode(Base64encodeArgs.builder()
                         .input("{\"key1\":\"value1\"}")
                         .build()).result())
                     .payload("{\"key1\":\"value1\"}")
                     .build())
                 .build())
             .targets(MaintenanceWindowTaskTargetArgs.builder()
                 .key("InstanceIds")
                 .values(exampleAwsInstance.id())
                 .build())
             .maxConcurrency("2")
             .maxErrors("1")
             .priority(1)
             .taskArn(exampleAwsLambdaFunction.arn())
             .taskType("LAMBDA")
             .windowId(exampleAwsSsmMaintenanceWindow.id())
             .build());
 
     }
 }

### Run Command Tasks

 
 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.MaintenanceWindowTaskTaskInvocationParametersArgs;
 import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersArgs;
 import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfigArgs;
 import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameterArgs;
 import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTargetArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new MaintenanceWindowTask("example", MaintenanceWindowTaskArgs.builder()
             .taskInvocationParameters(MaintenanceWindowTaskTaskInvocationParametersArgs.builder()
                 .runCommandParameters(MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersArgs.builder()
                     .notificationConfig(MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersNotificationConfigArgs.builder()
                         .notificationArn(exampleAwsSnsTopic.arn())
                         .notificationEvents("All")
                         .notificationType("Command")
                         .build())
                     .parameters(MaintenanceWindowTaskTaskInvocationParametersRunCommandParametersParameterArgs.builder()
                         .name("commands")
                         .values("date")
                         .build())
                     .outputS3Bucket(exampleAwsS3Bucket.id())
                     .outputS3KeyPrefix("output")
                     .serviceRoleArn(exampleAwsIamRole.arn())
                     .timeoutSeconds(600)
                     .build())
                 .build())
             .targets(MaintenanceWindowTaskTargetArgs.builder()
                 .key("InstanceIds")
                 .values(exampleAwsInstance.id())
                 .build())
             .maxConcurrency("2")
             .maxErrors("1")
             .priority(1)
             .taskArn("AWS-RunShellScript")
             .taskType("RUN_COMMAND")
             .windowId(exampleAwsSsmMaintenanceWindow.id())
             .build());
 
     }
 }

### Step Function Tasks

 
 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.MaintenanceWindowTaskTaskInvocationParametersArgs;
 import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParametersArgs;
 import com.pulumi.aws.ssm.inputs.MaintenanceWindowTaskTargetArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new MaintenanceWindowTask("example", MaintenanceWindowTaskArgs.builder()
             .taskInvocationParameters(MaintenanceWindowTaskTaskInvocationParametersArgs.builder()
                 .stepFunctionsParameters(MaintenanceWindowTaskTaskInvocationParametersStepFunctionsParametersArgs.builder()
                     .input("{\"key1\":\"value1\"}")
                     .name("example")
                     .build())
                 .build())
             .targets(MaintenanceWindowTaskTargetArgs.builder()
                 .key("InstanceIds")
                 .values(exampleAwsInstance.id())
                 .build())
             .maxConcurrency("2")
             .maxErrors("1")
             .priority(1)
             .taskArn(exampleAwsSfnActivity.id())
             .taskType("STEP_FUNCTIONS")
             .windowId(exampleAwsSsmMaintenanceWindow.id())
             .build());
 
     }
 }

## Import ### Identity Schema #### Required * `windowId` - (String) ID of the maintenance window. * `id` - (String) ID of the maintenance window task. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import AWS Maintenance Window Task using the `windowId` and `windowTaskId` separated by `/`. For example: ```sh $ pulumi import aws:ssm/maintenanceWindowTask:MaintenanceWindowTask example <window_id>/<window_task_id> ```

Nested Class Summary
- Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource
  com.pulumi.resources.CustomResource.CustomResourceInternal
- Nested classes/interfaces inherited from class com.pulumi.resources.Resource
  com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

Field Summary
- Fields inherited from class com.pulumi.resources.Resource
  childResources, remote

Constructor Summary

Constructors
Constructor	Description
`MaintenanceWindowTask(java.lang.String name)`
`MaintenanceWindowTask(java.lang.String name, MaintenanceWindowTaskArgs args)`
`MaintenanceWindowTask(java.lang.String name, MaintenanceWindowTaskArgs args, com.pulumi.resources.CustomResourceOptions options)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`com.pulumi.core.Output<java.lang.String>`	`arn()`
`com.pulumi.core.Output<java.util.Optional<java.lang.String>>`	`cutoffBehavior()`
`com.pulumi.core.Output<java.util.Optional<java.lang.String>>`	`description()`
`static MaintenanceWindowTask`	`get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, MaintenanceWindowTaskState state, com.pulumi.resources.CustomResourceOptions options)`	Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
`com.pulumi.core.Output<java.lang.String>`	`maxConcurrency()`
`com.pulumi.core.Output<java.lang.String>`	`maxErrors()`
`com.pulumi.core.Output<java.lang.String>`	`name()`
`com.pulumi.core.Output<java.util.Optional<java.lang.Integer>>`	`priority()`
`com.pulumi.core.Output<java.lang.String>`	`region()`
`com.pulumi.core.Output<java.lang.String>`	`serviceRoleArn()`
`com.pulumi.core.Output<java.util.Optional<java.util.List<MaintenanceWindowTaskTarget>>>`	`targets()`
`com.pulumi.core.Output<java.lang.String>`	`taskArn()`
`com.pulumi.core.Output<java.util.Optional<MaintenanceWindowTaskTaskInvocationParameters>>`	`taskInvocationParameters()`
`com.pulumi.core.Output<java.lang.String>`	`taskType()`
`com.pulumi.core.Output<java.lang.String>`	`windowId()`
`com.pulumi.core.Output<java.lang.String>`	`windowTaskId()`

Methods inherited from class com.pulumi.resources.CustomResource
getId, id, idFuture

Methods inherited from class com.pulumi.resources.Resource
getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MaintenanceWindowTask
```
public MaintenanceWindowTask(java.lang.String name)
```
    Parameters:
    
    name - The _unique_ name of the resulting resource.
  - MaintenanceWindowTask
```
public MaintenanceWindowTask(java.lang.String name,
                             MaintenanceWindowTaskArgs args)
```
    Parameters:
    
    name - The _unique_ name of the resulting resource.
    
    args - The arguments to use to populate this resource's properties.
  - MaintenanceWindowTask
```
public MaintenanceWindowTask(java.lang.String name,
                             MaintenanceWindowTaskArgs args,
                             @Nullable
                             com.pulumi.resources.CustomResourceOptions options)
```
    Parameters:
    
    name - The _unique_ name of the resulting resource.
    
    args - The arguments to use to populate this resource's properties.
    
    options - A bag of options that control this resource's behavior.
- Method Detail
  - arn
```
public com.pulumi.core.Output<java.lang.String> arn()
```
    Returns:
    
    The ARN of the maintenance window task.
  - cutoffBehavior
```
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> cutoffBehavior()
```
    Returns:
    
    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
```
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
```
    Returns:
    
    The description of the maintenance window task.
  - maxConcurrency
```
public com.pulumi.core.Output<java.lang.String> maxConcurrency()
```
    Returns:
    
    The maximum number of targets this task can be run for in parallel.
  - maxErrors
```
public com.pulumi.core.Output<java.lang.String> maxErrors()
```
    Returns:
    
    The maximum number of errors allowed before this task stops being scheduled.
  - name
```
public com.pulumi.core.Output<java.lang.String> name()
```
    Returns:
    
    The name of the maintenance window task.
  - priority
```
public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> priority()
```
    Returns:
    
    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.
  - region
```
public com.pulumi.core.Output<java.lang.String> region()
```
    Returns:
    
    Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
  - serviceRoleArn
```
public com.pulumi.core.Output<java.lang.String> serviceRoleArn()
```
    Returns:
    
    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
```
public com.pulumi.core.Output<java.util.Optional<java.util.List<MaintenanceWindowTaskTarget>>> targets()
```
    Returns:
    
    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
```
public com.pulumi.core.Output<java.lang.String> taskArn()
```
    Returns:
    
    The ARN of the task to execute.
  - taskInvocationParameters
```
public com.pulumi.core.Output<java.util.Optional<MaintenanceWindowTaskTaskInvocationParameters>> taskInvocationParameters()
```
    Returns:
    
    Configuration block with parameters for task execution.
  - taskType
```
public com.pulumi.core.Output<java.lang.String> taskType()
```
    Returns:
    
    The type of task being registered. Valid values: `AUTOMATION`, `LAMBDA`, `RUN_COMMAND` or `STEP_FUNCTIONS`.
  - windowId
```
public com.pulumi.core.Output<java.lang.String> windowId()
```
    Returns:
    
    The ID of the maintenance window to register the task with.
  - windowTaskId
```
public com.pulumi.core.Output<java.lang.String> windowTaskId()
```
    Returns:
    
    The ID of the maintenance window task.
  - get
```
public static MaintenanceWindowTask get(java.lang.String name,
                                        com.pulumi.core.Output<java.lang.String> id,
                                        @Nullable
                                        MaintenanceWindowTaskState state,
                                        @Nullable
                                        com.pulumi.resources.CustomResourceOptions options)
```
    Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
    
    Parameters:
    
    name - The _unique_ name of the resulting resource.
    
    id - The _unique_ provider ID of the resource to lookup.
    
    state -
    
    options - Optional settings to control the behavior of the CustomResource.

Class MaintenanceWindowTask

Nested Class Summary

Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

Nested classes/interfaces inherited from class com.pulumi.resources.Resource

Field Summary

Fields inherited from class com.pulumi.resources.Resource

Constructor Summary

Method Summary

Methods inherited from class com.pulumi.resources.CustomResource

Methods inherited from class com.pulumi.resources.Resource

Methods inherited from class java.lang.Object

Constructor Detail

MaintenanceWindowTask

MaintenanceWindowTask

MaintenanceWindowTask

Method Detail

arn

cutoffBehavior

description

maxConcurrency

maxErrors

name

priority

region

serviceRoleArn

targets

taskArn

taskInvocationParameters

taskType

windowId

windowTaskId

get