ssm/aws.sdk.kotlin.services.ssm.model/MaintenanceWindowTask

MaintenanceWindowTask

class MaintenanceWindowTask

Information about a task defined for a maintenance window.

Types

object Companion

Properties

alarmConfiguration

val alarmConfiguration: AlarmConfiguration?

The details for the CloudWatch alarm applied to your maintenance window task.

val cutoffBehavior: MaintenanceWindowTaskCutoffBehavior?

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

val description: String?

A description of the task.

val loggingInfo: LoggingInfo?

Information about an S3 bucket to write task-level logs to.

val maxConcurrency: String?

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

val maxErrors: String?

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

val name: String?

The task name.

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

val serviceRoleArn: String?

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services 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.

val targets: List<Target>?

The targets (either managed nodes or tags). Managed nodes are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

val taskArn: String?

The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Amazon Web Services Systems Manager (SSM document) name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state machine ARN.

val taskParameters: Map<String, MaintenanceWindowTaskParameterValueExpression>?

The parameters that should be passed to the task when it is run.

val type: MaintenanceWindowTaskType?

The type of task.

val windowId: String?

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

val windowTaskId: String?

The task ID.

Functions

inline fun copy(block: MaintenanceWindowTask.Builder.() -> Unit = {}): MaintenanceWindowTask

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String