| Package | Description |
|---|---|
| software.amazon.awssdk.services.ssm |
Amazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as
collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images
(AMIs), and configuring operating systems (OSs) and applications at scale.
|
| software.amazon.awssdk.services.ssm.model |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<SendCommandResponse> |
SsmAsyncClient.sendCommand(Consumer<SendCommandRequest.Builder> sendCommandRequest)
Runs commands on one or more managed nodes.
|
default SendCommandResponse |
SsmClient.sendCommand(Consumer<SendCommandRequest.Builder> sendCommandRequest)
Runs commands on one or more managed nodes.
|
| Modifier and Type | Method and Description |
|---|---|
static SendCommandRequest.Builder |
SendCommandRequest.builder() |
SendCommandRequest.Builder |
SendCommandRequest.Builder.cloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)
Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs.
|
default SendCommandRequest.Builder |
SendCommandRequest.Builder.cloudWatchOutputConfig(Consumer<CloudWatchOutputConfig.Builder> cloudWatchOutputConfig)
Enables Amazon Web Services 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)
The name of the Amazon Web Services Systems Manager document (SSM document) to run.
|
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 IDs of the managed nodes where the command should run.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.instanceIds(String... instanceIds)
The IDs of the managed nodes where the command should run.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.maxConcurrency(String maxConcurrency)
(Optional) The maximum number of managed nodes that are allowed to run 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 run.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.serviceRoleArn(String serviceRoleArn)
The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification
Service (Amazon SNS) notifications for Run Command commands.
|
SendCommandRequest.Builder |
SendCommandRequest.Builder.targets(Collection<Target> targets)
An array of search criteria that targets managed nodes using a
Key,Value combination that you
specify. |
SendCommandRequest.Builder |
SendCommandRequest.Builder.targets(Consumer<Target.Builder>... targets)
An array of search criteria that targets managed nodes using a
Key,Value combination that you
specify. |
SendCommandRequest.Builder |
SendCommandRequest.Builder.targets(Target... targets)
An array of search criteria that targets managed nodes using a
Key,Value combination that you
specify. |
SendCommandRequest.Builder |
SendCommandRequest.Builder.timeoutSeconds(Integer timeoutSeconds)
If this time is reached and the command hasn't already started running, it won't run.
|
SendCommandRequest.Builder |
SendCommandRequest.toBuilder() |
| Modifier and Type | Method and Description |
|---|---|
static Class<? extends SendCommandRequest.Builder> |
SendCommandRequest.serializableBuilderClass() |
Copyright © 2022. All rights reserved.