public class ConfigurationOptionDescription
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Describes the possible values for a configuration option.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
changeSeverity
An indication of which action is required if the value for this
configuration option changes:
|
private java.lang.String |
defaultValue
The default value for this configuration option.
|
private java.lang.Integer |
maxLength
If specified, the configuration option must be a string value no longer
than this value.
|
private java.lang.Integer |
maxValue
If specified, the configuration option must be a numeric value less than
this value.
|
private java.lang.Integer |
minValue
If specified, the configuration option must be a numeric value greater
than this value.
|
private java.lang.String |
name
The name of the configuration option.
|
private java.lang.String |
namespace
A unique namespace identifying the option's associated AWS resource.
|
private OptionRestrictionRegex |
regex
If specified, the configuration option must be a string value that
satisfies this regular expression.
|
private java.lang.Boolean |
userDefined
An indication of whether the user defined this configuration option:
|
private SdkInternalList<java.lang.String> |
valueOptions
If specified, values for the configuration option are selected from this
list.
|
private java.lang.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 and Description |
---|
ConfigurationOptionDescription() |
Modifier and Type | Method and Description |
---|---|
ConfigurationOptionDescription |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getChangeSeverity()
An indication of which action is required if the value for this
configuration option changes:
|
java.lang.String |
getDefaultValue()
The default value for this configuration option.
|
java.lang.Integer |
getMaxLength()
If specified, the configuration option must be a string value no longer
than this value.
|
java.lang.Integer |
getMaxValue()
If specified, the configuration option must be a numeric value less than
this value.
|
java.lang.Integer |
getMinValue()
If specified, the configuration option must be a numeric value greater
than this value.
|
java.lang.String |
getName()
The name of the configuration option.
|
java.lang.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.
|
java.lang.Boolean |
getUserDefined()
An indication of whether the user defined this configuration option:
|
java.util.List<java.lang.String> |
getValueOptions()
If specified, values for the configuration option are selected from this
list.
|
java.lang.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() |
java.lang.Boolean |
isUserDefined()
An indication of whether the user defined this configuration option:
|
void |
setChangeSeverity(java.lang.String changeSeverity)
An indication of which action is required if the value for this
configuration option changes:
|
void |
setDefaultValue(java.lang.String defaultValue)
The default value for this configuration option.
|
void |
setMaxLength(java.lang.Integer maxLength)
If specified, the configuration option must be a string value no longer
than this value.
|
void |
setMaxValue(java.lang.Integer maxValue)
If specified, the configuration option must be a numeric value less than
this value.
|
void |
setMinValue(java.lang.Integer minValue)
If specified, the configuration option must be a numeric value greater
than this value.
|
void |
setName(java.lang.String name)
The name of the configuration option.
|
void |
setNamespace(java.lang.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(java.lang.Boolean userDefined)
An indication of whether the user defined this configuration option:
|
void |
setValueOptions(java.util.Collection<java.lang.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(java.lang.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:
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ConfigurationOptionDescription |
withChangeSeverity(java.lang.String changeSeverity)
An indication of which action is required if the value for this
configuration option changes:
|
ConfigurationOptionDescription |
withDefaultValue(java.lang.String defaultValue)
The default value for this configuration option.
|
ConfigurationOptionDescription |
withMaxLength(java.lang.Integer maxLength)
If specified, the configuration option must be a string value no longer
than this value.
|
ConfigurationOptionDescription |
withMaxValue(java.lang.Integer maxValue)
If specified, the configuration option must be a numeric value less than
this value.
|
ConfigurationOptionDescription |
withMinValue(java.lang.Integer minValue)
If specified, the configuration option must be a numeric value greater
than this value.
|
ConfigurationOptionDescription |
withName(java.lang.String name)
The name of the configuration option.
|
ConfigurationOptionDescription |
withNamespace(java.lang.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(java.lang.Boolean userDefined)
An indication of whether the user defined this configuration option:
|
ConfigurationOptionDescription |
withValueOptions(java.util.Collection<java.lang.String> valueOptions)
If specified, values for the configuration option are selected from this
list.
|
ConfigurationOptionDescription |
withValueOptions(java.lang.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(java.lang.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:
|
private java.lang.String namespace
A unique namespace identifying the option's associated AWS resource.
private java.lang.String name
The name of the configuration option.
private java.lang.String defaultValue
The default value for this configuration option.
private java.lang.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.private java.lang.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
private java.lang.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
.private SdkInternalList<java.lang.String> valueOptions
If specified, values for the configuration option are selected from this list.
private java.lang.Integer minValue
If specified, the configuration option must be a numeric value greater than this value.
private java.lang.Integer maxValue
If specified, the configuration option must be a numeric value less than this value.
private java.lang.Integer maxLength
If specified, the configuration option must be a string value no longer than this value.
private OptionRestrictionRegex regex
If specified, the configuration option must be a string value that satisfies this regular expression.
public void setNamespace(java.lang.String namespace)
A unique namespace identifying the option's associated AWS resource.
namespace
- A unique namespace identifying the option's associated AWS
resource.public java.lang.String getNamespace()
A unique namespace identifying the option's associated AWS resource.
public ConfigurationOptionDescription withNamespace(java.lang.String namespace)
A unique namespace identifying the option's associated AWS resource.
namespace
- A unique namespace identifying the option's associated AWS
resource.public void setName(java.lang.String name)
The name of the configuration option.
name
- The name of the configuration option.public java.lang.String getName()
The name of the configuration option.
public ConfigurationOptionDescription withName(java.lang.String name)
The name of the configuration option.
name
- The name of the configuration option.public void setDefaultValue(java.lang.String defaultValue)
The default value for this configuration option.
defaultValue
- The default value for this configuration option.public java.lang.String getDefaultValue()
The default value for this configuration option.
public ConfigurationOptionDescription withDefaultValue(java.lang.String defaultValue)
The default value for this configuration option.
defaultValue
- The default value for this configuration option.public void setChangeSeverity(java.lang.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.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.public java.lang.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.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(java.lang.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.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.public void setUserDefined(java.lang.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
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
public java.lang.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
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(java.lang.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
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
public java.lang.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
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 setValueType(java.lang.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
.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
.ConfigurationOptionValueType
public java.lang.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
.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
.ConfigurationOptionValueType
public ConfigurationOptionDescription withValueType(java.lang.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
.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
.ConfigurationOptionValueType
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
.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
.ConfigurationOptionValueType
public 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:
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
.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
.ConfigurationOptionValueType
public java.util.List<java.lang.String> getValueOptions()
If specified, values for the configuration option are selected from this list.
public void setValueOptions(java.util.Collection<java.lang.String> valueOptions)
If specified, values for the configuration option are selected from this list.
valueOptions
- If specified, values for the configuration option are selected
from this list.public ConfigurationOptionDescription withValueOptions(java.lang.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.
valueOptions
- If specified, values for the configuration option are selected
from this list.public ConfigurationOptionDescription withValueOptions(java.util.Collection<java.lang.String> valueOptions)
If specified, values for the configuration option are selected from this list.
valueOptions
- If specified, values for the configuration option are selected
from this list.public void setMinValue(java.lang.Integer minValue)
If specified, the configuration option must be a numeric value greater than this value.
minValue
- If specified, the configuration option must be a numeric value
greater than this value.public java.lang.Integer getMinValue()
If specified, the configuration option must be a numeric value greater than this value.
public ConfigurationOptionDescription withMinValue(java.lang.Integer minValue)
If specified, the configuration option must be a numeric value greater than this value.
minValue
- If specified, the configuration option must be a numeric value
greater than this value.public void setMaxValue(java.lang.Integer maxValue)
If specified, the configuration option must be a numeric value less than this value.
maxValue
- If specified, the configuration option must be a numeric value
less than this value.public java.lang.Integer getMaxValue()
If specified, the configuration option must be a numeric value less than this value.
public ConfigurationOptionDescription withMaxValue(java.lang.Integer maxValue)
If specified, the configuration option must be a numeric value less than this value.
maxValue
- If specified, the configuration option must be a numeric value
less than this value.public void setMaxLength(java.lang.Integer maxLength)
If specified, the configuration option must be a string value no longer than this value.
maxLength
- If specified, the configuration option must be a string value no
longer than this value.public java.lang.Integer getMaxLength()
If specified, the configuration option must be a string value no longer than this value.
public ConfigurationOptionDescription withMaxLength(java.lang.Integer maxLength)
If specified, the configuration option must be a string value no longer than this value.
maxLength
- If specified, the configuration option must be a string value no
longer than this value.public void setRegex(OptionRestrictionRegex regex)
If specified, the configuration option must be a string value that satisfies this regular expression.
regex
- If specified, the configuration option must be a string value that
satisfies this regular expression.public OptionRestrictionRegex getRegex()
If specified, the configuration option must be a string value that satisfies this regular expression.
public ConfigurationOptionDescription withRegex(OptionRestrictionRegex regex)
If specified, the configuration option must be a string value that satisfies this regular expression.
regex
- If specified, the configuration option must be a string value that
satisfies this regular expression.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public ConfigurationOptionDescription clone()
clone
in class java.lang.Object