Interface CfnMaintenanceWindowTask.IMaintenanceWindowRunCommandParametersProperty
The MaintenanceWindowRunCommandParameters property type specifies the parameters for a RUN_COMMAND task type for a maintenance window task in AWS Systems Manager .
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnMaintenanceWindowTask.IMaintenanceWindowRunCommandParametersPropertySyntax (vb)
Public Interface CfnMaintenanceWindowTask.IMaintenanceWindowRunCommandParametersPropertyRemarks
This means that these parameters are the same as those for the SendCommand API call. For more information about SendCommand parameters, see SendCommand in the AWS Systems Manager API Reference .
For information about available parameters in SSM Command documents, you can view the content of the document itself in the Systems Manager console. For information, see Viewing SSM command document content in the AWS Systems Manager User Guide .
MaintenanceWindowRunCommandParameters is a property of the TaskInvocationParameters property type.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SSM;
var parameters;
var maintenanceWindowRunCommandParametersProperty = new MaintenanceWindowRunCommandParametersProperty {
CloudWatchOutputConfig = new CloudWatchOutputConfigProperty {
CloudWatchLogGroupName = "cloudWatchLogGroupName",
CloudWatchOutputEnabled = false
},
Comment = "comment",
DocumentHash = "documentHash",
DocumentHashType = "documentHashType",
DocumentVersion = "documentVersion",
NotificationConfig = new NotificationConfigProperty {
NotificationArn = "notificationArn",
// the properties below are optional
NotificationEvents = new [] { "notificationEvents" },
NotificationType = "notificationType"
},
OutputS3BucketName = "outputS3BucketName",
OutputS3KeyPrefix = "outputS3KeyPrefix",
Parameters = parameters,
ServiceRoleArn = "serviceRoleArn",
TimeoutSeconds = 123
};Synopsis
Properties
| CloudWatchOutputConfig | Configuration options for sending command output to Amazon CloudWatch Logs. |
| Comment | Information about the command or commands to run. |
| DocumentHash | The SHA-256 or SHA-1 hash created by the system when the document was created. |
| DocumentHashType | The SHA-256 or SHA-1 hash type. |
| DocumentVersion | The AWS Systems Manager document (SSM document) version to use in the request. |
| NotificationConfig | Configurations for sending notifications about command status changes on a per-managed node basis. |
| OutputS3BucketName | The name of the Amazon Simple Storage Service (Amazon S3) bucket. |
| OutputS3KeyPrefix | The S3 bucket subfolder. |
| Parameters | The parameters for the |
| ServiceRoleArn | The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task. |
| TimeoutSeconds | If this time is reached and the command hasn't already started running, it doesn't run. |
Properties
CloudWatchOutputConfig
Configuration options for sending command output to Amazon CloudWatch Logs.
object? CloudWatchOutputConfig { get; }Property Value
Remarks
Type union: either IResolvable or CfnMaintenanceWindowTask.ICloudWatchOutputConfigProperty
Comment
Information about the command or commands to run.
string? Comment { get; }Property Value
Remarks
DocumentHash
The SHA-256 or SHA-1 hash created by the system when the document was created.
string? DocumentHash { get; }Property Value
Remarks
DocumentHashType
The SHA-256 or SHA-1 hash type.
string? DocumentHashType { get; }Property Value
Remarks
DocumentVersion
The AWS Systems Manager document (SSM document) version to use in the request.
string? DocumentVersion { get; }Property Value
Remarks
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:
--document-version "$DEFAULT"
--document-version "$LATEST"
--document-version "3"
NotificationConfig
Configurations for sending notifications about command status changes on a per-managed node basis.
object? NotificationConfig { get; }Property Value
Remarks
Type union: either IResolvable or CfnMaintenanceWindowTask.INotificationConfigProperty
OutputS3BucketName
The name of the Amazon Simple Storage Service (Amazon S3) bucket.
string? OutputS3BucketName { get; }Property Value
Remarks
OutputS3KeyPrefix
The S3 bucket subfolder.
string? OutputS3KeyPrefix { get; }Property Value
Remarks
Parameters
The parameters for the RUN_COMMAND task execution.
object? Parameters { get; }Property Value
Remarks
The supported parameters are the same as those for the SendCommand API call. For more information, see SendCommand in the AWS Systems Manager API Reference .
ServiceRoleArn
The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task.
string? ServiceRoleArn { get; }Property Value
Remarks
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 .
However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the AWS Systems Manager User Guide .
TimeoutSeconds
If this time is reached and the command hasn't already started running, it doesn't run.
double? TimeoutSeconds { get; }