Documentation

Describes the possible values for a configuration option.

See: newConfigurationOptionDescription smart constructor.

Create a value of ConfigurationOptionDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxValue:ConfigurationOptionDescription', configurationOptionDescription_maxValue - If specified, the configuration option must be a numeric value less than this value.

$sel:regex:ConfigurationOptionDescription', configurationOptionDescription_regex - If specified, the configuration option must be a string value that satisfies this regular expression.

$sel:maxLength:ConfigurationOptionDescription', configurationOptionDescription_maxLength - If specified, the configuration option must be a string value no longer than this value.

$sel:userDefined:ConfigurationOptionDescription', configurationOptionDescription_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

$sel:namespace:ConfigurationOptionDescription', configurationOptionDescription_namespace - A unique namespace identifying the option's associated AWS resource.

$sel:valueOptions:ConfigurationOptionDescription', configurationOptionDescription_valueOptions - If specified, values for the configuration option are selected from this list.

$sel:name:ConfigurationOptionDescription', configurationOptionDescription_name - The name of the configuration option.

$sel:changeSeverity:ConfigurationOptionDescription', configurationOptionDescription_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.

$sel:defaultValue:ConfigurationOptionDescription', configurationOptionDescription_defaultValue - The default value for this configuration option.

$sel:valueType:ConfigurationOptionDescription', configurationOptionDescription_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.

$sel:minValue:ConfigurationOptionDescription', configurationOptionDescription_minValue - If specified, the configuration option must be a numeric value greater than this value.

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

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

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

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

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

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

The name of the configuration option.

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.

The default value for this configuration option.

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 specified, the configuration option must be a numeric value greater than this value.