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

Builder

Properties

alarmConfiguration

var alarmConfiguration: AlarmConfiguration?

The CloudWatch alarm you want to apply to your maintenance window task.

var clientToken: String?

User-provided idempotency token.

var cutoffBehavior: MaintenanceWindowTaskCutoffBehavior?

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

var description: String?

An optional description for the task.

var loggingInfo: LoggingInfo?

A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-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?

An optional name for the task.

var priority: Int?

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.

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

var targets: List<Target>?

The targets (either managed nodes or maintenance window targets).

var taskArn: String?

The ARN of the task to run.

taskInvocationParameters

var taskInvocationParameters: MaintenanceWindowTaskInvocationParameters?

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

var taskParameters: Map<String, MaintenanceWindowTaskParameterValueExpression>?

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

var taskType: MaintenanceWindowTaskType?

The type of task being registered.

var windowId: String?

The ID of the maintenance window the task should be added to.

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

taskInvocationParameters

fun taskInvocationParameters(block: MaintenanceWindowTaskInvocationParameters.Builder.() -> Unit)

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