public class ConfigurationOptionDescription extends Object implements Serializable
Describes the possible values for a configuration option.
| Constructor and Description |
|---|
ConfigurationOptionDescription()
Default constructor for a new ConfigurationOptionDescription object.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
String |
getChangeSeverity()
An indication of which action is required if the value for this
configuration option changes:
|
String |
getDefaultValue()
The default value for this configuration option.
|
Integer |
getMaxLength()
If specified, the configuration option must be a string value no
longer than this value.
|
Integer |
getMaxValue()
If specified, the configuration option must be a numeric value less
than this value.
|
Integer |
getMinValue()
If specified, the configuration option must be a numeric value greater
than this value.
|
String |
getName()
The name of the configuration option.
|
String |
getNamespace()
A unique namespace identifying the option's associated AWS resource.
|
OptionRestrictionRegex |
getRegex()
If specified, the configuration option must be a string value that
satisfies this regular expression.
|
Boolean |
getUserDefined()
An indication of whether the user defined this configuration option:
|
List<String> |
getValueOptions()
If specified, values for the configuration option are selected from
this list.
|
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:
|
int |
hashCode() |
Boolean |
isUserDefined()
An indication of whether the user defined this configuration option:
|
void |
setChangeSeverity(String changeSeverity)
An indication of which action is required if the value for this
configuration option changes:
|
void |
setDefaultValue(String defaultValue)
The default value for this configuration option.
|
void |
setMaxLength(Integer maxLength)
If specified, the configuration option must be a string value no
longer than this value.
|
void |
setMaxValue(Integer maxValue)
If specified, the configuration option must be a numeric value less
than this value.
|
void |
setMinValue(Integer minValue)
If specified, the configuration option must be a numeric value greater
than this value.
|
void |
setName(String name)
The name of the configuration option.
|
void |
setNamespace(String namespace)
A unique namespace identifying the option's associated AWS resource.
|
void |
setRegex(OptionRestrictionRegex regex)
If specified, the configuration option must be a string value that
satisfies this regular expression.
|
void |
setUserDefined(Boolean userDefined)
An indication of whether the user defined this configuration option:
|
void |
setValueOptions(Collection<String> valueOptions)
If specified, values for the configuration option are selected from
this list.
|
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:
|
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:
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ConfigurationOptionDescription |
withChangeSeverity(String changeSeverity)
An indication of which action is required if the value for this
configuration option changes:
|
ConfigurationOptionDescription |
withDefaultValue(String defaultValue)
The default value for this configuration option.
|
ConfigurationOptionDescription |
withMaxLength(Integer maxLength)
If specified, the configuration option must be a string value no
longer than this value.
|
ConfigurationOptionDescription |
withMaxValue(Integer maxValue)
If specified, the configuration option must be a numeric value less
than this value.
|
ConfigurationOptionDescription |
withMinValue(Integer minValue)
If specified, the configuration option must be a numeric value greater
than this value.
|
ConfigurationOptionDescription |
withName(String name)
The name of the configuration option.
|
ConfigurationOptionDescription |
withNamespace(String namespace)
A unique namespace identifying the option's associated AWS resource.
|
ConfigurationOptionDescription |
withRegex(OptionRestrictionRegex regex)
If specified, the configuration option must be a string value that
satisfies this regular expression.
|
ConfigurationOptionDescription |
withUserDefined(Boolean userDefined)
An indication of whether the user defined this configuration option:
|
ConfigurationOptionDescription |
withValueOptions(Collection<String> valueOptions)
If specified, values for the configuration option are selected from
this list.
|
ConfigurationOptionDescription |
withValueOptions(String... valueOptions)
If specified, values for the configuration option are selected from
this list.
|
ConfigurationOptionDescription |
withValueType(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:
|
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:
|
public ConfigurationOptionDescription()
public String getNamespace()
public void setNamespace(String namespace)
namespace - A unique namespace identifying the option's associated AWS resource.public ConfigurationOptionDescription withNamespace(String namespace)
Returns a reference to this object so that method calls can be chained together.
namespace - A unique namespace identifying the option's associated AWS resource.public String getName()
public void setName(String name)
name - The name of the configuration option.public ConfigurationOptionDescription withName(String name)
Returns a reference to this object so that method calls can be chained together.
name - The name of the configuration option.public String getDefaultValue()
public void setDefaultValue(String defaultValue)
defaultValue - The default value for this configuration option.public ConfigurationOptionDescription withDefaultValue(String defaultValue)
Returns a reference to this object so that method calls can be chained together.
defaultValue - The default value for this configuration option.public String getChangeSeverity()
NoInterruption - There is no interruption to the environment or application availability.
RestartEnvironment - The environment is 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.
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.
NoInterruption - There is no interruption to the environment or application availability.
RestartEnvironment - The environment is 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.
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.
public void setChangeSeverity(String changeSeverity)
NoInterruption - There is no interruption to the environment or application availability.
RestartEnvironment - The environment is 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.
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.
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 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.
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.
public ConfigurationOptionDescription withChangeSeverity(String changeSeverity)
NoInterruption - There is no interruption to the environment or application availability.
RestartEnvironment - The environment is 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.
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 a reference to this object so that method calls can be chained together.
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 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.
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.
public Boolean isUserDefined()
true : This
configuration option was defined by the user. It is a valid choice for
specifying this as an Option to Remove when updating configuration
settings.
false : This
configuration was not defined by the user.
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
true : This
configuration option was defined by the user. It is a valid choice for
specifying this as an Option to Remove when updating configuration
settings.
false : This
configuration was not defined by the user.
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
public void setUserDefined(Boolean userDefined)
true : This
configuration option was defined by the user. It is a valid choice for
specifying this as an Option to Remove when updating configuration
settings.
false : This
configuration was not defined by the user.
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
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 this as an Option to Remove when updating configuration
settings.
false : This
configuration was not defined by the user.
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
public ConfigurationOptionDescription withUserDefined(Boolean userDefined)
true : This
configuration option was defined by the user. It is a valid choice for
specifying this as an Option to Remove when updating configuration
settings.
false : This
configuration was not defined by the user.
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 a reference to this object so that method calls can be chained together.
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 this as an Option to Remove when updating configuration
settings.
false : This
configuration was not defined by the user.
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
public Boolean getUserDefined()
true : This
configuration option was defined by the user. It is a valid choice for
specifying this as an Option to Remove when updating configuration
settings.
false : This
configuration was not defined by the user.
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
true : This
configuration option was defined by the user. It is a valid choice for
specifying this as an Option to Remove when updating configuration
settings.
false : This
configuration was not defined by the user.
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
public String getValueType()
Scalar : Values
for this option are a single selection from the possible values, or a
unformatted string or numeric value governed by the MIN/MAX/Regex
constraints:
List :
Values for this option are multiple selections of the possible values.
Boolean : Values for
this option are either true or false .
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 .
Constraints:
Allowed Values: Scalar, List
Scalar : Values
for this option are a single selection from the possible values, or a
unformatted string or numeric value governed by the MIN/MAX/Regex
constraints:
List :
Values for this option are multiple selections of the possible values.
Boolean : Values for
this option are either true or false .
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 . ConfigurationOptionValueTypepublic void setValueType(String valueType)
Scalar : Values
for this option are a single selection from the possible values, or a
unformatted string or numeric value governed by the MIN/MAX/Regex
constraints:
List :
Values for this option are multiple selections of the possible values.
Boolean : Values for
this option are either true or false .
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 .
Constraints:
Allowed Values: Scalar, List
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 a
unformatted string or numeric value governed by the MIN/MAX/Regex
constraints:
List :
Values for this option are multiple selections of the possible values.
Boolean : Values for
this option are either true or false .
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 . ConfigurationOptionValueTypepublic ConfigurationOptionDescription withValueType(String valueType)
Scalar : Values
for this option are a single selection from the possible values, or a
unformatted string or numeric value governed by the MIN/MAX/Regex
constraints:
List :
Values for this option are multiple selections of the possible values.
Boolean : Values for
this option are either true or false .
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 . Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Scalar, List
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 a
unformatted string or numeric value governed by the MIN/MAX/Regex
constraints:
List :
Values for this option are multiple selections of the possible values.
Boolean : Values for
this option are either true or false .
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 . ConfigurationOptionValueTypepublic void setValueType(ConfigurationOptionValueType valueType)
Scalar : Values
for this option are a single selection from the possible values, or a
unformatted string or numeric value governed by the MIN/MAX/Regex
constraints:
List :
Values for this option are multiple selections of the possible values.
Boolean : Values for
this option are either true or false .
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 .
Constraints:
Allowed Values: Scalar, List
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 a
unformatted string or numeric value governed by the MIN/MAX/Regex
constraints:
List :
Values for this option are multiple selections of the possible values.
Boolean : Values for
this option are either true or false .
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 . ConfigurationOptionValueTypepublic ConfigurationOptionDescription withValueType(ConfigurationOptionValueType valueType)
Scalar : Values
for this option are a single selection from the possible values, or a
unformatted string or numeric value governed by the MIN/MAX/Regex
constraints:
List :
Values for this option are multiple selections of the possible values.
Boolean : Values for
this option are either true or false .
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 . Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Scalar, List
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 a
unformatted string or numeric value governed by the MIN/MAX/Regex
constraints:
List :
Values for this option are multiple selections of the possible values.
Boolean : Values for
this option are either true or false .
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 . ConfigurationOptionValueTypepublic List<String> getValueOptions()
public void setValueOptions(Collection<String> valueOptions)
valueOptions - If specified, values for the configuration option are selected from
this list.public ConfigurationOptionDescription withValueOptions(String... valueOptions)
Returns a reference to this object so that method calls can be chained together.
valueOptions - If specified, values for the configuration option are selected from
this list.public ConfigurationOptionDescription withValueOptions(Collection<String> valueOptions)
Returns a reference to this object so that method calls can be chained together.
valueOptions - If specified, values for the configuration option are selected from
this list.public Integer getMinValue()
public void setMinValue(Integer minValue)
minValue - If specified, the configuration option must be a numeric value greater
than this value.public ConfigurationOptionDescription withMinValue(Integer minValue)
Returns a reference to this object so that method calls can be chained together.
minValue - If specified, the configuration option must be a numeric value greater
than this value.public Integer getMaxValue()
public void setMaxValue(Integer maxValue)
maxValue - If specified, the configuration option must be a numeric value less
than this value.public ConfigurationOptionDescription withMaxValue(Integer maxValue)
Returns a reference to this object so that method calls can be chained together.
maxValue - If specified, the configuration option must be a numeric value less
than this value.public Integer getMaxLength()
public void setMaxLength(Integer maxLength)
maxLength - If specified, the configuration option must be a string value no
longer than this value.public ConfigurationOptionDescription withMaxLength(Integer maxLength)
Returns a reference to this object so that method calls can be chained together.
maxLength - If specified, the configuration option must be a string value no
longer than this value.public OptionRestrictionRegex getRegex()
public void setRegex(OptionRestrictionRegex regex)
regex - If specified, the configuration option must be a string value that
satisfies this regular expression.public ConfigurationOptionDescription withRegex(OptionRestrictionRegex regex)
Returns a reference to this object so that method calls can be chained together.
regex - If specified, the configuration option must be a string value that
satisfies this regular expression.public String toString()
toString in class ObjectObject.toString()Copyright © 2014. All rights reserved.