com.amazonaws.services.elasticbeanstalk.model
Class ConfigurationOptionDescription

java.lang.Object
  com.amazonaws.services.elasticbeanstalk.model.ConfigurationOptionDescription

public class ConfigurationOptionDescription
extends Object

Describes the possible values for a configuration option.

Constructor Summary

ConfigurationOptionDescription()
Default constructor for a new ConfigurationOptionDescription object.

Method Summary

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:
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(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(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:

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigurationOptionDescription

public ConfigurationOptionDescription()

Default constructor for a new ConfigurationOptionDescription object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

Method Detail

getNamespace

public String getNamespace()

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

Constraints:
Length: 1 - 255

Returns:

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

setNamespace

public void setNamespace(String namespace)

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

Constraints:
Length: 1 - 255

Parameters:

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

withNamespace

public ConfigurationOptionDescription withNamespace(String namespace)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getName

public String getName()

The name of the configuration option.

Constraints:
Length: 1 - 100

Returns:

The name of the configuration option.

setName

public void setName(String name)

The name of the configuration option.

Constraints:
Length: 1 - 100

Parameters:

name - The name of the configuration option.

withName

public ConfigurationOptionDescription withName(String name)

The name of the configuration option.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

name - The name of the configuration option.

Returns:

A reference to this updated object so that method calls can be chained together.

getDefaultValue

public String getDefaultValue()

The default value for this configuration option.

Returns:

The default value for this configuration option.

setDefaultValue

public void setDefaultValue(String defaultValue)

The default value for this configuration option.

Parameters:

defaultValue - The default value for this configuration option.

withDefaultValue

public ConfigurationOptionDescription withDefaultValue(String defaultValue)

The default value for this configuration option.

Returns a reference to this object so that method calls can be chained together.

Parameters:

defaultValue - The default value for this configuration option.

Returns:

A reference to this updated object so that method calls can be chained together.

getChangeSeverity

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

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.

setChangeSeverity

public void setChangeSeverity(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 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.

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

withChangeSeverity

public ConfigurationOptionDescription withChangeSeverity(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 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.

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 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 updated object so that method calls can be chained together.

isUserDefined

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

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

setUserDefined

public void setUserDefined(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 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

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

withUserDefined

public ConfigurationOptionDescription withUserDefined(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 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.

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 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 updated object so that method calls can be chained together.

getUserDefined

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

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

getValueType

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

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

See Also:

ConfigurationOptionValueType

setValueType

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

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

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

See Also:

ConfigurationOptionValueType

withValueType

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

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

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 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 updated object so that method calls can be chained together.

See Also:

ConfigurationOptionValueType

getValueOptions

public List<String> 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

public void setValueOptions(Collection<String> valueOptions)

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

public ConfigurationOptionDescription withValueOptions(String... valueOptions)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

withValueOptions

public ConfigurationOptionDescription withValueOptions(Collection<String> valueOptions)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getMinValue

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

setMinValue

public void setMinValue(Integer minValue)

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.

withMinValue

public ConfigurationOptionDescription withMinValue(Integer minValue)

If specified, the configuration option must be a numeric value greater than this value.

Returns a reference to this object so that method calls can be chained together.

Parameters:

minValue - If specified, the configuration option must be a numeric value greater than this value.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxValue

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

setMaxValue

public void setMaxValue(Integer maxValue)

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.

withMaxValue

public ConfigurationOptionDescription withMaxValue(Integer maxValue)

If specified, the configuration option must be a numeric value less than this value.

Returns a reference to this object so that method calls can be chained together.

Parameters:

maxValue - If specified, the configuration option must be a numeric value less than this value.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxLength

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

setMaxLength

public void setMaxLength(Integer maxLength)

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.

withMaxLength

public ConfigurationOptionDescription withMaxLength(Integer maxLength)

If specified, the configuration option must be a string value no longer than this value.

Returns a reference to this object so that method calls can be chained together.

Parameters:

maxLength - If specified, the configuration option must be a string value no longer than this value.

Returns:

A reference to this updated object so that method calls can be chained together.

getRegex

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

setRegex

public void setRegex(OptionRestrictionRegex regex)

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.

withRegex

public ConfigurationOptionDescription withRegex(OptionRestrictionRegex regex)

If specified, the configuration option must be a string value that satisfies this regular expression.

Returns a reference to this object so that method calls can be chained together.

Parameters:

regex - If specified, the configuration option must be a string value that satisfies this regular expression.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()