java.lang.Object
com.amazonaws.services.simplesystemsmanagement.model.CommandPlugin
All Implemented Interfaces:
Serializable, Cloneable

public class CommandPlugin extends Object implements Serializable, Cloneable

Describes plugin details.

See Also:
  • Constructor Details

    • CommandPlugin

      public CommandPlugin()
  • Method Details

    • setName

      public void setName(String 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.

      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

      public String 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

      public CommandPlugin withName(String 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.

      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

      public void setStatus(String status)

      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

      public String 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

      public CommandPlugin withStatus(String status)

      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

      public void setStatus(CommandPluginStatus status)

      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

      public CommandPlugin withStatus(CommandPluginStatus status)

      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

      public void setResponseCode(Integer responseCode)

      A numeric response code generated after executing the plugin.

      Parameters:
      responseCode - A numeric response code generated after executing the plugin.
    • getResponseCode

      public Integer getResponseCode()

      A numeric response code generated after executing the plugin.

      Returns:
      A numeric response code generated after executing the plugin.
    • withResponseCode

      public CommandPlugin withResponseCode(Integer responseCode)

      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

      public void setResponseStartDateTime(Date responseStartDateTime)

      The time the plugin started executing.

      Parameters:
      responseStartDateTime - The time the plugin started executing.
    • getResponseStartDateTime

      public Date getResponseStartDateTime()

      The time the plugin started executing.

      Returns:
      The time the plugin started executing.
    • withResponseStartDateTime

      public CommandPlugin withResponseStartDateTime(Date responseStartDateTime)

      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

      public void setResponseFinishDateTime(Date responseFinishDateTime)

      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

      public Date 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

      public CommandPlugin withResponseFinishDateTime(Date responseFinishDateTime)

      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

      public void setOutput(String output)

      Output of the plugin execution.

      Parameters:
      output - Output of the plugin execution.
    • getOutput

      public String getOutput()

      Output of the plugin execution.

      Returns:
      Output of the plugin execution.
    • withOutput

      public CommandPlugin withOutput(String output)

      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

      public void setOutputS3BucketName(String outputS3BucketName)

      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

      public String 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

      public CommandPlugin withOutputS3BucketName(String outputS3BucketName)

      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

      public void setOutputS3KeyPrefix(String 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.

      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

      public String 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

      public CommandPlugin withOutputS3KeyPrefix(String 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.

      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

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public CommandPlugin clone()
      Overrides:
      clone in class Object