@Generated(value="software.amazon.awssdk:codegen") public final class SendCommandRequest extends SsmRequest implements ToCopyableBuilder<SendCommandRequest.Builder,SendCommandRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
SendCommandRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static SendCommandRequest.Builder |
builder() |
String |
comment()
User-specified information about the command, such as a brief description of what the command should do.
|
String |
documentHash()
The Sha256 or Sha1 hash created by the system when the document was created.
|
DocumentHashType |
documentHashType()
Sha256 or Sha1.
|
String |
documentHashTypeAsString()
Sha256 or Sha1.
|
String |
documentName()
Required.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
List<String> |
instanceIds()
The instance IDs where the command should execute.
|
String |
maxConcurrency()
(Optional) The maximum number of instances that are allowed to execute the command at the same time.
|
String |
maxErrors()
The maximum number of errors allowed without the command failing.
|
NotificationConfig |
notificationConfig()
Configurations for sending notifications.
|
String |
outputS3BucketName()
The name of the S3 bucket where command execution responses should be stored.
|
String |
outputS3KeyPrefix()
The directory structure within the S3 bucket where the responses should be stored.
|
String |
outputS3Region()
(Deprecated) You can no longer specify this parameter.
|
Map<String,List<String>> |
parameters()
The required and optional parameters specified in the document being executed.
|
static Class<? extends SendCommandRequest.Builder> |
serializableBuilderClass() |
String |
serviceRoleArn()
The IAM role that Systems Manager uses to send notifications.
|
List<Target> |
targets()
(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify.
|
Integer |
timeoutSeconds()
If this time is reached and the command has not already started executing, it will not execute.
|
SendCommandRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String documentName()
Required. The name of the Systems Manager document to execute. This can be a public document or a custom document.
public String documentHash()
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
Sha1 hashes have been deprecated.
public DocumentHashType documentHashType()
Sha256 or Sha1.
Sha1 hashes have been deprecated.
If the service returns an enum value that is not available in the current SDK version, documentHashType
will return DocumentHashType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from documentHashTypeAsString()
.
Sha1 hashes have been deprecated.
DocumentHashType
public String documentHashTypeAsString()
Sha256 or Sha1.
Sha1 hashes have been deprecated.
If the service returns an enum value that is not available in the current SDK version, documentHashType
will return DocumentHashType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from documentHashTypeAsString()
.
Sha1 hashes have been deprecated.
DocumentHashType
public Integer timeoutSeconds()
If this time is reached and the command has not already started executing, it will not execute.
public String comment()
User-specified information about the command, such as a brief description of what the command should do.
public Map<String,List<String>> parameters()
The required and optional parameters specified in the document being executed.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String outputS3Region()
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.
public String outputS3BucketName()
The name of the S3 bucket where command execution responses should be stored.
public String outputS3KeyPrefix()
The directory structure within the S3 bucket where the responses should be stored.
public 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.
public 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.
public String serviceRoleArn()
The IAM role that Systems Manager uses to send notifications.
public NotificationConfig notificationConfig()
Configurations for sending notifications.
public SendCommandRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<SendCommandRequest.Builder,SendCommandRequest>
toBuilder
in class SsmRequest
public static SendCommandRequest.Builder builder()
public static Class<? extends SendCommandRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.