You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SSM::Types::MaintenanceWindowRunCommandParametersWhen passing MaintenanceWindowRunCommandParameters as input to an Aws::Client method, you can use a vanilla Hash:
{
comment: "Comment",
cloud_watch_output_config: {
cloud_watch_log_group_name: "CloudWatchLogGroupName",
cloud_watch_output_enabled: false,
},
document_hash: "DocumentHash",
document_hash_type: "Sha256", document_version: "DocumentVersion",
notification_config: {
notification_arn: "NotificationArn",
notification_events: ["All"], notification_type: "Command", },
output_s3_bucket_name: "S3BucketName",
output_s3_key_prefix: "S3KeyPrefix",
parameters: {
"ParameterName" => ["ParameterValue"],
},
service_role_arn: "ServiceRole",
timeout_seconds: 1,
}
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 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.
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
.
Returned by:
Instance Attribute Summary collapseConfiguration options for sending command output to CloudWatch Logs.
.
Information about the commands to run.
The SHA-256 or SHA-1 hash created by the system when the document was created.
SHA-256 or SHA-1.
The SSM document version to use in the request.
Configurations for sending notifications about command status changes on a per-instance basis.
The name of the S3 bucket.
The S3 bucket subfolder.
The parameters for the RUN_COMMAND task execution.
The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
If this time is reached and the command has not already started running, it doesn\'t run.
Information about the commands to run.
#document_hash ⇒ StringThe SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
#document_hash_type ⇒ StringSHA-256 or SHA-1. SHA-1 hashes have been deprecated.
Possible values:
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:
--document-version \"\$DEFAULT\"
--document-version \"\$LATEST\"
--document-version \"3\"
#notification_config ⇒ Types::NotificationConfigConfigurations for sending notifications about command status changes on a per-instance basis.
#output_s3_bucket_name ⇒ StringThe name of the S3 bucket.
#output_s3_key_prefix ⇒ String #parameters ⇒ Hash<String,Array<String>>The parameters for the RUN_COMMAND task execution.
#service_role_arn ⇒ StringThe ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
#timeout_seconds ⇒ IntegerIf this time is reached and the command has not already started running, it doesn\'t run.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4