Package software.amazon.awscdk.services.ssm

Class CfnMaintenanceWindowTask

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTask

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IMaintenanceWindowTaskRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:14.739Z")
@Stability(Stable)
public class CfnMaintenanceWindowTask
extends CfnResource
implements IInspectable, IMaintenanceWindowTaskRef

The AWS::SSM::MaintenanceWindowTask resource defines information about a task for an AWS Systems Manager maintenance window.

For more information, see RegisterTaskWithMaintenanceWindow in the AWS Systems Manager API Reference .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ssm.*;
 Object parameters;
 Object taskParameters;
 CfnMaintenanceWindowTask cfnMaintenanceWindowTask = CfnMaintenanceWindowTask.Builder.create(this, "MyCfnMaintenanceWindowTask")
         .priority(123)
         .taskArn("taskArn")
         .taskType("taskType")
         .windowId("windowId")
         // the properties below are optional
         .cutoffBehavior("cutoffBehavior")
         .description("description")
         .loggingInfo(LoggingInfoProperty.builder()
                 .region("region")
                 .s3Bucket("s3Bucket")
                 // the properties below are optional
                 .s3Prefix("s3Prefix")
                 .build())
         .maxConcurrency("maxConcurrency")
         .maxErrors("maxErrors")
         .name("name")
         .serviceRoleArn("serviceRoleArn")
         .targets(List.of(TargetProperty.builder()
                 .key("key")
                 .values(List.of("values"))
                 .build()))
         .taskInvocationParameters(TaskInvocationParametersProperty.builder()
                 .maintenanceWindowAutomationParameters(MaintenanceWindowAutomationParametersProperty.builder()
                         .documentVersion("documentVersion")
                         .parameters(parameters)
                         .build())
                 .maintenanceWindowLambdaParameters(MaintenanceWindowLambdaParametersProperty.builder()
                         .clientContext("clientContext")
                         .payload("payload")
                         .qualifier("qualifier")
                         .build())
                 .maintenanceWindowRunCommandParameters(MaintenanceWindowRunCommandParametersProperty.builder()
                         .cloudWatchOutputConfig(CloudWatchOutputConfigProperty.builder()
                                 .cloudWatchLogGroupName("cloudWatchLogGroupName")
                                 .cloudWatchOutputEnabled(false)
                                 .build())
                         .comment("comment")
                         .documentHash("documentHash")
                         .documentHashType("documentHashType")
                         .documentVersion("documentVersion")
                         .notificationConfig(NotificationConfigProperty.builder()
                                 .notificationArn("notificationArn")
                                 // the properties below are optional
                                 .notificationEvents(List.of("notificationEvents"))
                                 .notificationType("notificationType")
                                 .build())
                         .outputS3BucketName("outputS3BucketName")
                         .outputS3KeyPrefix("outputS3KeyPrefix")
                         .parameters(parameters)
                         .serviceRoleArn("serviceRoleArn")
                         .timeoutSeconds(123)
                         .build())
                 .maintenanceWindowStepFunctionsParameters(MaintenanceWindowStepFunctionsParametersProperty.builder()
                         .input("input")
                         .name("name")
                         .build())
                 .build())
         .taskParameters(taskParameters)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnMaintenanceWindowTask.Builder	A fluent builder for CfnMaintenanceWindowTask.
