public static interface SendCommandRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<SendCommandRequest.Builder,SendCommandRequest>
| Modifier and Type | Method and Description |
|---|---|
SendCommandRequest.Builder |
cloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)
Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
|
default SendCommandRequest.Builder |
cloudWatchOutputConfig(Consumer<CloudWatchOutputConfig.Builder> cloudWatchOutputConfig)
Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
|
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)
The name of the Systems Manager document to run.
|
SendCommandRequest.Builder |
documentVersion(String documentVersion)
The SSM document version to use in the request.
|
SendCommandRequest.Builder |
instanceIds(Collection<String> instanceIds)
The IDs of the instances where the command should run.
|
SendCommandRequest.Builder |
instanceIds(String... instanceIds)
The IDs of the instances where the command should run.
|
SendCommandRequest.Builder |
maxConcurrency(String maxConcurrency)
(Optional) The maximum number of instances that are allowed to run 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 run.
|
SendCommandRequest.Builder |
serviceRoleArn(String serviceRoleArn)
The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS)
notifications for Run Command commands.
|
SendCommandRequest.Builder |
targets(Collection<Target> targets)
An array of search criteria that targets instances using a
Key,Value combination that you
specify. |
SendCommandRequest.Builder |
targets(Consumer<Target.Builder>... targets)
An array of search criteria that targets instances using a
Key,Value combination that you
specify. |
SendCommandRequest.Builder |
targets(Target... targets)
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 running, it will not run.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildSendCommandRequest.Builder instanceIds(Collection<String> instanceIds)
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.
instanceIds - 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.
SendCommandRequest.Builder instanceIds(String... instanceIds)
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.
instanceIds - 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.
SendCommandRequest.Builder targets(Collection<Target> targets)
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.
targets - 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.
SendCommandRequest.Builder targets(Target... targets)
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.
targets - 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.
SendCommandRequest.Builder targets(Consumer<Target.Builder>... targets)
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.
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)
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.
documentName - 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.SendCommandRequest.Builder documentVersion(String documentVersion)
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"
documentVersion - 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"
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,
DocumentHashTypeSendCommandRequest.Builder documentHashType(DocumentHashType documentHashType)
Sha256 or Sha1.
Sha1 hashes have been deprecated.
documentHashType - Sha256 or Sha1. Sha1 hashes have been deprecated.
DocumentHashType,
DocumentHashTypeSendCommandRequest.Builder timeoutSeconds(Integer timeoutSeconds)
If this time is reached and the command has not already started running, it will not run.
timeoutSeconds - If this time is reached and the command has not already started running, it will not run.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 run.
parameters - The required and optional parameters specified in the document being run.SendCommandRequest.Builder outputS3Region(String outputS3Region)
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Region of the S3 bucket.
outputS3Region - (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager
automatically determines the Region of the S3 bucket.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 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.
maxConcurrency - (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.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 0. For more information about how to use MaxErrors, see Using error controls in the AWS Systems Manager User Guide.
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 0. For more information about
how to use MaxErrors, see Using error controls in the AWS Systems Manager User Guide.SendCommandRequest.Builder serviceRoleArn(String serviceRoleArn)
The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
serviceRoleArn - The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS)
notifications for Run Command commands.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.BuildernotificationConfig(NotificationConfig)SendCommandRequest.Builder cloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)
Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
cloudWatchOutputConfig - Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.default SendCommandRequest.Builder cloudWatchOutputConfig(Consumer<CloudWatchOutputConfig.Builder> cloudWatchOutputConfig)
Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
This is a convenience that creates an instance of theCloudWatchOutputConfig.Builder avoiding the
need to create one manually via CloudWatchOutputConfig.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to cloudWatchOutputConfig(CloudWatchOutputConfig).cloudWatchOutputConfig - a consumer that will call methods on CloudWatchOutputConfig.BuildercloudWatchOutputConfig(CloudWatchOutputConfig)SendCommandRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.SendCommandRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.