@Generated(value="software.amazon.awssdk:codegen") public final class ConfigurationOptionDescription extends Object implements ToCopyableBuilder<ConfigurationOptionDescription.Builder,ConfigurationOptionDescription>
Describes the possible values for a configuration option.
Modifier and Type | Class and Description |
---|---|
static interface |
ConfigurationOptionDescription.Builder |
Modifier and Type | Method and Description |
---|---|
static ConfigurationOptionDescription.Builder |
builder() |
String |
changeSeverity()
An indication of which action is required if the value for this configuration option changes:
|
String |
defaultValue()
The default value for this configuration option.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Integer |
maxLength()
If specified, the configuration option must be a string value no longer than this value.
|
Integer |
maxValue()
If specified, the configuration option must be a numeric value less than this value.
|
Integer |
minValue()
If specified, the configuration option must be a numeric value greater than this value.
|
String |
name()
The name of the configuration option.
|
String |
namespace()
A unique namespace identifying the option's associated AWS resource.
|
OptionRestrictionRegex |
regex()
If specified, the configuration option must be a string value that satisfies this regular expression.
|
static Class<? extends ConfigurationOptionDescription.Builder> |
serializableBuilderClass() |
ConfigurationOptionDescription.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Boolean |
userDefined()
An indication of whether the user defined this configuration option:
|
List<String> |
valueOptions()
If specified, values for the configuration option are selected from this list.
|
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:
|
String |
valueTypeAsString()
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:
|
copy
public String namespace()
A unique namespace identifying the option's associated AWS resource.
public String name()
The name of the configuration option.
public String defaultValue()
The default value for this configuration option.
public 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.
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 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
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 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
.
If the service returns an enum value that is not available in the current SDK version, valueType
will
return ConfigurationOptionValueType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from valueTypeAsString()
.
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 String valueTypeAsString()
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
.
If the service returns an enum value that is not available in the current SDK version, valueType
will
return ConfigurationOptionValueType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from valueTypeAsString()
.
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 List<String> valueOptions()
If specified, values for the configuration option are selected from this list.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Integer minValue()
If specified, the configuration option must be a numeric value greater than this value.
public Integer maxValue()
If specified, the configuration option must be a numeric value less than this value.
public Integer maxLength()
If specified, the configuration option must be a string value no longer than this value.
public OptionRestrictionRegex regex()
If specified, the configuration option must be a string value that satisfies this regular expression.
public ConfigurationOptionDescription.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ConfigurationOptionDescription.Builder,ConfigurationOptionDescription>
public static ConfigurationOptionDescription.Builder builder()
public static Class<? extends ConfigurationOptionDescription.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.