static interface	CfnMaintenanceWindowTask.CloudWatchOutputConfigProperty	Configuration options for sending command output to Amazon CloudWatch Logs.
static interface	CfnMaintenanceWindowTask.LoggingInfoProperty
static interface	CfnMaintenanceWindowTask.MaintenanceWindowAutomationParametersProperty	The MaintenanceWindowAutomationParameters property type specifies the parameters for an AUTOMATION task type for a maintenance window task in AWS Systems Manager .
static interface	CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty	The MaintenanceWindowLambdaParameters property type specifies the parameters for a LAMBDA task type for a maintenance window task in AWS Systems Manager .
static interface	CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty	The MaintenanceWindowRunCommandParameters property type specifies the parameters for a RUN_COMMAND task type for a maintenance window task in AWS Systems Manager .
static interface	CfnMaintenanceWindowTask.MaintenanceWindowStepFunctionsParametersProperty	The MaintenanceWindowStepFunctionsParameters property type specifies the parameters for the execution of a STEP_FUNCTIONS task in a Systems Manager maintenance window.
static interface	CfnMaintenanceWindowTask.NotificationConfigProperty	The NotificationConfig property type specifies configurations for sending notifications for a maintenance window task in AWS Systems Manager .
static interface	CfnMaintenanceWindowTask.TargetProperty	The Target property type specifies targets (either instances or window target IDs).
static interface	CfnMaintenanceWindowTask.TaskInvocationParametersProperty	The TaskInvocationParameters property type specifies the task execution parameters for a maintenance window task in AWS Systems Manager .

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.ssm.IMaintenanceWindowTaskRef

IMaintenanceWindowTaskRef.Jsii$Default, IMaintenanceWindowTaskRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnMaintenanceWindowTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMaintenanceWindowTask(software.amazon.jsii.JsiiObjectRef objRef)
	CfnMaintenanceWindowTask(software.constructs.Construct scope, String id, CfnMaintenanceWindowTaskProps props)	Create a new AWS::SSM::MaintenanceWindowTask.

Method Summary

Modifier and Type	Method	Description
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
String	getCutoffBehavior()	The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
String	getDescription()	A description of the task.
Object	getLoggingInfo()
MaintenanceWindowTaskReference	getMaintenanceWindowTaskRef()	A reference to a MaintenanceWindowTask resource.
String	getMaxConcurrency()	The maximum number of targets this task can be run for, in parallel.
String	getMaxErrors()	The maximum number of errors allowed before this task stops being scheduled.
String	getName()	The task name.
Number	getPriority()	The priority of the task in the maintenance window.
String	getServiceRoleArn()	The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task.
Object	getTargets()	The targets, either instances or window target IDs.
String	getTaskArn()	The resource that the task uses during execution.
Object	getTaskInvocationParameters()	The parameters to pass to the task when it runs.
Object	getTaskParameters()
String	getTaskType()	The type of task.
String	getWindowId()	The ID of the maintenance window where the task is registered.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCutoffBehavior(String value)	The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
void	setDescription(String value)	A description of the task.
void	setLoggingInfo(IResolvable value)
void	setLoggingInfo(CfnMaintenanceWindowTask.LoggingInfoProperty value)
void	setMaxConcurrency(String value)	The maximum number of targets this task can be run for, in parallel.
void	setMaxErrors(String value)	The maximum number of errors allowed before this task stops being scheduled.
void	setName(String value)	The task name.
void	setPriority(Number value)	The priority of the task in the maintenance window.
void	setServiceRoleArn(String value)	The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task.
void	setTargets(List<Object> value)	The targets, either instances or window target IDs.
void	setTargets(IResolvable value)	The targets, either instances or window target IDs.
void	setTaskArn(String value)	The resource that the task uses during execution.
void	setTaskInvocationParameters(IResolvable value)	The parameters to pass to the task when it runs.
void	setTaskInvocationParameters(CfnMaintenanceWindowTask.TaskInvocationParametersProperty value)	The parameters to pass to the task when it runs.
void	setTaskParameters(Object value)
void	setTaskType(String value)	The type of task.
void	setWindowId(String value)	The ID of the maintenance window where the task is registered.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnMaintenanceWindowTask

protected CfnMaintenanceWindowTask(software.amazon.jsii.JsiiObjectRef objRef)

CfnMaintenanceWindowTask

protected CfnMaintenanceWindowTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnMaintenanceWindowTask

@Stability(Stable)
public CfnMaintenanceWindowTask(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnMaintenanceWindowTaskProps props)

Create a new AWS::SSM::MaintenanceWindowTask.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getMaintenanceWindowTaskRef

@Stability(Stable)
@NotNull
public MaintenanceWindowTaskReference getMaintenanceWindowTaskRef()

A reference to a MaintenanceWindowTask resource.

Specified by:

getMaintenanceWindowTaskRef in interface IMaintenanceWindowTaskRef

