Class SendCommandRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddParametersEntry
(String key, List<String> value) Removes all the entries added into Parameters.clone()
Creates a shallow clone of this request.boolean
User-specified information about the command, such as a brief description of what the command should do.The Sha256 or Sha1 hash created by the system when the document was created.Sha256 or Sha1.Required.Required.The name of the S3 bucket where command execution responses should be stored.The directory structure within the S3 bucket where the responses should be stored.The required and optional parameters specified in the SSM document being executed.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) Required.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
setParameters
(Map<String, List<String>> parameters) The required and optional parameters specified in the SSM document being executed.void
setTimeoutSeconds
(Integer timeoutSeconds) If this time is reached and the command has not already started executing, it will not execute.toString()
Returns a string representation of this object; useful for testing and debugging.withComment
(String comment) User-specified information about the command, such as a brief description of what the command should do.withDocumentHash
(String documentHash) The Sha256 or Sha1 hash created by the system when the document was created.withDocumentHashType
(DocumentHashType documentHashType) Sha256 or Sha1.withDocumentHashType
(String documentHashType) Sha256 or Sha1.withDocumentName
(String documentName) Required.withInstanceIds
(String... instanceIds) Required.withInstanceIds
(Collection<String> instanceIds) Required.withOutputS3BucketName
(String outputS3BucketName) The name of the S3 bucket where command execution responses should be stored.withOutputS3KeyPrefix
(String outputS3KeyPrefix) The directory structure within the S3 bucket where the responses should be stored.withParameters
(Map<String, List<String>> parameters) The required and optional parameters specified in the SSM document being executed.withTimeoutSeconds
(Integer timeoutSeconds) If this time is reached and the command has not already started executing, it will not execute.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
SendCommandRequest
public SendCommandRequest()
-
-
Method Details
-
getInstanceIds
Required. The instance IDs where the command should execute.
- Returns:
- Required. The instance IDs where the command should execute.
-
setInstanceIds
Required. The instance IDs where the command should execute.
- Parameters:
instanceIds
- Required. The instance IDs where the command should execute.
-
withInstanceIds
Required. The instance IDs where the command should execute.
NOTE: This method appends the values to the existing list (if any). Use
setInstanceIds(java.util.Collection)
orwithInstanceIds(java.util.Collection)
if you want to override the existing values.- Parameters:
instanceIds
- Required. The instance IDs where the command should execute.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withInstanceIds
Required. The instance IDs where the command should execute.
- Parameters:
instanceIds
- Required. The instance IDs where the command should execute.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDocumentName
Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.
- Parameters:
documentName
- Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.
-
getDocumentName
Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.
- Returns:
- Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.
-
withDocumentName
Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.
- Parameters:
documentName
- Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDocumentHash
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
- Parameters:
documentHash
- The Sha256 or Sha1 hash created by the system when the document was created.Sha1 hashes have been deprecated.
-
getDocumentHash
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
- Returns:
- The Sha256 or Sha1 hash created by the system when the document
was created.
Sha1 hashes have been deprecated.
-
withDocumentHash
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
- Parameters:
documentHash
- The Sha256 or Sha1 hash created by the system when the document was created.Sha1 hashes have been deprecated.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDocumentHashType
Sha256 or Sha1.
Sha1 hashes have been deprecated.
- Parameters:
documentHashType
- Sha256 or Sha1.Sha1 hashes have been deprecated.
- See Also:
-
getDocumentHashType
Sha256 or Sha1.
Sha1 hashes have been deprecated.
- Returns:
- Sha256 or Sha1.
Sha1 hashes have been deprecated.
- See Also:
-
withDocumentHashType
Sha256 or Sha1.
Sha1 hashes have been deprecated.
- Parameters:
documentHashType
- Sha256 or Sha1.Sha1 hashes have been deprecated.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setDocumentHashType
Sha256 or Sha1.
Sha1 hashes have been deprecated.
- Parameters:
documentHashType
- Sha256 or Sha1.Sha1 hashes have been deprecated.
- See Also:
-
withDocumentHashType
Sha256 or Sha1.
Sha1 hashes have been deprecated.
- Parameters:
documentHashType
- Sha256 or Sha1.Sha1 hashes have been deprecated.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setTimeoutSeconds
If this time is reached and the command has not already started executing, it will not execute.
- Parameters:
timeoutSeconds
- If this time is reached and the command has not already started executing, it will not execute.
-
getTimeoutSeconds
If this time is reached and the command has not already started executing, it will not execute.
- Returns:
- If this time is reached and the command has not already started executing, it will not execute.
-
withTimeoutSeconds
If this time is reached and the command has not already started executing, it will not execute.
- Parameters:
timeoutSeconds
- If this time is reached and the command has not already started executing, it will not execute.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setComment
User-specified information about the command, such as a brief description of what the command should do.
- Parameters:
comment
- User-specified information about the command, such as a brief description of what the command should do.
-
getComment
User-specified information about the command, such as a brief description of what the command should do.
- Returns:
- User-specified information about the command, such as a brief description of what the command should do.
-
withComment
User-specified information about the command, such as a brief description of what the command should do.
- Parameters:
comment
- User-specified information about the command, such as a brief description of what the command should do.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getParameters
The required and optional parameters specified in the SSM document being executed.
- Returns:
- The required and optional parameters specified in the SSM document being executed.
-
setParameters
The required and optional parameters specified in the SSM document being executed.
- Parameters:
parameters
- The required and optional parameters specified in the SSM document being executed.
-
withParameters
The required and optional parameters specified in the SSM document being executed.
- Parameters:
parameters
- The required and optional parameters specified in the SSM document being executed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addParametersEntry
-
clearParametersEntries
Removes all the entries added into Parameters. <p> Returns a reference to this object so that method calls can be chained together. -
setOutputS3BucketName
The name of the S3 bucket where command execution responses should be stored.
- Parameters:
outputS3BucketName
- The name of the S3 bucket where command execution responses should be stored.
-
getOutputS3BucketName
The name of the S3 bucket where command execution responses should be stored.
- Returns:
- The name of the S3 bucket where command execution responses should be stored.
-
withOutputS3BucketName
The name of the S3 bucket where command execution responses should be stored.
- Parameters:
outputS3BucketName
- The name of the S3 bucket where command execution responses should be stored.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOutputS3KeyPrefix
The directory structure within the S3 bucket where the responses should be stored.
- Parameters:
outputS3KeyPrefix
- The directory structure within the S3 bucket where the responses should be stored.
-
getOutputS3KeyPrefix
The directory structure within the S3 bucket where the responses should be stored.
- Returns:
- The directory structure within the S3 bucket where the responses should be stored.
-
withOutputS3KeyPrefix
The directory structure within the S3 bucket where the responses should be stored.
- Parameters:
outputS3KeyPrefix
- The directory structure within the S3 bucket where the responses should be stored.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-