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

Builder

Properties

alarmConfiguration

var alarmConfiguration: AlarmConfiguration?

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

var cutoffBehavior: MaintenanceWindowTaskCutoffBehavior?

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

var description: String?

A description of the task.

var loggingInfo: LoggingInfo?

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

var maxConcurrency: String?

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

var maxErrors: String?

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

var name: String?

The task name.

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

var serviceRoleArn: String?

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

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

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

var taskParameters: Map<String, MaintenanceWindowTaskParameterValueExpression>?

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

var type: MaintenanceWindowTaskType?

The type of task.

var windowId: String?

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

var windowTaskId: String?

The task ID.

Functions

alarmConfiguration

fun alarmConfiguration(block: AlarmConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.ssm.model.AlarmConfiguration inside the given block

fun loggingInfo(block: LoggingInfo.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.ssm.model.LoggingInfo inside the given block