| Package | Description |
|---|---|
| software.amazon.awssdk.services.ssm |
|
| software.amazon.awssdk.services.ssm.model |
| Modifier and Type | Method and Description |
|---|---|
default SendCommandResponse |
SsmClient.sendCommand(Consumer<SendCommandRequest.Builder> sendCommandRequest)
Executes commands on one or more managed instances.
|
default CompletableFuture<SendCommandResponse> |
SsmAsyncClient.sendCommand(Consumer<SendCommandRequest.Builder> sendCommandRequest)
Executes commands on one or more managed instances.
|
| Modifier and Type | Method and Description |
|---|---|
static SendCommandRequest.Builder |
SendCommandRequest.builder() |
SendCommandRequest.Builder |
SendCommandRequest.Builder.cloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)
Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
|
default SendCommandRequest.Builder |
SendCommandRequest.Builder.cloudWatchOutputConfig(Consumer<CloudWatchOutputConfig.Builder> cloudWatchOutputConfig)
Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.comment(String comment)
User-specified information about the command, such as a brief description of what the command should do.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.documentHash(String documentHash)
The Sha256 or Sha1 hash created by the system when the document was created.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.documentHashType(DocumentHashType documentHashType)
Sha256 or Sha1.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.documentHashType(String documentHashType)
Sha256 or Sha1.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.documentName(String documentName)
Required.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.documentVersion(String documentVersion)
The SSM document version to use in the request.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.instanceIds(Collection<String> instanceIds)
The instance IDs where the command should execute.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.instanceIds(String... instanceIds)
The instance IDs where the command should execute.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.maxConcurrency(String maxConcurrency)
(Optional) The maximum number of instances that are allowed to execute the command at the same time.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.maxErrors(String maxErrors)
The maximum number of errors allowed without the command failing.
|
default SendCommandRequest.Builder |
SendCommandRequest.Builder.notificationConfig(Consumer<NotificationConfig.Builder> notificationConfig)
Configurations for sending notifications.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.notificationConfig(NotificationConfig notificationConfig)
Configurations for sending notifications.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.outputS3BucketName(String outputS3BucketName)
The name of the S3 bucket where command execution responses should be stored.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.outputS3KeyPrefix(String outputS3KeyPrefix)
The directory structure within the S3 bucket where the responses should be stored.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.outputS3Region(String outputS3Region)
(Deprecated) You can no longer specify this parameter.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
SendCommandRequest.Builder |
SendCommandRequest.Builder.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
SendCommandRequest.Builder |
SendCommandRequest.Builder.parameters(Map<String,? extends Collection<String>> parameters)
The required and optional parameters specified in the document being executed.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.serviceRoleArn(String serviceRoleArn)
The IAM role that Systems Manager uses to send notifications.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.targets(Collection<Target> targets)
(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.targets(Consumer<Target.Builder>... targets)
(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.targets(Target... targets)
(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.timeoutSeconds(Integer timeoutSeconds)
If this time is reached and the command has not already started executing, it will not run.
|
SendCommandRequest.Builder |
SendCommandRequest.toBuilder() |
| Modifier and Type | Method and Description |
|---|---|
static Class<? extends SendCommandRequest.Builder> |
SendCommandRequest.serializableBuilderClass() |
Copyright © 2018. All rights reserved.