Class DocumentParameter

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

public class DocumentParameter extends Object implements Serializable, Cloneable

Parameters specified in the SSM document that execute on the server when the command is run.

See Also:
  • Constructor Details

    • DocumentParameter

      public DocumentParameter()
  • Method Details

    • setName

      public void setName(String name)

      The name of the parameter.

      Parameters:
      name - The name of the parameter.
    • getName

      public String getName()

      The name of the parameter.

      Returns:
      The name of the parameter.
    • withName

      public DocumentParameter withName(String name)

      The name of the parameter.

      Parameters:
      name - The name of the parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setType

      public void setType(String type)

      The type of parameter. The type can be either “String” or “StringList”.

      Parameters:
      type - The type of parameter. The type can be either “String” or “StringList”.
      See Also:
    • getType

      public String getType()

      The type of parameter. The type can be either “String” or “StringList”.

      Returns:
      The type of parameter. The type can be either “String” or “StringList”.
      See Also:
    • withType

      public DocumentParameter withType(String type)

      The type of parameter. The type can be either “String” or “StringList”.

      Parameters:
      type - The type of parameter. The type can be either “String” or “StringList”.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setType

      public void setType(DocumentParameterType type)

      The type of parameter. The type can be either “String” or “StringList”.

      Parameters:
      type - The type of parameter. The type can be either “String” or “StringList”.
      See Also:
    • withType

      public DocumentParameter withType(DocumentParameterType type)

      The type of parameter. The type can be either “String” or “StringList”.

      Parameters:
      type - The type of parameter. The type can be either “String” or “StringList”.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setDescription

      public void setDescription(String description)

      A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

      Parameters:
      description - A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
    • getDescription

      public String getDescription()

      A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

      Returns:
      A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
    • withDescription

      public DocumentParameter withDescription(String description)

      A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

      Parameters:
      description - A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDefaultValue

      public void setDefaultValue(String defaultValue)

      If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.

      Parameters:
      defaultValue - If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
    • getDefaultValue

      public String getDefaultValue()

      If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.

      Returns:
      If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
    • withDefaultValue

      public DocumentParameter withDefaultValue(String defaultValue)

      If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.

      Parameters:
      defaultValue - If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
      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 DocumentParameter clone()
      Overrides:
      clone in class Object