1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ssm
  5. getMaintenanceWindowTask

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.44.0 published on Friday, Dec 19, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.ssm.getMaintenanceWindowTask

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.44.0 published on Friday, Dec 19, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::SSM::MaintenanceWindowTask

    Using getMaintenanceWindowTask

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getMaintenanceWindowTask(args: GetMaintenanceWindowTaskArgs, opts?: InvokeOptions): Promise<GetMaintenanceWindowTaskResult>
function getMaintenanceWindowTaskOutput(args: GetMaintenanceWindowTaskOutputArgs, opts?: InvokeOptions): Output<GetMaintenanceWindowTaskResult>
    def get_maintenance_window_task(window_id: Optional[str] = None,
                                window_task_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetMaintenanceWindowTaskResult
def get_maintenance_window_task_output(window_id: Optional[pulumi.Input[str]] = None,
                                window_task_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetMaintenanceWindowTaskResult]
    func LookupMaintenanceWindowTask(ctx *Context, args *LookupMaintenanceWindowTaskArgs, opts ...InvokeOption) (*LookupMaintenanceWindowTaskResult, error)
func LookupMaintenanceWindowTaskOutput(ctx *Context, args *LookupMaintenanceWindowTaskOutputArgs, opts ...InvokeOption) LookupMaintenanceWindowTaskResultOutput

    > Note: This function is named LookupMaintenanceWindowTask in the Go SDK.

    public static class GetMaintenanceWindowTask 
{
    public static Task<GetMaintenanceWindowTaskResult> InvokeAsync(GetMaintenanceWindowTaskArgs args, InvokeOptions? opts = null)
    public static Output<GetMaintenanceWindowTaskResult> Invoke(GetMaintenanceWindowTaskInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMaintenanceWindowTaskResult> getMaintenanceWindowTask(GetMaintenanceWindowTaskArgs args, InvokeOptions options)
public static Output<GetMaintenanceWindowTaskResult> getMaintenanceWindowTask(GetMaintenanceWindowTaskArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:ssm:getMaintenanceWindowTask
  arguments:
    # arguments dictionary

    The following arguments are supported:

    WindowId string
    The ID of the maintenance window where the task is registered.
    WindowTaskId string
    Unique identifier of the maintenance window task.
    WindowId string
    The ID of the maintenance window where the task is registered.
    WindowTaskId string
    Unique identifier of the maintenance window task.
    windowId String
    The ID of the maintenance window where the task is registered.
    windowTaskId String
    Unique identifier of the maintenance window task.
    windowId string
    The ID of the maintenance window where the task is registered.
    windowTaskId string
    Unique identifier of the maintenance window task.
    window_id str
    The ID of the maintenance window where the task is registered.
    window_task_id str
    Unique identifier of the maintenance window task.
    windowId String
    The ID of the maintenance window where the task is registered.
    windowTaskId String
    Unique identifier of the maintenance window task.

    getMaintenanceWindowTask Result

    The following output properties are available:

    CutoffBehavior string
    The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
    Description string
    A description of the task.
    LoggingInfo Pulumi.AwsNative.Ssm.Outputs.MaintenanceWindowTaskLoggingInfo
    Information about an Amazon S3 bucket to write Run Command task-level logs to.
    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 task name.
    Priority int
    The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
    ServiceRoleArn string
    The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task.
    Targets List<Pulumi.AwsNative.Ssm.Outputs.MaintenanceWindowTaskTarget>
    The targets (either instances or window target ids).
    TaskArn string
    The resource that the task uses during execution.
    TaskInvocationParameters Pulumi.AwsNative.Ssm.Outputs.MaintenanceWindowTaskTaskInvocationParameters
    The parameters to pass to the task when it runs. Populate only the fields that match the task type. All other fields should be empty.
    TaskParameters object

    The parameters to pass to the task when it runs.

    Search the CloudFormation User Guide for AWS::SSM::MaintenanceWindowTask for more information about the expected schema for this property.

    WindowTaskId string
    Unique identifier of the maintenance window task.
    CutoffBehavior string
    The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
    Description string
    A description of the task.
    LoggingInfo MaintenanceWindowTaskLoggingInfo
    Information about an Amazon S3 bucket to write Run Command task-level logs to.
    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 task name.
    Priority int
    The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
    ServiceRoleArn string
    The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task.
    Targets []MaintenanceWindowTaskTarget
    The targets (either instances or window target ids).
    TaskArn string
    The resource that the task uses during execution.
    TaskInvocationParameters MaintenanceWindowTaskTaskInvocationParameters
    The parameters to pass to the task when it runs. Populate only the fields that match the task type. All other fields should be empty.
    TaskParameters interface{}

    The parameters to pass to the task when it runs.

    Search the CloudFormation User Guide for AWS::SSM::MaintenanceWindowTask for more information about the expected schema for this property.

    WindowTaskId string
    Unique identifier of the maintenance window task.
    cutoffBehavior String
    The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
    description String
    A description of the task.
    loggingInfo MaintenanceWindowTaskLoggingInfo
    Information about an Amazon S3 bucket to write Run Command task-level logs to.
    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 task name.
    priority Integer
    The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
    serviceRoleArn String
    The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task.
    targets List<MaintenanceWindowTaskTarget>
    The targets (either instances or window target ids).
    taskArn String
    The resource that the task uses during execution.
    taskInvocationParameters MaintenanceWindowTaskTaskInvocationParameters
    The parameters to pass to the task when it runs. Populate only the fields that match the task type. All other fields should be empty.
    taskParameters Object

    The parameters to pass to the task when it runs.

    Search the CloudFormation User Guide for AWS::SSM::MaintenanceWindowTask for more information about the expected schema for this property.

    windowTaskId String
    Unique identifier of the maintenance window task.
    cutoffBehavior string
    The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
    description string
    A description of the task.
    loggingInfo MaintenanceWindowTaskLoggingInfo
    Information about an Amazon S3 bucket to write Run Command task-level logs to.
    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 task name.
    priority number
    The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
    serviceRoleArn string
    The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task.
    targets MaintenanceWindowTaskTarget[]
    The targets (either instances or window target ids).
    taskArn string
    The resource that the task uses during execution.
    taskInvocationParameters MaintenanceWindowTaskTaskInvocationParameters
    The parameters to pass to the task when it runs. Populate only the fields that match the task type. All other fields should be empty.
    taskParameters any

    The parameters to pass to the task when it runs.

    Search the CloudFormation User Guide for AWS::SSM::MaintenanceWindowTask for more information about the expected schema for this property.

    windowTaskId string
    Unique identifier of the maintenance window task.
    cutoff_behavior str
    The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
    description str
    A description of the task.
    logging_info MaintenanceWindowTaskLoggingInfo
    Information about an Amazon S3 bucket to write Run Command task-level logs to.
    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 task name.
    priority int
    The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
    service_role_arn str
    The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task.
    targets Sequence[MaintenanceWindowTaskTarget]
    The targets (either instances or window target ids).
    task_arn str
    The resource that the task uses during execution.
    task_invocation_parameters MaintenanceWindowTaskTaskInvocationParameters
    The parameters to pass to the task when it runs. Populate only the fields that match the task type. All other fields should be empty.
    task_parameters Any

    The parameters to pass to the task when it runs.

    Search the CloudFormation User Guide for AWS::SSM::MaintenanceWindowTask for more information about the expected schema for this property.

    window_task_id str
    Unique identifier of the maintenance window task.
    cutoffBehavior String
    The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
    description String
    A description of the task.
    loggingInfo Property Map
    Information about an Amazon S3 bucket to write Run Command task-level logs to.
    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 task name.
    priority Number
    The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
    serviceRoleArn String
    The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task.
    targets List<Property Map>
    The targets (either instances or window target ids).
    taskArn String
    The resource that the task uses during execution.
    taskInvocationParameters Property Map
    The parameters to pass to the task when it runs. Populate only the fields that match the task type. All other fields should be empty.
    taskParameters Any

    The parameters to pass to the task when it runs.

    Search the CloudFormation User Guide for AWS::SSM::MaintenanceWindowTask for more information about the expected schema for this property.

    windowTaskId String
    Unique identifier of the maintenance window task.

    Supporting Types

    MaintenanceWindowTaskCloudWatchOutputConfig

    CloudWatchLogGroupName string
    The name of the CloudWatch log group where you want to send command output.
    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.
    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.
    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.
    cloudWatchOutputEnabled boolean
    Enables Systems Manager to send command output to CloudWatch Logs.
    cloud_watch_log_group_name str
    The name of the CloudWatch log group where you want to send command output.
    cloud_watch_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.
    cloudWatchOutputEnabled Boolean
    Enables Systems Manager to send command output to CloudWatch Logs.

    MaintenanceWindowTaskLoggingInfo

    Region string
    The AWS Region where the S3 bucket is located.
    S3Bucket string
    The name of an S3 bucket where execution logs are stored.
    S3Prefix string
    The Amazon S3 bucket subfolder.
    Region string
    The AWS Region where the S3 bucket is located.
    S3Bucket string
    The name of an S3 bucket where execution logs are stored.
    S3Prefix string
    The Amazon S3 bucket subfolder.
    region String
    The AWS Region where the S3 bucket is located.
    s3Bucket String
    The name of an S3 bucket where execution logs are stored.
    s3Prefix String
    The Amazon S3 bucket subfolder.
    region string
    The AWS Region where the S3 bucket is located.
    s3Bucket string
    The name of an S3 bucket where execution logs are stored.
    s3Prefix string
    The Amazon S3 bucket subfolder.
    region str
    The AWS Region where the S3 bucket is located.
    s3_bucket str
    The name of an S3 bucket where execution logs are stored.
    s3_prefix str
    The Amazon S3 bucket subfolder.
    region String
    The AWS Region where the S3 bucket is located.
    s3Bucket String
    The name of an S3 bucket where execution logs are stored.
    s3Prefix String
    The Amazon S3 bucket subfolder.

    MaintenanceWindowTaskMaintenanceWindowAutomationParameters

    DocumentVersion string
    The version of an Automation runbook to use during task execution.
    Parameters object
    The parameters for the AUTOMATION type task.
    DocumentVersion string
    The version of an Automation runbook to use during task execution.
    Parameters interface{}
    The parameters for the AUTOMATION type task.
    documentVersion String
    The version of an Automation runbook to use during task execution.
    parameters Object
    The parameters for the AUTOMATION type task.
    documentVersion string
    The version of an Automation runbook to use during task execution.
    parameters any
    The parameters for the AUTOMATION type task.
    document_version str
    The version of an Automation runbook to use during task execution.
    parameters Any
    The parameters for the AUTOMATION type task.
    documentVersion String
    The version of an Automation runbook to use during task execution.
    parameters Any
    The parameters for the AUTOMATION type task.

    MaintenanceWindowTaskMaintenanceWindowLambdaParameters

    ClientContext string
    Client-specific information to pass to the AWS Lambda function that you're invoking. You can then use the context variable to process the client information in your AWS Lambda function.
    Payload string

    JSON to provide to your AWS Lambda function as input.

    Although Type is listed as "String" for this property, the payload content must be formatted as a Base64-encoded binary data object.

    Length Constraint: 4096

    Qualifier string
    An AWS Lambda function version or alias name. If you specify a function version, the action uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version that the alias points to.
    ClientContext string
    Client-specific information to pass to the AWS Lambda function that you're invoking. You can then use the context variable to process the client information in your AWS Lambda function.
    Payload string

    JSON to provide to your AWS Lambda function as input.

    Although Type is listed as "String" for this property, the payload content must be formatted as a Base64-encoded binary data object.

    Length Constraint: 4096

    Qualifier string
    An AWS Lambda function version or alias name. If you specify a function version, the action uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version that the alias points to.
    clientContext String
    Client-specific information to pass to the AWS Lambda function that you're invoking. You can then use the context variable to process the client information in your AWS Lambda function.
    payload String

    JSON to provide to your AWS Lambda function as input.

    Although Type is listed as "String" for this property, the payload content must be formatted as a Base64-encoded binary data object.

    Length Constraint: 4096

    qualifier String
    An AWS Lambda function version or alias name. If you specify a function version, the action uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version that the alias points to.
    clientContext string
    Client-specific information to pass to the AWS Lambda function that you're invoking. You can then use the context variable to process the client information in your AWS Lambda function.
    payload string

    JSON to provide to your AWS Lambda function as input.

    Although Type is listed as "String" for this property, the payload content must be formatted as a Base64-encoded binary data object.

    Length Constraint: 4096

    qualifier string
    An AWS Lambda function version or alias name. If you specify a function version, the action uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version that the alias points to.
    client_context str
    Client-specific information to pass to the AWS Lambda function that you're invoking. You can then use the context variable to process the client information in your AWS Lambda function.
    payload str

    JSON to provide to your AWS Lambda function as input.

    Although Type is listed as "String" for this property, the payload content must be formatted as a Base64-encoded binary data object.

    Length Constraint: 4096

    qualifier str
    An AWS Lambda function version or alias name. If you specify a function version, the action uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version that the alias points to.
    clientContext String
    Client-specific information to pass to the AWS Lambda function that you're invoking. You can then use the context variable to process the client information in your AWS Lambda function.
    payload String

    JSON to provide to your AWS Lambda function as input.

    Although Type is listed as "String" for this property, the payload content must be formatted as a Base64-encoded binary data object.

    Length Constraint: 4096

    qualifier String
    An AWS Lambda function version or alias name. If you specify a function version, the action uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version that the alias points to.

    MaintenanceWindowTaskMaintenanceWindowRunCommandParameters

    CloudWatchOutputConfig Pulumi.AwsNative.Ssm.Inputs.MaintenanceWindowTaskCloudWatchOutputConfig
    Configuration options for sending command output to Amazon CloudWatch Logs.
    Comment string
    Information about the command or commands to run.
    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
    The SHA-256 or SHA-1 hash type. SHA-1 hashes are deprecated.
    DocumentVersion string

    The AWS Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT , $LATEST , or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

    --document-version "\$DEFAULT"

    --document-version "\$LATEST"

    --document-version "3"

    NotificationConfig Pulumi.AwsNative.Ssm.Inputs.MaintenanceWindowTaskNotificationConfig
    Configurations for sending notifications about command status changes on a per-managed node basis.
    OutputS3BucketName string
    The name of the Amazon Simple Storage Service (Amazon S3) bucket.
    OutputS3KeyPrefix string
    The S3 bucket subfolder.
    Parameters object

    The parameters for the RUN_COMMAND task execution.

    The supported parameters are the same as those for the SendCommand API call. For more information, see SendCommand in the AWS Systems Manager API Reference .

    ServiceRoleArn string

    The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow .

    However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the AWS Systems Manager User Guide .

    TimeoutSeconds int
    If this time is reached and the command hasn't already started running, it doesn't run.
    CloudWatchOutputConfig MaintenanceWindowTaskCloudWatchOutputConfig
    Configuration options for sending command output to Amazon CloudWatch Logs.
    Comment string
    Information about the command or commands to run.
    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
    The SHA-256 or SHA-1 hash type. SHA-1 hashes are deprecated.
    DocumentVersion string

    The AWS Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT , $LATEST , or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

    --document-version "\$DEFAULT"

    --document-version "\$LATEST"

    --document-version "3"

    NotificationConfig MaintenanceWindowTaskNotificationConfig
    Configurations for sending notifications about command status changes on a per-managed node basis.
    OutputS3BucketName string
    The name of the Amazon Simple Storage Service (Amazon S3) bucket.
    OutputS3KeyPrefix string
    The S3 bucket subfolder.
    Parameters interface{}

    The parameters for the RUN_COMMAND task execution.

    The supported parameters are the same as those for the SendCommand API call. For more information, see SendCommand in the AWS Systems Manager API Reference .

    ServiceRoleArn string

    The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow .

    However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the AWS Systems Manager User Guide .

    TimeoutSeconds int
    If this time is reached and the command hasn't already started running, it doesn't run.
    cloudWatchOutputConfig MaintenanceWindowTaskCloudWatchOutputConfig
    Configuration options for sending command output to Amazon CloudWatch Logs.
    comment String
    Information about the command or commands to run.
    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
    The SHA-256 or SHA-1 hash type. SHA-1 hashes are deprecated.
    documentVersion String

    The AWS Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT , $LATEST , or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

    --document-version "\$DEFAULT"

    --document-version "\$LATEST"

    --document-version "3"

    notificationConfig MaintenanceWindowTaskNotificationConfig
    Configurations for sending notifications about command status changes on a per-managed node basis.
    outputS3BucketName String
    The name of the Amazon Simple Storage Service (Amazon S3) bucket.
    outputS3KeyPrefix String
    The S3 bucket subfolder.
    parameters Object

    The parameters for the RUN_COMMAND task execution.

    The supported parameters are the same as those for the SendCommand API call. For more information, see SendCommand in the AWS Systems Manager API Reference .

    serviceRoleArn String

    The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow .

    However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the AWS Systems Manager User Guide .

    timeoutSeconds Integer
    If this time is reached and the command hasn't already started running, it doesn't run.
    cloudWatchOutputConfig MaintenanceWindowTaskCloudWatchOutputConfig
    Configuration options for sending command output to Amazon CloudWatch Logs.
    comment string
    Information about the command or commands to run.
    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
    The SHA-256 or SHA-1 hash type. SHA-1 hashes are deprecated.
    documentVersion string

    The AWS Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT , $LATEST , or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

    --document-version "\$DEFAULT"

    --document-version "\$LATEST"

    --document-version "3"

    notificationConfig MaintenanceWindowTaskNotificationConfig
    Configurations for sending notifications about command status changes on a per-managed node basis.
    outputS3BucketName string
    The name of the Amazon Simple Storage Service (Amazon S3) bucket.
    outputS3KeyPrefix string
    The S3 bucket subfolder.
    parameters any

    The parameters for the RUN_COMMAND task execution.

    The supported parameters are the same as those for the SendCommand API call. For more information, see SendCommand in the AWS Systems Manager API Reference .

    serviceRoleArn string

    The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow .

    However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the AWS Systems Manager User Guide .

    timeoutSeconds number
    If this time is reached and the command hasn't already started running, it doesn't run.
    cloud_watch_output_config MaintenanceWindowTaskCloudWatchOutputConfig
    Configuration options for sending command output to Amazon CloudWatch Logs.
    comment str
    Information about the command or commands to run.
    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
    The SHA-256 or SHA-1 hash type. SHA-1 hashes are deprecated.
    document_version str

    The AWS Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT , $LATEST , or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

    --document-version "\$DEFAULT"

    --document-version "\$LATEST"

    --document-version "3"

    notification_config MaintenanceWindowTaskNotificationConfig
    Configurations for sending notifications about command status changes on a per-managed node basis.
    output_s3_bucket_name str
    The name of the Amazon Simple Storage Service (Amazon S3) bucket.
    output_s3_key_prefix str
    The S3 bucket subfolder.
    parameters Any

    The parameters for the RUN_COMMAND task execution.

    The supported parameters are the same as those for the SendCommand API call. For more information, see SendCommand in the AWS Systems Manager API Reference .

    service_role_arn str

    The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow .

    However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the AWS Systems Manager User Guide .

    timeout_seconds int
    If this time is reached and the command hasn't already started running, it doesn't run.
    cloudWatchOutputConfig Property Map
    Configuration options for sending command output to Amazon CloudWatch Logs.
    comment String
    Information about the command or commands to run.
    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
    The SHA-256 or SHA-1 hash type. SHA-1 hashes are deprecated.
    documentVersion String

    The AWS Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT , $LATEST , or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

    --document-version "\$DEFAULT"

    --document-version "\$LATEST"

    --document-version "3"

    notificationConfig Property Map
    Configurations for sending notifications about command status changes on a per-managed node basis.
    outputS3BucketName String
    The name of the Amazon Simple Storage Service (Amazon S3) bucket.
    outputS3KeyPrefix String
    The S3 bucket subfolder.
    parameters Any

    The parameters for the RUN_COMMAND task execution.

    The supported parameters are the same as those for the SendCommand API call. For more information, see SendCommand in the AWS Systems Manager API Reference .

    serviceRoleArn String

    The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow .

    However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the AWS Systems Manager User Guide .

    timeoutSeconds Number
    If this time is reached and the command hasn't already started running, it doesn't run.

    MaintenanceWindowTaskMaintenanceWindowStepFunctionsParameters

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

    MaintenanceWindowTaskNotificationConfig

    NotificationArn string
    An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.
    NotificationEvents List<string>
    The different events that you can receive notifications for. These events include the following: All (events), InProgress , Success , TimedOut , Cancelled , Failed . To learn more about these events, see Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS Systems Manager User Guide .
    NotificationType string
    The notification type.

    • Command : Receive notification when the status of a command changes.
    • Invocation : For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.
    NotificationArn string
    An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.
    NotificationEvents []string
    The different events that you can receive notifications for. These events include the following: All (events), InProgress , Success , TimedOut , Cancelled , Failed . To learn more about these events, see Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS Systems Manager User Guide .
    NotificationType string
    The notification type.

    • Command : Receive notification when the status of a command changes.
    • Invocation : For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.
    notificationArn String
    An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.
    notificationEvents List<String>
    The different events that you can receive notifications for. These events include the following: All (events), InProgress , Success , TimedOut , Cancelled , Failed . To learn more about these events, see Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS Systems Manager User Guide .
    notificationType String
    The notification type.

    • Command : Receive notification when the status of a command changes.
    • Invocation : For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.
    notificationArn string
    An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.
    notificationEvents string[]
    The different events that you can receive notifications for. These events include the following: All (events), InProgress , Success , TimedOut , Cancelled , Failed . To learn more about these events, see Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS Systems Manager User Guide .
    notificationType string
    The notification type.

    • Command : Receive notification when the status of a command changes.
    • Invocation : For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.
    notification_arn str
    An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.
    notification_events Sequence[str]
    The different events that you can receive notifications for. These events include the following: All (events), InProgress , Success , TimedOut , Cancelled , Failed . To learn more about these events, see Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS Systems Manager User Guide .
    notification_type str
    The notification type.

    • Command : Receive notification when the status of a command changes.
    • Invocation : For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.
    notificationArn String
    An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.
    notificationEvents List<String>
    The different events that you can receive notifications for. These events include the following: All (events), InProgress , Success , TimedOut , Cancelled , Failed . To learn more about these events, see Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS Systems Manager User Guide .
    notificationType String
    The notification type.

    • Command : Receive notification when the status of a command changes.
    • Invocation : For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.

    MaintenanceWindowTaskTarget

    Key string
    User-defined criteria for sending commands that target instances that meet the criteria. Key can be InstanceIds or WindowTargetIds . For more information about how to target instances within a maintenance window task, see About 'register-task-with-maintenance-window' Options and Values in the AWS Systems Manager User Guide .
    Values List<string>
    User-defined criteria that maps to Key . For example, if you specify InstanceIds , you can specify i-1234567890abcdef0,i-9876543210abcdef0 to run a command on two EC2 instances. For more information about how to target instances within a maintenance window task, see About 'register-task-with-maintenance-window' Options and Values in the AWS Systems Manager User Guide .
    Key string
    User-defined criteria for sending commands that target instances that meet the criteria. Key can be InstanceIds or WindowTargetIds . For more information about how to target instances within a maintenance window task, see About 'register-task-with-maintenance-window' Options and Values in the AWS Systems Manager User Guide .
    Values []string
    User-defined criteria that maps to Key . For example, if you specify InstanceIds , you can specify i-1234567890abcdef0,i-9876543210abcdef0 to run a command on two EC2 instances. For more information about how to target instances within a maintenance window task, see About 'register-task-with-maintenance-window' Options and Values in the AWS Systems Manager User Guide .
    key String
    User-defined criteria for sending commands that target instances that meet the criteria. Key can be InstanceIds or WindowTargetIds . For more information about how to target instances within a maintenance window task, see About 'register-task-with-maintenance-window' Options and Values in the AWS Systems Manager User Guide .
    values List<String>
    User-defined criteria that maps to Key . For example, if you specify InstanceIds , you can specify i-1234567890abcdef0,i-9876543210abcdef0 to run a command on two EC2 instances. For more information about how to target instances within a maintenance window task, see About 'register-task-with-maintenance-window' Options and Values in the AWS Systems Manager User Guide .
    key string
    User-defined criteria for sending commands that target instances that meet the criteria. Key can be InstanceIds or WindowTargetIds . For more information about how to target instances within a maintenance window task, see About 'register-task-with-maintenance-window' Options and Values in the AWS Systems Manager User Guide .
    values string[]
    User-defined criteria that maps to Key . For example, if you specify InstanceIds , you can specify i-1234567890abcdef0,i-9876543210abcdef0 to run a command on two EC2 instances. For more information about how to target instances within a maintenance window task, see About 'register-task-with-maintenance-window' Options and Values in the AWS Systems Manager User Guide .
    key str
    User-defined criteria for sending commands that target instances that meet the criteria. Key can be InstanceIds or WindowTargetIds . For more information about how to target instances within a maintenance window task, see About 'register-task-with-maintenance-window' Options and Values in the AWS Systems Manager User Guide .
    values Sequence[str]
    User-defined criteria that maps to Key . For example, if you specify InstanceIds , you can specify i-1234567890abcdef0,i-9876543210abcdef0 to run a command on two EC2 instances. For more information about how to target instances within a maintenance window task, see About 'register-task-with-maintenance-window' Options and Values in the AWS Systems Manager User Guide .
    key String
    User-defined criteria for sending commands that target instances that meet the criteria. Key can be InstanceIds or WindowTargetIds . For more information about how to target instances within a maintenance window task, see About 'register-task-with-maintenance-window' Options and Values in the AWS Systems Manager User Guide .
    values List<String>
    User-defined criteria that maps to Key . For example, if you specify InstanceIds , you can specify i-1234567890abcdef0,i-9876543210abcdef0 to run a command on two EC2 instances. For more information about how to target instances within a maintenance window task, see About 'register-task-with-maintenance-window' Options and Values in the AWS Systems Manager User Guide .

    MaintenanceWindowTaskTaskInvocationParameters

    maintenanceWindowAutomationParameters Property Map
    The parameters for an AUTOMATION task type.
    maintenanceWindowLambdaParameters Property Map
    The parameters for a LAMBDA task type.
    maintenanceWindowRunCommandParameters Property Map
    The parameters for a RUN_COMMAND task type.
    maintenanceWindowStepFunctionsParameters Property Map
    The parameters for a STEP_FUNCTIONS task type.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.44.0 published on Friday, Dec 19, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate