RegisterTaskWithMaintenanceWindowRequest

public struct RegisterTaskWithMaintenanceWindowRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • User-provided idempotency token.

    Declaration

    Swift

    public let clientToken: String?

  • An optional description for the task.

    Declaration

    Swift

    public let description: String?

  • A structure containing information about an S3 bucket to write instance-level logs to. 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 maximum number of targets this task can be run for in parallel.

    Declaration

    Swift

    public let maxConcurrency: String

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

    Declaration

    Swift

    public let maxErrors: String

  • An optional name for the task.

    Declaration

    Swift

    public let name: String?

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

    Declaration

    Swift

    public let priority: Int?

  • 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 maintenance window targets). Specify instances using the following format: Key=InstanceIds,Values=<instance-id-1>,<instance-id-2> Specify maintenance window targets using the following format: Key=WindowTargetIds;,Values=<window-target-id-1>,<window-target-id-2>

    Declaration

    Swift

    public let targets: [Target]

  • The ARN of the task to run.

    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.

    Declaration

    Swift

    public let taskInvocationParameters: MaintenanceWindowTaskInvocationParameters?

  • The parameters that should be passed to the task when it is run. 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.

    Declaration

    Swift

    public let taskParameters: [String : MaintenanceWindowTaskParameterValueExpression]?

  • The type of task being registered.

    Declaration

    Swift

    public let taskType: MaintenanceWindowTaskType

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

    Declaration

    Swift

    public let windowId: String

  • Undocumented

    Declaration

    Swift

    public init(clientToken: String? = RegisterTaskWithMaintenanceWindowRequest.idempotencyToken(), description: String? = nil, loggingInfo: LoggingInfo? = nil, maxConcurrency: String, maxErrors: String, name: String? = nil, priority: Int? = nil, serviceRoleArn: String? = nil, targets: [Target], taskArn: String, taskInvocationParameters: MaintenanceWindowTaskInvocationParameters? = nil, taskParameters: [String : MaintenanceWindowTaskParameterValueExpression]? = nil, taskType: MaintenanceWindowTaskType, windowId: String)

  • Declaration

    Swift

    public func validate(name: String) throws