public class SendCommandRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
comment
User-specified information about the command, such as a brief description
of what the command should do.
|
private java.lang.String |
documentHash
The Sha256 or Sha1 hash created by the system when the document was
created.
|
private java.lang.String |
documentHashType
Sha256 or Sha1.
|
private java.lang.String |
documentName
Required.
|
private SdkInternalList<java.lang.String> |
instanceIds
Required.
|
private java.lang.String |
outputS3BucketName
The name of the S3 bucket where command execution responses should be
stored.
|
private java.lang.String |
outputS3KeyPrefix
The directory structure within the S3 bucket where the responses should
be stored.
|
private java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
parameters
The required and optional parameters specified in the SSM document being
executed.
|
private java.lang.Integer |
timeoutSeconds
If this time is reached and the command has not already started
executing, it will not execute.
|
NOOP
Constructor and Description |
---|
SendCommandRequest() |
Modifier and Type | Method and Description |
---|---|
SendCommandRequest |
addParametersEntry(java.lang.String key,
java.util.List<java.lang.String> value) |
SendCommandRequest |
clearParametersEntries()
Removes all the entries added into Parameters.
|
SendCommandRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getComment()
User-specified information about the command, such as a brief description
of what the command should do.
|
java.lang.String |
getDocumentHash()
The Sha256 or Sha1 hash created by the system when the document was
created.
|
java.lang.String |
getDocumentHashType()
Sha256 or Sha1.
|
java.lang.String |
getDocumentName()
Required.
|
java.util.List<java.lang.String> |
getInstanceIds()
Required.
|
java.lang.String |
getOutputS3BucketName()
The name of the S3 bucket where command execution responses should be
stored.
|
java.lang.String |
getOutputS3KeyPrefix()
The directory structure within the S3 bucket where the responses should
be stored.
|
java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
getParameters()
The required and optional parameters specified in the SSM document being
executed.
|
java.lang.Integer |
getTimeoutSeconds()
If this time is reached and the command has not already started
executing, it will not execute.
|
int |
hashCode() |
void |
setComment(java.lang.String comment)
User-specified information about the command, such as a brief description
of what the command should do.
|
void |
setDocumentHash(java.lang.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(java.lang.String documentHashType)
Sha256 or Sha1.
|
void |
setDocumentName(java.lang.String documentName)
Required.
|
void |
setInstanceIds(java.util.Collection<java.lang.String> instanceIds)
Required.
|
void |
setOutputS3BucketName(java.lang.String outputS3BucketName)
The name of the S3 bucket where command execution responses should be
stored.
|
void |
setOutputS3KeyPrefix(java.lang.String outputS3KeyPrefix)
The directory structure within the S3 bucket where the responses should
be stored.
|
void |
setParameters(java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)
The required and optional parameters specified in the SSM document being
executed.
|
void |
setTimeoutSeconds(java.lang.Integer timeoutSeconds)
If this time is reached and the command has not already started
executing, it will not execute.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
SendCommandRequest |
withComment(java.lang.String comment)
User-specified information about the command, such as a brief description
of what the command should do.
|
SendCommandRequest |
withDocumentHash(java.lang.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(java.lang.String documentHashType)
Sha256 or Sha1.
|
SendCommandRequest |
withDocumentName(java.lang.String documentName)
Required.
|
SendCommandRequest |
withInstanceIds(java.util.Collection<java.lang.String> instanceIds)
Required.
|
SendCommandRequest |
withInstanceIds(java.lang.String... instanceIds)
Required.
|
SendCommandRequest |
withOutputS3BucketName(java.lang.String outputS3BucketName)
The name of the S3 bucket where command execution responses should be
stored.
|
SendCommandRequest |
withOutputS3KeyPrefix(java.lang.String outputS3KeyPrefix)
The directory structure within the S3 bucket where the responses should
be stored.
|
SendCommandRequest |
withParameters(java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)
The required and optional parameters specified in the SSM document being
executed.
|
SendCommandRequest |
withTimeoutSeconds(java.lang.Integer timeoutSeconds)
If this time is reached and the command has not already started
executing, it will not execute.
|
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
private SdkInternalList<java.lang.String> instanceIds
Required. The instance IDs where the command should execute.
private java.lang.String documentName
Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.
private java.lang.String documentHash
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
private java.lang.String documentHashType
Sha256 or Sha1.
Sha1 hashes have been deprecated.
private java.lang.Integer timeoutSeconds
If this time is reached and the command has not already started executing, it will not execute.
private java.lang.String comment
User-specified information about the command, such as a brief description of what the command should do.
private java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters
The required and optional parameters specified in the SSM document being executed.
private java.lang.String outputS3BucketName
The name of the S3 bucket where command execution responses should be stored.
private java.lang.String outputS3KeyPrefix
The directory structure within the S3 bucket where the responses should be stored.
public java.util.List<java.lang.String> getInstanceIds()
Required. The instance IDs where the command should execute.
public void setInstanceIds(java.util.Collection<java.lang.String> instanceIds)
Required. The instance IDs where the command should execute.
instanceIds
- Required. The instance IDs where the command should execute.public SendCommandRequest withInstanceIds(java.lang.String... instanceIds)
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)
or
withInstanceIds(java.util.Collection)
if you want to override
the existing values.
instanceIds
- Required. The instance IDs where the command should execute.public SendCommandRequest withInstanceIds(java.util.Collection<java.lang.String> instanceIds)
Required. The instance IDs where the command should execute.
instanceIds
- Required. The instance IDs where the command should execute.public void setDocumentName(java.lang.String documentName)
Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.
documentName
- Required. The name of the SSM document to execute. This can be an
SSM public document or a custom document.public java.lang.String getDocumentName()
Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.
public SendCommandRequest withDocumentName(java.lang.String documentName)
Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.
documentName
- Required. The name of the SSM document to execute. This can be an
SSM public document or a custom document.public void setDocumentHash(java.lang.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 java.lang.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(java.lang.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(java.lang.String documentHashType)
Sha256 or Sha1.
Sha1 hashes have been deprecated.
documentHashType
- Sha256 or Sha1. Sha1 hashes have been deprecated.
DocumentHashType
public java.lang.String getDocumentHashType()
Sha256 or Sha1.
Sha1 hashes have been deprecated.
Sha1 hashes have been deprecated.
DocumentHashType
public SendCommandRequest withDocumentHashType(java.lang.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(java.lang.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 java.lang.Integer getTimeoutSeconds()
If this time is reached and the command has not already started executing, it will not execute.
public SendCommandRequest withTimeoutSeconds(java.lang.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(java.lang.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 java.lang.String getComment()
User-specified information about the command, such as a brief description of what the command should do.
public SendCommandRequest withComment(java.lang.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 java.util.Map<java.lang.String,java.util.List<java.lang.String>> getParameters()
The required and optional parameters specified in the SSM document being executed.
public void setParameters(java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)
The required and optional parameters specified in the SSM document being executed.
parameters
- The required and optional parameters specified in the SSM document
being executed.public SendCommandRequest withParameters(java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)
The required and optional parameters specified in the SSM document being executed.
parameters
- The required and optional parameters specified in the SSM document
being executed.public SendCommandRequest addParametersEntry(java.lang.String key, java.util.List<java.lang.String> value)
public SendCommandRequest clearParametersEntries()
public void setOutputS3BucketName(java.lang.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 java.lang.String getOutputS3BucketName()
The name of the S3 bucket where command execution responses should be stored.
public SendCommandRequest withOutputS3BucketName(java.lang.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(java.lang.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 java.lang.String getOutputS3KeyPrefix()
The directory structure within the S3 bucket where the responses should be stored.
public SendCommandRequest withOutputS3KeyPrefix(java.lang.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 java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public SendCommandRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()