MaintenanceWindowRunCommandParameters class

The parameters for a RUN_COMMAND task type.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

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.

For Run Command tasks, Systems Manager uses specified values for TaskParameters and LoggingInfo only if no values are specified for TaskInvocationParameters.

Constructors

MaintenanceWindowRunCommandParameters({CloudWatchOutputConfig? cloudWatchOutputConfig, String? comment, String? documentHash, DocumentHashType? documentHashType, String? documentVersion, NotificationConfig? notificationConfig, String? outputS3BucketName, String? outputS3KeyPrefix, Map<String, List<String>>? parameters, String? serviceRoleArn, int? timeoutSeconds})
MaintenanceWindowRunCommandParameters.fromJson(Map<String, dynamic> json)
factory

Properties

cloudWatchOutputConfig → CloudWatchOutputConfig?
final
comment → String?
Information about the commands to run.
final
documentHash → String?
The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
final
documentHashType → DocumentHashType?
SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
final
documentVersion → String?
The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
final
hashCode → int
The hash code for this object.
no setterinherited
notificationConfig → NotificationConfig?
Configurations for sending notifications about command status changes on a per-instance basis.
final
outputS3BucketName → String?
The name of the S3 bucket.
final
outputS3KeyPrefix → String?
The S3 bucket subfolder.
final
parameters → Map<String, List<String>>?
The parameters for the RUN_COMMAND task execution.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serviceRoleArn → String?
The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
final
timeoutSeconds → int?
If this time is reached and the command has not already started running, it doesn't run.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited