Class SendCommandRequest

    • Constructor Detail

      • SendCommandRequest

        public SendCommandRequest()
    • Method Detail

      • getInstanceIds

        public List<String> getInstanceIds()

        Required. The instance IDs where the command should execute.

        Returns:
        Required. The instance IDs where the command should execute.
      • setInstanceIds

        public void setInstanceIds​(Collection<String> instanceIds)

        Required. The instance IDs where the command should execute.

        Parameters:
        instanceIds - Required. The instance IDs where the command should execute.
      • withInstanceIds

        public SendCommandRequest withInstanceIds​(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.

        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

        public SendCommandRequest withInstanceIds​(Collection<String> instanceIds)

        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

        public void setDocumentName​(String documentName)

        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

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

        public SendCommandRequest withDocumentName​(String documentName)

        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

        public void setDocumentHash​(String documentHash)

        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

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

        public SendCommandRequest withDocumentHash​(String documentHash)

        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

        public void setDocumentHashType​(String documentHashType)

        Sha256 or Sha1.

        Sha1 hashes have been deprecated.

        Parameters:
        documentHashType - Sha256 or Sha1.

        Sha1 hashes have been deprecated.

        See Also:
        DocumentHashType
      • getDocumentHashType

        public String getDocumentHashType()

        Sha256 or Sha1.

        Sha1 hashes have been deprecated.

        Returns:
        Sha256 or Sha1.

        Sha1 hashes have been deprecated.

        See Also:
        DocumentHashType
      • withDocumentHashType

        public SendCommandRequest withDocumentHashType​(String documentHashType)

        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:
        DocumentHashType
      • setDocumentHashType

        public void setDocumentHashType​(DocumentHashType documentHashType)

        Sha256 or Sha1.

        Sha1 hashes have been deprecated.

        Parameters:
        documentHashType - Sha256 or Sha1.

        Sha1 hashes have been deprecated.

        See Also:
        DocumentHashType
      • withDocumentHashType

        public SendCommandRequest withDocumentHashType​(DocumentHashType documentHashType)

        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:
        DocumentHashType
      • setTimeoutSeconds

        public void setTimeoutSeconds​(Integer timeoutSeconds)

        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

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

        public SendCommandRequest withTimeoutSeconds​(Integer timeoutSeconds)

        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

        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 SendCommandRequest 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.
      • getParameters

        public Map<String,​List<String>> 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

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

        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

        public SendCommandRequest withParameters​(Map<String,​List<String>> parameters)

        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.
      • clearParametersEntries

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

        public void setOutputS3BucketName​(String outputS3BucketName)

        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

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

        public SendCommandRequest withOutputS3BucketName​(String outputS3BucketName)

        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

        public void setOutputS3KeyPrefix​(String outputS3KeyPrefix)

        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

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

        public SendCommandRequest withOutputS3KeyPrefix​(String outputS3KeyPrefix)

        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

        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:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object