-CloudWatchOutputConfig_CloudWatchLogGroupName <
String>
The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-CloudWatchOutputConfig_CloudWatchOutputEnabled <
Boolean>
Enables Systems Manager to send command output to CloudWatch Logs.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
User-specified information about the command, such as a brief description of what the command should do.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Sha256 or Sha1.Sha1 hashes have been deprecated.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The name of the Systems Manager document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see
Using shared SSM documents in the
AWS Systems Manager User Guide.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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"
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the
Targets
option instead. Using
Targets
, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.For more information about how to use targets, see
Using targets and rate controls to send commands to a fleet in the
AWS Systems Manager User Guide.
Required? | False |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Aliases | InstanceIds |
(Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see
Using concurrency controls in the
AWS Systems Manager User Guide.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see
Using error controls in the
AWS Systems Manager User Guide.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | MaxErrors |
-NotificationConfig_NotificationArn <
String>
An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-NotificationConfig_NotificationEvent <
String[]>
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | NotificationConfig_NotificationEvents |
Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The name of the S3 bucket where command execution responses should be stored.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The directory structure within the S3 bucket where the responses should be stored.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Region of the S3 bucket.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The required and optional parameters specified in the document being run.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Parameters |
Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Use the -Select parameter to control the cmdlet output. The default value is 'Command'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.SendCommandResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.SendCommandResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
An array of search criteria that targets instances using a
Key,Value
combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using
Targets
, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.To send a command to a smaller number of instances, you can use the
InstanceIds
option instead.For more information about how to use targets, see
Sending commands to a fleet in the
AWS Systems Manager User Guide.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Targets |
If this time is reached and the command has not already started running, it will not run.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TimeoutSeconds |