ConfigurationOptionDescription

import type { ConfigurationOptionDescription } from "https://aws-api.deno.dev/v0.4/services/elasticbeanstalk.ts?docs=full";

Describes the possible values for a configuration option.

interface ConfigurationOptionDescription {

ChangeSeverity?: string | null;

DefaultValue?: string | null;

MaxLength?: number | null;

MaxValue?: number | null;

MinValue?: number | null;

Name?: string | null;

Namespace?: string | null;

Regex?: OptionRestrictionRegex | null;

UserDefined?: boolean | null;

ValueOptions: string[];

ValueType?: ConfigurationOptionValueType | null;

}

§Properties

ChangeSeverity?: string | null

[src]

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.

DefaultValue?: string | null

[src]

The default value for this configuration option.

MaxLength?: number | null

[src]

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

MaxValue?: number | null

[src]

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

MinValue?: number | null

[src]

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

Name?: string | null

[src]

The name of the configuration option.

Namespace?: string | null

[src]

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

Regex?: OptionRestrictionRegex | null

[src]

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

UserDefined?: boolean | null

[src]

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

ValueOptions: string[]

[src]

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

ValueType?: ConfigurationOptionValueType | null

[src]

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.