| Package | Description |
|---|---|
| software.amazon.awssdk.services.ssm.model |
| Modifier and Type | Method and Description |
|---|---|
Command.Builder |
Command.Builder.alarmConfiguration(AlarmConfiguration alarmConfiguration)
The details for the CloudWatch alarm applied to your command.
|
default Command.Builder |
Command.Builder.alarmConfiguration(Consumer<AlarmConfiguration.Builder> alarmConfiguration)
The details for the CloudWatch alarm applied to your command.
|
static Command.Builder |
Command.builder() |
Command.Builder |
Command.Builder.cloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)
Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command
output.
|
default Command.Builder |
Command.Builder.cloudWatchOutputConfig(Consumer<CloudWatchOutputConfig.Builder> cloudWatchOutputConfig)
Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command
output.
|
Command.Builder |
Command.Builder.commandId(String commandId)
A unique identifier for this command.
|
Command.Builder |
Command.Builder.comment(String comment)
User-specified information about the command, such as a brief description of what the command should do.
|
Command.Builder |
Command.Builder.completedCount(Integer completedCount)
The number of targets for which the command invocation reached a terminal state.
|
Command.Builder |
Command.Builder.deliveryTimedOutCount(Integer deliveryTimedOutCount)
The number of targets for which the status is Delivery Timed Out.
|
Command.Builder |
Command.Builder.documentName(String documentName)
The name of the document requested for execution.
|
Command.Builder |
Command.Builder.documentVersion(String documentVersion)
The Systems Manager document (SSM document) version.
|
Command.Builder |
Command.Builder.errorCount(Integer errorCount)
The number of targets for which the status is Failed or Execution Timed Out.
|
Command.Builder |
Command.Builder.expiresAfter(Instant expiresAfter)
If a command expires, it changes status to
DeliveryTimedOut for all invocations that have the
status InProgress, Pending, or Delayed. |
Command.Builder |
Command.Builder.instanceIds(Collection<String> instanceIds)
The managed node IDs against which this command was requested.
|
Command.Builder |
Command.Builder.instanceIds(String... instanceIds)
The managed node IDs against which this command was requested.
|
Command.Builder |
Command.Builder.maxConcurrency(String maxConcurrency)
The maximum number of managed nodes that are allowed to run the command at the same time.
|
Command.Builder |
Command.Builder.maxErrors(String maxErrors)
The maximum number of errors allowed before the system stops sending the command to additional targets.
|
default Command.Builder |
Command.Builder.notificationConfig(Consumer<NotificationConfig.Builder> notificationConfig)
Configurations for sending notifications about command status changes.
|
Command.Builder |
Command.Builder.notificationConfig(NotificationConfig notificationConfig)
Configurations for sending notifications about command status changes.
|
Command.Builder |
Command.Builder.outputS3BucketName(String outputS3BucketName)
The S3 bucket where the responses to the command executions should be stored.
|
Command.Builder |
Command.Builder.outputS3KeyPrefix(String outputS3KeyPrefix)
The S3 directory path inside the bucket where the responses to the command executions should be stored.
|
Command.Builder |
Command.Builder.outputS3Region(String outputS3Region)
(Deprecated) You can no longer specify this parameter.
|
Command.Builder |
Command.Builder.parameters(Map<String,? extends Collection<String>> parameters)
The parameter values to be inserted in the document when running the command.
|
Command.Builder |
Command.Builder.requestedDateTime(Instant requestedDateTime)
The date and time the command was requested.
|
Command.Builder |
Command.Builder.serviceRole(String serviceRole)
The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services
Systems Manager, uses to act on your behalf when sending notifications about command status changes.
|
Command.Builder |
Command.Builder.status(CommandStatus status)
The status of the command.
|
Command.Builder |
Command.Builder.status(String status)
The status of the command.
|
Command.Builder |
Command.Builder.statusDetails(String statusDetails)
A detailed status of the command execution.
|
Command.Builder |
Command.Builder.targetCount(Integer targetCount)
The number of targets for the command.
|
Command.Builder |
Command.Builder.targets(Collection<Target> targets)
An array of search criteria that targets managed nodes using a Key,Value combination that you specify.
|
Command.Builder |
Command.Builder.targets(Consumer<Target.Builder>... targets)
An array of search criteria that targets managed nodes using a Key,Value combination that you specify.
|
Command.Builder |
Command.Builder.targets(Target... targets)
An array of search criteria that targets managed nodes using a Key,Value combination that you specify.
|
Command.Builder |
Command.Builder.timeoutSeconds(Integer timeoutSeconds)
The
TimeoutSeconds value specified for a command. |
Command.Builder |
Command.toBuilder() |
Command.Builder |
Command.Builder.triggeredAlarms(AlarmStateInformation... triggeredAlarms)
The CloudWatch alarm that was invoked by the command.
|
Command.Builder |
Command.Builder.triggeredAlarms(Collection<AlarmStateInformation> triggeredAlarms)
The CloudWatch alarm that was invoked by the command.
|
Command.Builder |
Command.Builder.triggeredAlarms(Consumer<AlarmStateInformation.Builder>... triggeredAlarms)
The CloudWatch alarm that was invoked by the command.
|
| Modifier and Type | Method and Description |
|---|---|
static Class<? extends Command.Builder> |
Command.serializableBuilderClass() |
| Modifier and Type | Method and Description |
|---|---|
default SendCommandResponse.Builder |
SendCommandResponse.Builder.command(Consumer<Command.Builder> command)
The request as it was received by Systems Manager.
|
Copyright © 2022. All rights reserved.