AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The parameters for a RUN_COMMAND task type.

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

LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

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.

Inheritance Hierarchy

System.Object
  Amazon.SimpleSystemsManagement.Model.MaintenanceWindowRunCommandParameters

Namespace: Amazon.SimpleSystemsManagement.Model
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z

Syntax

C#
public class MaintenanceWindowRunCommandParameters

The MaintenanceWindowRunCommandParameters type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property CloudWatchOutputConfig Amazon.SimpleSystemsManagement.Model.CloudWatchOutputConfig

Gets and sets the property CloudWatchOutputConfig.

Public Property Comment System.String

Gets and sets the property Comment.

Information about the commands to run.

Public Property DocumentHash System.String

Gets and sets the property DocumentHash.

The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.

Public Property DocumentHashType Amazon.SimpleSystemsManagement.DocumentHashType

Gets and sets the property DocumentHashType.

SHA-256 or SHA-1. SHA-1 hashes have been deprecated.

Public Property DocumentVersion System.String

Gets and sets the property DocumentVersion.

The Amazon Web Services Systems Manager document (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 Amazon Web Services 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:

--document-version "\$DEFAULT"

--document-version "\$LATEST"

--document-version "3"

Public Property NotificationConfig Amazon.SimpleSystemsManagement.Model.NotificationConfig

Gets and sets the property NotificationConfig.

Configurations for sending notifications about command status changes on a per-managed node basis.

Public Property OutputS3BucketName System.String

Gets and sets the property OutputS3BucketName.

The name of the Amazon Simple Storage Service (Amazon S3) bucket.

Public Property OutputS3KeyPrefix System.String

Gets and sets the property OutputS3KeyPrefix.

The S3 bucket subfolder.

Public Property Parameters System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>

Gets and sets the property Parameters.

The parameters for the RUN_COMMAND task execution.

Public Property ServiceRoleArn System.String

Gets and sets the property ServiceRoleArn.

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.

Public Property TimeoutSeconds System.Int32

Gets and sets the property TimeoutSeconds.

If this time is reached and the command hasn't already started running, it doesn't run.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5