@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SendCommandRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
SendCommandRequest() |
Modifier and Type | Method and Description |
---|---|
SendCommandRequest |
addParametersEntry(String key,
List<String> value) |
SendCommandRequest |
clearParametersEntries()
Removes all the entries added into Parameters.
|
SendCommandRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getComment()
User-specified information about the command, such as a brief description of what the command should do.
|
String |
getDocumentHash()
The Sha256 or Sha1 hash created by the system when the document was created.
|
String |
getDocumentHashType()
Sha256 or Sha1.
|
String |
getDocumentName()
Required.
|
List<String> |
getInstanceIds()
The instance IDs where the command should execute.
|
String |
getMaxConcurrency()
(Optional) The maximum number of instances that are allowed to execute the command at the same time.
|
String |
getMaxErrors()
The maximum number of errors allowed without the command failing.
|
NotificationConfig |
getNotificationConfig()
Configurations for sending notifications.
|
String |
getOutputS3BucketName()
The name of the S3 bucket where command execution responses should be stored.
|
String |
getOutputS3KeyPrefix()
The directory structure within the S3 bucket where the responses should be stored.
|
String |
getOutputS3Region()
(Deprecated) You can no longer specify this parameter.
|
Map<String,List<String>> |
getParameters()
The required and optional parameters specified in the document being executed.
|
String |
getServiceRoleArn()
The IAM role that Systems Manager uses to send notifications.
|
List<Target> |
getTargets()
(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify.
|
Integer |
getTimeoutSeconds()
If this time is reached and the command has not already started executing, it will not execute.
|
int |
hashCode() |
void |
setComment(String comment)
User-specified information about the command, such as a brief description of what the command should do.
|
void |
setDocumentHash(String documentHash)
The Sha256 or Sha1 hash created by the system when the document was created.
|
void |
setDocumentHashType(DocumentHashType documentHashType)
Sha256 or Sha1.
|
void |
setDocumentHashType(String documentHashType)
Sha256 or Sha1.
|
void |
setDocumentName(String documentName)
Required.
|
void |
setInstanceIds(Collection<String> instanceIds)
The instance IDs where the command should execute.
|
void |
setMaxConcurrency(String maxConcurrency)
(Optional) The maximum number of instances that are allowed to execute the command at the same time.
|
void |
setMaxErrors(String maxErrors)
The maximum number of errors allowed without the command failing.
|
void |
setNotificationConfig(NotificationConfig notificationConfig)
Configurations for sending notifications.
|
void |
setOutputS3BucketName(String outputS3BucketName)
The name of the S3 bucket where command execution responses should be stored.
|
void |
setOutputS3KeyPrefix(String outputS3KeyPrefix)
The directory structure within the S3 bucket where the responses should be stored.
|
void |
setOutputS3Region(String outputS3Region)
(Deprecated) You can no longer specify this parameter.
|
void |
setParameters(Map<String,List<String>> parameters)
The required and optional parameters specified in the document being executed.
|
void |
setServiceRoleArn(String serviceRoleArn)
The IAM role that Systems Manager uses to send notifications.
|
void |
setTargets(Collection<Target> targets)
(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify.
|
void |
setTimeoutSeconds(Integer timeoutSeconds)
If this time is reached and the command has not already started executing, it will not execute.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
SendCommandRequest |
withComment(String comment)
User-specified information about the command, such as a brief description of what the command should do.
|
SendCommandRequest |
withDocumentHash(String documentHash)
The Sha256 or Sha1 hash created by the system when the document was created.
|
SendCommandRequest |
withDocumentHashType(DocumentHashType documentHashType)
Sha256 or Sha1.
|
SendCommandRequest |
withDocumentHashType(String documentHashType)
Sha256 or Sha1.
|
SendCommandRequest |
withDocumentName(String documentName)
Required.
|
SendCommandRequest |
withInstanceIds(Collection<String> instanceIds)
The instance IDs where the command should execute.
|
SendCommandRequest |
withInstanceIds(String... instanceIds)
The instance IDs where the command should execute.
|
SendCommandRequest |
withMaxConcurrency(String maxConcurrency)
(Optional) The maximum number of instances that are allowed to execute the command at the same time.
|
SendCommandRequest |
withMaxErrors(String maxErrors)
The maximum number of errors allowed without the command failing.
|
SendCommandRequest |
withNotificationConfig(NotificationConfig notificationConfig)
Configurations for sending notifications.
|
SendCommandRequest |
withOutputS3BucketName(String outputS3BucketName)
The name of the S3 bucket where command execution responses should be stored.
|
SendCommandRequest |
withOutputS3KeyPrefix(String outputS3KeyPrefix)
The directory structure within the S3 bucket where the responses should be stored.
|
SendCommandRequest |
withOutputS3Region(String outputS3Region)
(Deprecated) You can no longer specify this parameter.
|
SendCommandRequest |
withParameters(Map<String,List<String>> parameters)
The required and optional parameters specified in the document being executed.
|
SendCommandRequest |
withServiceRoleArn(String serviceRoleArn)
The IAM role that Systems Manager uses to send notifications.
|
SendCommandRequest |
withTargets(Collection<Target> targets)
(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify.
|
SendCommandRequest |
withTargets(Target... targets)
(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify.
|
SendCommandRequest |
withTimeoutSeconds(Integer timeoutSeconds)
If this time is reached and the command has not already started executing, it will not execute.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public List<String> getInstanceIds()
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.
public void setInstanceIds(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.public SendCommandRequest withInstanceIds(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.
NOTE: This method appends the values to the existing list (if any). Use
setInstanceIds(java.util.Collection)
or withInstanceIds(java.util.Collection)
if you want to
override the existing values.
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.public SendCommandRequest withInstanceIds(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.public List<Target> getTargets()
(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.
public void setTargets(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.public SendCommandRequest withTargets(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.
NOTE: This method appends the values to the existing list (if any). Use
setTargets(java.util.Collection)
or withTargets(java.util.Collection)
if you want to override
the existing values.
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.public SendCommandRequest withTargets(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.public void setDocumentName(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.public String getDocumentName()
Required. The name of the Systems Manager document to execute. This can be a public document or a custom document.
public SendCommandRequest withDocumentName(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.public void setDocumentHash(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.
public String getDocumentHash()
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 SendCommandRequest withDocumentHash(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.
public void setDocumentHashType(String documentHashType)
Sha256 or Sha1.
Sha1 hashes have been deprecated.
documentHashType
- Sha256 or Sha1. Sha1 hashes have been deprecated.
DocumentHashType
public String getDocumentHashType()
Sha256 or Sha1.
Sha1 hashes have been deprecated.
Sha1 hashes have been deprecated.
DocumentHashType
public SendCommandRequest withDocumentHashType(String documentHashType)
Sha256 or Sha1.
Sha1 hashes have been deprecated.
documentHashType
- Sha256 or Sha1. Sha1 hashes have been deprecated.
DocumentHashType
public void setDocumentHashType(DocumentHashType documentHashType)
Sha256 or Sha1.
Sha1 hashes have been deprecated.
documentHashType
- Sha256 or Sha1. Sha1 hashes have been deprecated.
DocumentHashType
public SendCommandRequest withDocumentHashType(DocumentHashType documentHashType)
Sha256 or Sha1.
Sha1 hashes have been deprecated.
documentHashType
- Sha256 or Sha1. Sha1 hashes have been deprecated.
DocumentHashType
public void setTimeoutSeconds(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.public Integer getTimeoutSeconds()
If this time is reached and the command has not already started executing, it will not execute.
public SendCommandRequest withTimeoutSeconds(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.public void setComment(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.public String getComment()
User-specified information about the command, such as a brief description of what the command should do.
public SendCommandRequest withComment(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.public Map<String,List<String>> getParameters()
The required and optional parameters specified in the document being executed.
public void setParameters(Map<String,List<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.public SendCommandRequest withParameters(Map<String,List<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.public SendCommandRequest addParametersEntry(String key, List<String> value)
public SendCommandRequest clearParametersEntries()
public void setOutputS3Region(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.public String getOutputS3Region()
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.
public SendCommandRequest withOutputS3Region(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.public void setOutputS3BucketName(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.public String getOutputS3BucketName()
The name of the S3 bucket where command execution responses should be stored.
public SendCommandRequest withOutputS3BucketName(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.public void setOutputS3KeyPrefix(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.public String getOutputS3KeyPrefix()
The directory structure within the S3 bucket where the responses should be stored.
public SendCommandRequest withOutputS3KeyPrefix(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.public void setMaxConcurrency(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.public String getMaxConcurrency()
(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 SendCommandRequest withMaxConcurrency(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.public void setMaxErrors(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.public String getMaxErrors()
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 SendCommandRequest withMaxErrors(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.public void setServiceRoleArn(String serviceRoleArn)
The IAM role that Systems Manager uses to send notifications.
serviceRoleArn
- The IAM role that Systems Manager uses to send notifications.public String getServiceRoleArn()
The IAM role that Systems Manager uses to send notifications.
public SendCommandRequest withServiceRoleArn(String serviceRoleArn)
The IAM role that Systems Manager uses to send notifications.
serviceRoleArn
- The IAM role that Systems Manager uses to send notifications.public void setNotificationConfig(NotificationConfig notificationConfig)
Configurations for sending notifications.
notificationConfig
- Configurations for sending notifications.public NotificationConfig getNotificationConfig()
Configurations for sending notifications.
public SendCommandRequest withNotificationConfig(NotificationConfig notificationConfig)
Configurations for sending notifications.
notificationConfig
- Configurations for sending notifications.public String toString()
toString
in class Object
Object.toString()
public SendCommandRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.