Class ConfigurationOptionDescription

java.lang.Object
com.amazonaws.services.elasticbeanstalk.model.ConfigurationOptionDescription
All Implemented Interfaces:
Serializable, Cloneable

public class ConfigurationOptionDescription extends Object implements Serializable, Cloneable

Describes the possible values for a configuration option.

See Also:
  • Constructor Details

    • ConfigurationOptionDescription

      public ConfigurationOptionDescription()
  • Method Details

    • setNamespace

      public void setNamespace(String namespace)

      A unique namespace identifying the option's associated AWS resource.

      Parameters:
      namespace - A unique namespace identifying the option's associated AWS resource.
    • getNamespace

      public String getNamespace()

      A unique namespace identifying the option's associated AWS resource.

      Returns:
      A unique namespace identifying the option's associated AWS resource.
    • withNamespace

      public ConfigurationOptionDescription withNamespace(String namespace)

      A unique namespace identifying the option's associated AWS resource.

      Parameters:
      namespace - A unique namespace identifying the option's associated AWS resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setName

      public void setName(String name)

      The name of the configuration option.

      Parameters:
      name - The name of the configuration option.
    • getName

      public String getName()

      The name of the configuration option.

      Returns:
      The name of the configuration option.
    • withName

      public ConfigurationOptionDescription withName(String name)

      The name of the configuration option.

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

      public void setDefaultValue(String defaultValue)

      The default value for this configuration option.

      Parameters:
      defaultValue - The default value for this configuration option.
    • getDefaultValue

      public String getDefaultValue()

      The default value for this configuration option.

      Returns:
      The default value for this configuration option.
    • withDefaultValue

      public ConfigurationOptionDescription withDefaultValue(String defaultValue)

      The default value for this configuration option.

      Parameters:
      defaultValue - The default value for this configuration option.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setChangeSeverity

      public void setChangeSeverity(String changeSeverity)

      An indication of which action is required if the value for this configuration option changes:

      • NoInterruption : There is no interruption to the environment or application availability.
      • RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.
      • RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
      Parameters:
      changeSeverity - An indication of which action is required if the value for this configuration option changes:

      • NoInterruption : There is no interruption to the environment or application availability.
      • RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.
      • RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
    • getChangeSeverity

      public String getChangeSeverity()

      An indication of which action is required if the value for this configuration option changes:

      • NoInterruption : There is no interruption to the environment or application availability.
      • RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.
      • RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
      Returns:
      An indication of which action is required if the value for this configuration option changes:

      • NoInterruption : There is no interruption to the environment or application availability.
      • RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.
      • RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
    • withChangeSeverity

      public ConfigurationOptionDescription withChangeSeverity(String changeSeverity)

      An indication of which action is required if the value for this configuration option changes:

      • NoInterruption : There is no interruption to the environment or application availability.
      • RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.
      • RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
      Parameters:
      changeSeverity - An indication of which action is required if the value for this configuration option changes:

      • NoInterruption : There is no interruption to the environment or application availability.
      • RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.
      • RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setUserDefined

      public void setUserDefined(Boolean userDefined)

      An indication of whether the user defined this configuration option:

      • true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.

      • false : This configuration was not defined by the user.

      Constraint: You can remove only UserDefined options from a configuration.

      Valid Values: true | false

      Parameters:
      userDefined - An indication of whether the user defined this configuration option:

      • true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.

      • false : This configuration was not defined by the user.

      Constraint: You can remove only UserDefined options from a configuration.

      Valid Values: true | false

    • getUserDefined

      public Boolean getUserDefined()

      An indication of whether the user defined this configuration option:

      • true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.

      • false : This configuration was not defined by the user.

      Constraint: You can remove only UserDefined options from a configuration.

      Valid Values: true | false

      Returns:
      An indication of whether the user defined this configuration option:

      • true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.

      • false : This configuration was not defined by the user.

      Constraint: You can remove only UserDefined options from a configuration.

      Valid Values: true | false

    • withUserDefined

      public ConfigurationOptionDescription withUserDefined(Boolean userDefined)

      An indication of whether the user defined this configuration option:

      • true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.

      • false : This configuration was not defined by the user.

      Constraint: You can remove only UserDefined options from a configuration.

      Valid Values: true | false

      Parameters:
      userDefined - An indication of whether the user defined this configuration option:

      • true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.

      • false : This configuration was not defined by the user.

      Constraint: You can remove only UserDefined options from a configuration.

      Valid Values: true | false

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isUserDefined

      public Boolean isUserDefined()

      An indication of whether the user defined this configuration option:

      • true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.

      • false : This configuration was not defined by the user.

      Constraint: You can remove only UserDefined options from a configuration.

      Valid Values: true | false

      Returns:
      An indication of whether the user defined this configuration option:

      • true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.

      • false : This configuration was not defined by the user.

      Constraint: You can remove only UserDefined options from a configuration.

      Valid Values: true | false

    • setValueType

      public void setValueType(String valueType)

      An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

      • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.
      • List : Values for this option are multiple selections from the possible values.
      • Boolean : Values for this option are either true or false .
      • Json : Values for this option are a JSON representation of a ConfigDocument.
      Parameters:
      valueType - An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

      • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.
      • List : Values for this option are multiple selections from the possible values.
      • Boolean : Values for this option are either true or false .
      • Json : Values for this option are a JSON representation of a ConfigDocument.
      See Also:
    • getValueType

      public String getValueType()

      An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

      • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.
      • List : Values for this option are multiple selections from the possible values.
      • Boolean : Values for this option are either true or false .
      • Json : Values for this option are a JSON representation of a ConfigDocument.
      Returns:
      An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

      • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.
      • List : Values for this option are multiple selections from the possible values.
      • Boolean : Values for this option are either true or false .
      • Json : Values for this option are a JSON representation of a ConfigDocument.
      See Also:
    • withValueType

      public ConfigurationOptionDescription withValueType(String valueType)

      An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

      • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.
      • List : Values for this option are multiple selections from the possible values.
      • Boolean : Values for this option are either true or false .
      • Json : Values for this option are a JSON representation of a ConfigDocument.
      Parameters:
      valueType - An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

      • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.
      • List : Values for this option are multiple selections from the possible values.
      • Boolean : Values for this option are either true or false .
      • Json : Values for this option are a JSON representation of a ConfigDocument.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setValueType

      public void setValueType(ConfigurationOptionValueType valueType)

      An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

      • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.
      • List : Values for this option are multiple selections from the possible values.
      • Boolean : Values for this option are either true or false .
      • Json : Values for this option are a JSON representation of a ConfigDocument.
      Parameters:
      valueType - An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

      • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.
      • List : Values for this option are multiple selections from the possible values.
      • Boolean : Values for this option are either true or false .
      • Json : Values for this option are a JSON representation of a ConfigDocument.
      See Also:
    • withValueType

      An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

      • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.
      • List : Values for this option are multiple selections from the possible values.
      • Boolean : Values for this option are either true or false .
      • Json : Values for this option are a JSON representation of a ConfigDocument.
      Parameters:
      valueType - An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

      • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.
      • List : Values for this option are multiple selections from the possible values.
      • Boolean : Values for this option are either true or false .
      • Json : Values for this option are a JSON representation of a ConfigDocument.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • getValueOptions

      public List<String> getValueOptions()

      If specified, values for the configuration option are selected from this list.

      Returns:
      If specified, values for the configuration option are selected from this list.
    • setValueOptions

      public void setValueOptions(Collection<String> valueOptions)

      If specified, values for the configuration option are selected from this list.

      Parameters:
      valueOptions - If specified, values for the configuration option are selected from this list.
    • withValueOptions

      public ConfigurationOptionDescription withValueOptions(String... valueOptions)

      If specified, values for the configuration option are selected from this list.

      NOTE: This method appends the values to the existing list (if any). Use setValueOptions(java.util.Collection) or withValueOptions(java.util.Collection) if you want to override the existing values.

      Parameters:
      valueOptions - If specified, values for the configuration option are selected from this list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withValueOptions

      public ConfigurationOptionDescription withValueOptions(Collection<String> valueOptions)

      If specified, values for the configuration option are selected from this list.

      Parameters:
      valueOptions - If specified, values for the configuration option are selected from this list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setMinValue

      public void setMinValue(Integer minValue)

      If specified, the configuration option must be a numeric value greater than this value.

      Parameters:
      minValue - If specified, the configuration option must be a numeric value greater than this value.
    • getMinValue

      public Integer getMinValue()

      If specified, the configuration option must be a numeric value greater than this value.

      Returns:
      If specified, the configuration option must be a numeric value greater than this value.
    • withMinValue

      public ConfigurationOptionDescription withMinValue(Integer minValue)

      If specified, the configuration option must be a numeric value greater than this value.

      Parameters:
      minValue - If specified, the configuration option must be a numeric value greater than this value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setMaxValue

      public void setMaxValue(Integer maxValue)

      If specified, the configuration option must be a numeric value less than this value.

      Parameters:
      maxValue - If specified, the configuration option must be a numeric value less than this value.
    • getMaxValue

      public Integer getMaxValue()

      If specified, the configuration option must be a numeric value less than this value.

      Returns:
      If specified, the configuration option must be a numeric value less than this value.
    • withMaxValue

      public ConfigurationOptionDescription withMaxValue(Integer maxValue)

      If specified, the configuration option must be a numeric value less than this value.

      Parameters:
      maxValue - If specified, the configuration option must be a numeric value less than this value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setMaxLength

      public void setMaxLength(Integer maxLength)

      If specified, the configuration option must be a string value no longer than this value.

      Parameters:
      maxLength - If specified, the configuration option must be a string value no longer than this value.
    • getMaxLength

      public Integer getMaxLength()

      If specified, the configuration option must be a string value no longer than this value.

      Returns:
      If specified, the configuration option must be a string value no longer than this value.
    • withMaxLength

      public ConfigurationOptionDescription withMaxLength(Integer maxLength)

      If specified, the configuration option must be a string value no longer than this value.

      Parameters:
      maxLength - If specified, the configuration option must be a string value no longer than this value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setRegex

      public void setRegex(OptionRestrictionRegex regex)

      If specified, the configuration option must be a string value that satisfies this regular expression.

      Parameters:
      regex - If specified, the configuration option must be a string value that satisfies this regular expression.
    • getRegex

      public OptionRestrictionRegex getRegex()

      If specified, the configuration option must be a string value that satisfies this regular expression.

      Returns:
      If specified, the configuration option must be a string value that satisfies this regular expression.
    • withRegex

      If specified, the configuration option must be a string value that satisfies this regular expression.

      Parameters:
      regex - If specified, the configuration option must be a string value that satisfies this regular expression.
      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

      Overrides:
      clone in class Object