Class ConfigurationOptionDescription
- All Implemented Interfaces:
Serializable
,Cloneable
Describes the possible values for a configuration option.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
An indication of which action is required if the value for this configuration option changes:The default value for this configuration option.If specified, the configuration option must be a string value no longer than this value.If specified, the configuration option must be a numeric value less than this value.If specified, the configuration option must be a numeric value greater than this value.getName()
The name of the configuration option.A unique namespace identifying the option's associated AWS resource.getRegex()
If specified, the configuration option must be a string value that satisfies this regular expression.An indication of whether the user defined this configuration option:If specified, values for the configuration option are selected from this list.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()
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
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:toString()
Returns a string representation of this object; useful for testing and debugging.withChangeSeverity
(String changeSeverity) An indication of which action is required if the value for this configuration option changes:withDefaultValue
(String defaultValue) The default value for this configuration option.withMaxLength
(Integer maxLength) If specified, the configuration option must be a string value no longer than this value.withMaxValue
(Integer maxValue) If specified, the configuration option must be a numeric value less than this value.withMinValue
(Integer minValue) If specified, the configuration option must be a numeric value greater than this value.The name of the configuration option.withNamespace
(String namespace) A unique namespace identifying the option's associated AWS resource.withRegex
(OptionRestrictionRegex regex) If specified, the configuration option must be a string value that satisfies this regular expression.withUserDefined
(Boolean userDefined) An indication of whether the user defined this configuration option:withValueOptions
(String... valueOptions) If specified, values for the configuration option are selected from this list.withValueOptions
(Collection<String> valueOptions) If specified, values for the configuration option are selected from this list.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: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:
-
Constructor Details
-
ConfigurationOptionDescription
public ConfigurationOptionDescription()
-
-
Method Details
-
setNamespace
A unique namespace identifying the option's associated AWS resource.
- Parameters:
namespace
- A unique namespace identifying the option's associated AWS resource.
-
getNamespace
A unique namespace identifying the option's associated AWS resource.
- Returns:
- A unique namespace identifying the option's associated AWS resource.
-
withNamespace
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
The name of the configuration option.
- Parameters:
name
- The name of the configuration option.
-
getName
The name of the configuration option.
- Returns:
- The name of the configuration option.
-
withName
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
The default value for this configuration option.
- Parameters:
defaultValue
- The default value for this configuration option.
-
getDefaultValue
The default value for this configuration option.
- Returns:
- The default value for this configuration option.
-
withDefaultValue
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
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
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
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
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 anOption 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 anOption 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
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 anOption 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 anOption 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
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 anOption 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 anOption 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
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 anOption 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 anOption 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
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 theMIN/MAX/Regex
constraints. -
List
: Values for this option are multiple selections from the possible values. -
Boolean
: Values for this option are eithertrue
orfalse
. -
Json
: Values for this option are a JSON representation of aConfigDocument
.
- 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 theMIN/MAX/Regex
constraints. -
List
: Values for this option are multiple selections from the possible values. -
Boolean
: Values for this option are eithertrue
orfalse
. -
Json
: Values for this option are a JSON representation of aConfigDocument
.
-
- See Also:
-
-
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 theMIN/MAX/Regex
constraints. -
List
: Values for this option are multiple selections from the possible values. -
Boolean
: Values for this option are eithertrue
orfalse
. -
Json
: Values for this option are a JSON representation of aConfigDocument
.
- 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 theMIN/MAX/Regex
constraints. -
List
: Values for this option are multiple selections from the possible values. -
Boolean
: Values for this option are eithertrue
orfalse
. -
Json
: Values for this option are a JSON representation of aConfigDocument
.
-
- 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 theMIN/MAX/Regex
constraints. -
List
: Values for this option are multiple selections from the possible values. -
Boolean
: Values for this option are eithertrue
orfalse
. -
Json
: Values for this option are a JSON representation of aConfigDocument
.
- 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 theMIN/MAX/Regex
constraints. -
List
: Values for this option are multiple selections from the possible values. -
Boolean
: Values for this option are eithertrue
orfalse
. -
Json
: Values for this option are a JSON representation of aConfigDocument
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
setValueType
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 theMIN/MAX/Regex
constraints. -
List
: Values for this option are multiple selections from the possible values. -
Boolean
: Values for this option are eithertrue
orfalse
. -
Json
: Values for this option are a JSON representation of aConfigDocument
.
- 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 theMIN/MAX/Regex
constraints. -
List
: Values for this option are multiple selections from the possible values. -
Boolean
: Values for this option are eithertrue
orfalse
. -
Json
: Values for this option are a JSON representation of aConfigDocument
.
-
- 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 theMIN/MAX/Regex
constraints. -
List
: Values for this option are multiple selections from the possible values. -
Boolean
: Values for this option are eithertrue
orfalse
. -
Json
: Values for this option are a JSON representation of aConfigDocument
.
- 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 theMIN/MAX/Regex
constraints. -
List
: Values for this option are multiple selections from the possible values. -
Boolean
: Values for this option are eithertrue
orfalse
. -
Json
: Values for this option are a JSON representation of aConfigDocument
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
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
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)
orwithValueOptions(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
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
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
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
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
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
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-