Class CommandPlugin
- All Implemented Interfaces:
Serializable
,Cloneable
Describes plugin details.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
getName()
The name of the plugin.Output of the plugin execution.The S3 bucket where the responses to the command executions should be stored.The S3 directory path inside the bucket where the responses to the command executions should be stored.A numeric response code generated after executing the plugin.The time the plugin stopped executing.The time the plugin started executing.The status of this plugin.int
hashCode()
void
The name of the plugin.void
Output of the plugin execution.void
setOutputS3BucketName
(String outputS3BucketName) The S3 bucket where the responses to the command executions should be stored.void
setOutputS3KeyPrefix
(String outputS3KeyPrefix) The S3 directory path inside the bucket where the responses to the command executions should be stored.void
setResponseCode
(Integer responseCode) A numeric response code generated after executing the plugin.void
setResponseFinishDateTime
(Date responseFinishDateTime) The time the plugin stopped executing.void
setResponseStartDateTime
(Date responseStartDateTime) The time the plugin started executing.void
setStatus
(CommandPluginStatus status) The status of this plugin.void
The status of this plugin.toString()
Returns a string representation of this object; useful for testing and debugging.The name of the plugin.withOutput
(String output) Output of the plugin execution.withOutputS3BucketName
(String outputS3BucketName) The S3 bucket where the responses to the command executions should be stored.withOutputS3KeyPrefix
(String outputS3KeyPrefix) The S3 directory path inside the bucket where the responses to the command executions should be stored.withResponseCode
(Integer responseCode) A numeric response code generated after executing the plugin.withResponseFinishDateTime
(Date responseFinishDateTime) The time the plugin stopped executing.withResponseStartDateTime
(Date responseStartDateTime) The time the plugin started executing.withStatus
(CommandPluginStatus status) The status of this plugin.withStatus
(String status) The status of this plugin.
-
Constructor Details
-
CommandPlugin
public CommandPlugin()
-
-
Method Details
-
setName
The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.
- Parameters:
name
- The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.
-
getName
The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.
- Returns:
- The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.
-
withName
The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.
- Parameters:
name
- The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStatus
The status of this plugin. You can execute a document with multiple plugins.
- Parameters:
status
- The status of this plugin. You can execute a document with multiple plugins.- See Also:
-
getStatus
The status of this plugin. You can execute a document with multiple plugins.
- Returns:
- The status of this plugin. You can execute a document with multiple plugins.
- See Also:
-
withStatus
The status of this plugin. You can execute a document with multiple plugins.
- Parameters:
status
- The status of this plugin. You can execute a document with multiple plugins.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setStatus
The status of this plugin. You can execute a document with multiple plugins.
- Parameters:
status
- The status of this plugin. You can execute a document with multiple plugins.- See Also:
-
withStatus
The status of this plugin. You can execute a document with multiple plugins.
- Parameters:
status
- The status of this plugin. You can execute a document with multiple plugins.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setResponseCode
A numeric response code generated after executing the plugin.
- Parameters:
responseCode
- A numeric response code generated after executing the plugin.
-
getResponseCode
A numeric response code generated after executing the plugin.
- Returns:
- A numeric response code generated after executing the plugin.
-
withResponseCode
A numeric response code generated after executing the plugin.
- Parameters:
responseCode
- A numeric response code generated after executing the plugin.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setResponseStartDateTime
The time the plugin started executing.
- Parameters:
responseStartDateTime
- The time the plugin started executing.
-
getResponseStartDateTime
The time the plugin started executing.
- Returns:
- The time the plugin started executing.
-
withResponseStartDateTime
The time the plugin started executing.
- Parameters:
responseStartDateTime
- The time the plugin started executing.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setResponseFinishDateTime
The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.
- Parameters:
responseFinishDateTime
- The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.
-
getResponseFinishDateTime
The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.
- Returns:
- The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.
-
withResponseFinishDateTime
The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.
- Parameters:
responseFinishDateTime
- The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOutput
Output of the plugin execution.
- Parameters:
output
- Output of the plugin execution.
-
getOutput
Output of the plugin execution.
- Returns:
- Output of the plugin execution.
-
withOutput
Output of the plugin execution.
- Parameters:
output
- Output of the plugin execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOutputS3BucketName
The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
- Parameters:
outputS3BucketName
- The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
-
getOutputS3BucketName
The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
- Returns:
- The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
-
withOutputS3BucketName
The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
- Parameters:
outputS3BucketName
- The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOutputS3KeyPrefix
The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
- Parameters:
outputS3KeyPrefix
- The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
-
getOutputS3KeyPrefix
The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
- Returns:
- The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
-
withOutputS3KeyPrefix
The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
- Parameters:
outputS3KeyPrefix
- The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.- 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
-