public static interface SendCommandRequest.Builder extends SsmRequest.Builder, CopyableBuilder<SendCommandRequest.Builder,SendCommandRequest>
Modifier and Type | Method and Description |
---|---|
SendCommandRequest.Builder |
comment(String comment)
User-specified information about the command, such as a brief description of what the command should do.
|
SendCommandRequest.Builder |
documentHash(String documentHash)
The Sha256 or Sha1 hash created by the system when the document was created.
|
SendCommandRequest.Builder |
documentHashType(DocumentHashType documentHashType)
Sha256 or Sha1.
|
SendCommandRequest.Builder |
documentHashType(String documentHashType)
Sha256 or Sha1.
|
SendCommandRequest.Builder |
documentName(String documentName)
Required.
|
SendCommandRequest.Builder |
instanceIds(Collection<String> instanceIds)
The instance IDs where the command should execute.
|
SendCommandRequest.Builder |
instanceIds(String... instanceIds)
The instance IDs where the command should execute.
|
SendCommandRequest.Builder |
maxConcurrency(String maxConcurrency)
(Optional) The maximum number of instances that are allowed to execute the command at the same time.
|
SendCommandRequest.Builder |
maxErrors(String maxErrors)
The maximum number of errors allowed without the command failing.
|
default SendCommandRequest.Builder |
notificationConfig(Consumer<NotificationConfig.Builder> notificationConfig)
Configurations for sending notifications.
|
SendCommandRequest.Builder |
notificationConfig(NotificationConfig notificationConfig)
Configurations for sending notifications.
|
SendCommandRequest.Builder |
outputS3BucketName(String outputS3BucketName)
The name of the S3 bucket where command execution responses should be stored.
|
SendCommandRequest.Builder |
outputS3KeyPrefix(String outputS3KeyPrefix)
The directory structure within the S3 bucket where the responses should be stored.
|
SendCommandRequest.Builder |
outputS3Region(String outputS3Region)
(Deprecated) You can no longer specify this parameter.
|
SendCommandRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
SendCommandRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
SendCommandRequest.Builder |
parameters(Map<String,? extends Collection<String>> parameters)
The required and optional parameters specified in the document being executed.
|
SendCommandRequest.Builder |
serviceRoleArn(String serviceRoleArn)
The IAM role that Systems Manager uses to send notifications.
|
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 |
targets(Consumer<Target.Builder>... targets)
(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify.
|
SendCommandRequest.Builder |
targets(Target... targets)
(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify.
|
SendCommandRequest.Builder |
timeoutSeconds(Integer timeoutSeconds)
If this time is reached and the command has not already started executing, it will not execute.
|
build
overrideConfiguration
copy
applyMutation, build
SendCommandRequest.Builder instanceIds(Collection<String> instanceIds)
The instance IDs where the command should execute. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use Targets, see Sending Commands to a Fleet.
instanceIds
- The instance IDs where the command should execute. You can specify a maximum of 50 IDs. If you prefer
not to list individual instance IDs, you can instead send commands to a fleet of instances using the
Targets parameter, which accepts EC2 tags. For more information about how to use Targets, see Sending
Commands to a Fleet.SendCommandRequest.Builder instanceIds(String... instanceIds)
The instance IDs where the command should execute. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use Targets, see Sending Commands to a Fleet.
instanceIds
- The instance IDs where the command should execute. You can specify a maximum of 50 IDs. If you prefer
not to list individual instance IDs, you can instead send commands to a fleet of instances using the
Targets parameter, which accepts EC2 tags. For more information about how to use Targets, see Sending
Commands to a Fleet.SendCommandRequest.Builder targets(Collection<Target> targets)
(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use Targets, see Sending Commands to a Fleet.
targets
- (Optional) An array of search criteria that targets instances using a Key,Value combination that you
specify. Targets is required if you don't provide one or more instance IDs in the call. For more
information about how to use Targets, see Sending
Commands to a Fleet.SendCommandRequest.Builder targets(Target... targets)
(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use Targets, see Sending Commands to a Fleet.
targets
- (Optional) An array of search criteria that targets instances using a Key,Value combination that you
specify. Targets is required if you don't provide one or more instance IDs in the call. For more
information about how to use Targets, see Sending
Commands to a Fleet.SendCommandRequest.Builder targets(Consumer<Target.Builder>... targets)
(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use Targets, see Sending Commands to a Fleet.
This is a convenience that creates an instance of theList.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #targets(List)
.targets
- a consumer that will call methods on List.Builder
#targets(List)
SendCommandRequest.Builder documentName(String documentName)
Required. The name of the Systems Manager document to execute. This can be a public document or a custom document.
documentName
- Required. The name of the Systems Manager document to execute. This can be a public document or a
custom document.SendCommandRequest.Builder documentHash(String documentHash)
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
documentHash
- The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated.
SendCommandRequest.Builder documentHashType(String documentHashType)
Sha256 or Sha1.
Sha1 hashes have been deprecated.
documentHashType
- Sha256 or Sha1. Sha1 hashes have been deprecated.
DocumentHashType
,
DocumentHashType
SendCommandRequest.Builder documentHashType(DocumentHashType documentHashType)
Sha256 or Sha1.
Sha1 hashes have been deprecated.
documentHashType
- Sha256 or Sha1. Sha1 hashes have been deprecated.
DocumentHashType
,
DocumentHashType
SendCommandRequest.Builder timeoutSeconds(Integer timeoutSeconds)
If this time is reached and the command has not already started executing, it will not execute.
timeoutSeconds
- If this time is reached and the command has not already started executing, it will not execute.SendCommandRequest.Builder comment(String comment)
User-specified information about the command, such as a brief description of what the command should do.
comment
- User-specified information about the command, such as a brief description of what the command should
do.SendCommandRequest.Builder parameters(Map<String,? extends Collection<String>> parameters)
The required and optional parameters specified in the document being executed.
parameters
- The required and optional parameters specified in the document being executed.SendCommandRequest.Builder outputS3Region(String outputS3Region)
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.
outputS3Region
- (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager
automatically determines the Amazon S3 bucket region.SendCommandRequest.Builder outputS3BucketName(String outputS3BucketName)
The name of the S3 bucket where command execution responses should be stored.
outputS3BucketName
- The name of the S3 bucket where command execution responses should be stored.SendCommandRequest.Builder outputS3KeyPrefix(String outputS3KeyPrefix)
The directory structure within the S3 bucket where the responses should be stored.
outputS3KeyPrefix
- The directory structure within the S3 bucket where the responses should be stored.SendCommandRequest.Builder maxConcurrency(String maxConcurrency)
(Optional) The maximum number of instances that are allowed to execute 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.
maxConcurrency
- (Optional) The maximum number of instances that are allowed to execute 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.SendCommandRequest.Builder maxErrors(String maxErrors)
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 50. For more information about how to use MaxErrors, see Using Error Controls.
maxErrors
- 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 50. For more information about
how to use MaxErrors, see Using
Error Controls.SendCommandRequest.Builder serviceRoleArn(String serviceRoleArn)
The IAM role that Systems Manager uses to send notifications.
serviceRoleArn
- The IAM role that Systems Manager uses to send notifications.SendCommandRequest.Builder notificationConfig(NotificationConfig notificationConfig)
Configurations for sending notifications.
notificationConfig
- Configurations for sending notifications.default SendCommandRequest.Builder notificationConfig(Consumer<NotificationConfig.Builder> notificationConfig)
Configurations for sending notifications.
This is a convenience that creates an instance of theNotificationConfig.Builder
avoiding the need to
create one manually via NotificationConfig.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to notificationConfig(NotificationConfig)
.notificationConfig
- a consumer that will call methods on NotificationConfig.Builder
notificationConfig(NotificationConfig)
SendCommandRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.SendCommandRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.