Package software.amazon.awssdk.services.elasticbeanstalk.model

Class ConfigurationOptionDescription

java.lang.Object

software.amazon.awssdk.services.elasticbeanstalk.model.ConfigurationOptionDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ConfigurationOptionDescription.Builder,ConfigurationOptionDescription>

@Generated("software.amazon.awssdk:codegen")
public final class ConfigurationOptionDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ConfigurationOptionDescription.Builder,ConfigurationOptionDescription>

Describes the possible values for a configuration option.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConfigurationOptionDescription.Builder

Method Summary

Modifier and Type	Method	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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValueOptions()	For responses, this returns true if the service returned a value for the ValueOptions property.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends ConfigurationOptionDescription.Builder>	serializableBuilderClass()
ConfigurationOptionDescription.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
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:

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

namespace

public final String namespace()

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

Returns:

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

name

public final String name()

The name of the configuration option.

Returns:

The name of the configuration option.

defaultValue

public final String defaultValue()

The default value for this configuration option.

Returns:

The default value for this configuration option.

changeSeverity

public final 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.

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.

userDefined

public final 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

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

valueType

public final 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().

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:

ConfigurationOptionValueType

valueTypeAsString

public final 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().

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:

ConfigurationOptionValueType

hasValueOptions

public final boolean hasValueOptions()

For responses, this returns true if the service returned a value for the ValueOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

valueOptions

public final 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValueOptions() method.

Returns:

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

minValue

public final Integer minValue()

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.

maxValue

public final Integer maxValue()

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.

maxLength

public final Integer maxLength()

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.

regex

public final OptionRestrictionRegex regex()

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.

toBuilder

public ConfigurationOptionDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConfigurationOptionDescription.Builder,ConfigurationOptionDescription>

builder

public static ConfigurationOptionDescription.Builder builder()

serializableBuilderClass

public static Class<? extends ConfigurationOptionDescription.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo