UpdateMaintenanceWindowTaskRequest

public struct UpdateMaintenanceWindowTaskRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The new task description to specify.

    Declaration

    Swift

    public let description: String?

  • The new logging location in Amazon S3 to specify. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    Declaration

    Swift

    public let loggingInfo: LoggingInfo?

  • The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.

    Declaration

    Swift

    public let maxConcurrency: String?

  • The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

    Declaration

    Swift

    public let maxErrors: String?

  • The new task name to specify.

    Declaration

    Swift

    public let name: String?

  • The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

    Declaration

    Swift

    public let priority: Int?

  • If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.

    Declaration

    Swift

    public let replace: Bool?

  • The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account’s service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow. For more information, see the following topics in the in the AWS Systems Manager User Guide: Using service-linked roles for Systems Manager Should I use a service-linked role or a custom service role to run maintenance window tasks?

    Declaration

    Swift

    public let serviceRoleArn: String?

  • The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.

    Declaration

    Swift

    public let targets: [Target]?

  • The task ARN to modify.

    Declaration

    Swift

    public let taskArn: String?

  • The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty. When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

    Declaration

    Swift

    public let taskInvocationParameters: MaintenanceWindowTaskInvocationParameters?

  • The parameters to modify. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. The map has the following format: Key: string, between 1 and 255 characters Value: an array of strings, each string is between 1 and 255 characters

    Declaration

    Swift

    public let taskParameters: [String : MaintenanceWindowTaskParameterValueExpression]?

  • The maintenance window ID that contains the task to modify.

    Declaration

    Swift

    public let windowId: String

  • The task ID to modify.

    Declaration

    Swift

    public let windowTaskId: String

  • Undocumented

    Declaration

    Swift

    public init(description: String? = nil, loggingInfo: LoggingInfo? = nil, maxConcurrency: String? = nil, maxErrors: String? = nil, name: String? = nil, priority: Int? = nil, replace: Bool? = nil, serviceRoleArn: String? = nil, targets: [Target]? = nil, taskArn: String? = nil, taskInvocationParameters: MaintenanceWindowTaskInvocationParameters? = nil, taskParameters: [String : MaintenanceWindowTaskParameterValueExpression]? = nil, windowId: String, windowTaskId: String)

  • Declaration

    Swift

    public func validate(name: String) throws