Class Command

java.lang.Object
com.amazonaws.services.simplesystemsmanagement.model.Command
All Implemented Interfaces:
Serializable, Cloneable
public class Command extends Object implements Serializable, Cloneable

Describes a command request.

See Also:

  • Constructor Details

    • Command

      public Command()

  • Method Details

    • setCommandId

      public void setCommandId(String commandId)

      A unique identifier for this command.

      Parameters:
      commandId - A unique identifier for this command.

    • getCommandId

      public String getCommandId()

      A unique identifier for this command.

      Returns:
      A unique identifier for this command.

    • withCommandId

      public Command withCommandId(String commandId)

      A unique identifier for this command.

      Parameters:
      commandId - A unique identifier for this command.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setDocumentName

      public void setDocumentName(String documentName)

      The name of the SSM document requested for execution.

      Parameters:
      documentName - The name of the SSM document requested for execution.

    • getDocumentName

      public String getDocumentName()

      The name of the SSM document requested for execution.

      Returns:
      The name of the SSM document requested for execution.

    • withDocumentName

      public Command withDocumentName(String documentName)

      The name of the SSM document requested for execution.

      Parameters:
      documentName - The name of the SSM document requested for execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setComment

      public void setComment(String comment)

      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

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

      public Command withComment(String comment)

      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.

    • setExpiresAfter

      public void setExpiresAfter(Date expiresAfter)

      If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

      Parameters:
      expiresAfter - If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

    • getExpiresAfter

      public Date getExpiresAfter()

      If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

      Returns:
      If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

    • withExpiresAfter

      public Command withExpiresAfter(Date expiresAfter)

      If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

      Parameters:
      expiresAfter - If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • getParameters

      public Map<String, List<String>> getParameters()

      The parameter values to be inserted in the SSM document when executing the command.

      Returns:
      The parameter values to be inserted in the SSM document when executing the command.

    • setParameters

      public void setParameters(Map<String, List<String>> parameters)

      The parameter values to be inserted in the SSM document when executing the command.

      Parameters:
      parameters - The parameter values to be inserted in the SSM document when executing the command.

    • withParameters

      public Command withParameters(Map<String, List<String>> parameters)

      The parameter values to be inserted in the SSM document when executing the command.

      Parameters:
      parameters - The parameter values to be inserted in the SSM document when executing the command.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addParametersEntry

      public Command addParametersEntry(String key, List<String> value)

    • clearParametersEntries

      public Command clearParametersEntries()
      Removes all the entries added into Parameters. <p> Returns a reference to this object so that method calls can be chained together.

    • getInstanceIds

      public List<String> getInstanceIds()

      The instance IDs against which this command was requested.

      Returns:
      The instance IDs against which this command was requested.

    • setInstanceIds

      public void setInstanceIds(Collection<String> instanceIds)

      The instance IDs against which this command was requested.

      Parameters:
      instanceIds - The instance IDs against which this command was requested.

    • withInstanceIds

      public Command withInstanceIds(String... instanceIds)

      The instance IDs against which this command was requested.

      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.

      Parameters:
      instanceIds - The instance IDs against which this command was requested.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • withInstanceIds

      public Command withInstanceIds(Collection<String> instanceIds)

      The instance IDs against which this command was requested.

      Parameters:
      instanceIds - The instance IDs against which this command was requested.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setRequestedDateTime

      public void setRequestedDateTime(Date requestedDateTime)

      The date and time the command was requested.

      Parameters:
      requestedDateTime - The date and time the command was requested.

    • getRequestedDateTime

      public Date getRequestedDateTime()

      The date and time the command was requested.

      Returns:
      The date and time the command was requested.

    • withRequestedDateTime

      public Command withRequestedDateTime(Date requestedDateTime)

      The date and time the command was requested.

      Parameters:
      requestedDateTime - The date and time the command was requested.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setStatus

      public void setStatus(String status)

      The status of the command.

      Parameters:
      status - The status of the command.
      See Also:

    • getStatus

      public String getStatus()

      The status of the command.

      Returns:
      The status of the command.
      See Also:

    • withStatus

      public Command withStatus(String status)

      The status of the command.

      Parameters:
      status - The status of the command.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • setStatus

      public void setStatus(CommandStatus status)

      The status of the command.

      Parameters:
      status - The status of the command.
      See Also:

    • withStatus

      public Command withStatus(CommandStatus status)

      The status of the command.

      Parameters:
      status - The status of the command.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 Command 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 Command 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 Command clone()
      Overrides:
      clone in class Object