getPriority

@Stability(Stable)
@NotNull
public Number getPriority()

The priority of the task in the maintenance window.

setPriority

@Stability(Stable)
public void setPriority(@NotNull
 Number value)

The priority of the task in the maintenance window.

getTaskArn

@Stability(Stable)
@NotNull
public String getTaskArn()

The resource that the task uses during execution.

setTaskArn

@Stability(Stable)
public void setTaskArn(@NotNull
 String value)

The resource that the task uses during execution.

getTaskType

@Stability(Stable)
@NotNull
public String getTaskType()

The type of task.

setTaskType

@Stability(Stable)
public void setTaskType(@NotNull
 String value)

The type of task.

getWindowId

@Stability(Stable)
@NotNull
public String getWindowId()

The ID of the maintenance window where the task is registered.

setWindowId

@Stability(Stable)
public void setWindowId(@NotNull
 String value)

The ID of the maintenance window where the task is registered.

getCutoffBehavior

@Stability(Stable)
@Nullable
public String getCutoffBehavior()

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

setCutoffBehavior

@Stability(Stable)
public void setCutoffBehavior(@Nullable
 String value)

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

A description of the task.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

A description of the task.

getLoggingInfo

@Stability(Stable)
@Nullable
public Object getLoggingInfo()

LoggingInfo has been deprecated.

Returns union: either IResolvable or CfnMaintenanceWindowTask.LoggingInfoProperty

setLoggingInfo

@Stability(Stable)
public void setLoggingInfo(@Nullable
 IResolvable value)

LoggingInfo has been deprecated.

setLoggingInfo

@Stability(Stable)
public void setLoggingInfo(@Nullable
 CfnMaintenanceWindowTask.LoggingInfoProperty value)

LoggingInfo has been deprecated.

getMaxConcurrency

@Stability(Stable)
@Nullable
public String getMaxConcurrency()

The maximum number of targets this task can be run for, in parallel.

setMaxConcurrency

@Stability(Stable)
public void setMaxConcurrency(@Nullable
 String value)

The maximum number of targets this task can be run for, in parallel.

getMaxErrors

@Stability(Stable)
@Nullable
public String getMaxErrors()

The maximum number of errors allowed before this task stops being scheduled.

setMaxErrors

@Stability(Stable)
public void setMaxErrors(@Nullable
 String value)

The maximum number of errors allowed before this task stops being scheduled.

getName

@Stability(Stable)
@Nullable
public String getName()

The task name.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

The task name.

getServiceRoleArn

@Stability(Stable)
@Nullable
public String getServiceRoleArn()

The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task.

setServiceRoleArn

@Stability(Stable)
public void setServiceRoleArn(@Nullable
 String value)

The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task.

getTargets

@Stability(Stable)
@Nullable
public Object getTargets()

The targets, either instances or window target IDs.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMaintenanceWindowTask.TargetProperty>

setTargets

@Stability(Stable)
public void setTargets(@Nullable
 IResolvable value)

The targets, either instances or window target IDs.

setTargets

@Stability(Stable)
public void setTargets(@Nullable
 List<Object> value)

The targets, either instances or window target IDs.

getTaskInvocationParameters

@Stability(Stable)
@Nullable
public Object getTaskInvocationParameters()

The parameters to pass to the task when it runs.

Returns union: either IResolvable or CfnMaintenanceWindowTask.TaskInvocationParametersProperty

setTaskInvocationParameters

@Stability(Stable)
public void setTaskInvocationParameters(@Nullable
 IResolvable value)

The parameters to pass to the task when it runs.

setTaskInvocationParameters

@Stability(Stable)
public void setTaskInvocationParameters(@Nullable
 CfnMaintenanceWindowTask.TaskInvocationParametersProperty value)

The parameters to pass to the task when it runs.

getTaskParameters

@Stability(Stable)
@Nullable
public Object getTaskParameters()

TaskParameters has been deprecated.

setTaskParameters

@Stability(Stable)
public void setTaskParameters(@Nullable
 Object value)

TaskParameters has been deprecated.