class Aws::ElasticBeanstalk::Types::ConfigurationOptionDescription

Describes the possible values for a configuration option.

@!attribute [rw] namespace

A unique namespace identifying the option's associated AWS
resource.
@return [String]

@!attribute [rw] name

The name of the configuration option.
@return [String]

@!attribute [rw] default_value

The default value for this configuration option.
@return [String]

@!attribute [rw] change_severity

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.
@return [String]

@!attribute [rw] user_defined

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`
@return [Boolean]

@!attribute [rw] value_type

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`.
@return [String]

@!attribute [rw] value_options

If specified, values for the configuration option are selected from
this list.
@return [Array<String>]

@!attribute [rw] min_value

If specified, the configuration option must be a numeric value
greater than this value.
@return [Integer]

@!attribute [rw] max_value

If specified, the configuration option must be a numeric value less
than this value.
@return [Integer]

@!attribute [rw] max_length

If specified, the configuration option must be a string value no
longer than this value.
@return [Integer]

@!attribute [rw] regex

If specified, the configuration option must be a string value that
satisfies this regular expression.
@return [Types::OptionRestrictionRegex]

@see docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ConfigurationOptionDescription AWS API Documentation

Constants

SENSITIVE