Describes the possible values for a configuration option.

Namespace: Amazon.ElasticBeanstalk.Model
Assembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)

Syntax

         
 C#  Visual Basic  Visual C++ 
public class ConfigurationOptionDescription
Public Class ConfigurationOptionDescription
public ref class ConfigurationOptionDescription

Members

            
 All Members  Constructors   Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
ConfigurationOptionDescription()()()()
Initializes a new instance of the ConfigurationOptionDescription class
ChangeSeverity
An indication of which action is required if the value for this configuration option changes:

Field Value

NoInterruption - There is no interruption to the environment or application availability.

Field Value

RestartEnvironment - The environment is restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.

Field Value

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.
DefaultValue
The default value for this configuration option.
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
MaxLength
If specified, the configuration option must be a string value no longer than this value.
MaxValue
If specified, the configuration option must be a numeric value less than this value.
MinValue
If specified, the configuration option must be a numeric value greater than this value.
Name
The name of the configuration option.
Namespace
A unique namespace identifying the option's associated AWS resource.
Regex
If specified, the configuration option must be a string value that satisfies this regular expression.
ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
UserDefined
An indication of whether the user defined this configuration option:

Field Value

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.

Field Value

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
ValueOptions
If specified, values for the configuration option are selected from this list.
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:

Field Value

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:

Field Value

List : Values for this option are multiple selections of the possible values.

Field Value

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

WithChangeSeverity(String)
Sets the ChangeSeverity property
WithDefaultValue(String)
Sets the DefaultValue property
WithMaxLength(Int32)
Sets the MaxLength property
WithMaxValue(Int32)
Sets the MaxValue property
WithMinValue(Int32)
Sets the MinValue property
WithName(String)
Sets the Name property
WithNamespace(String)
Sets the Namespace property
WithRegex(OptionRestrictionRegex)
Sets the Regex property
WithUserDefined(Boolean)
Sets the UserDefined property
WithValueOptions(IEnumerable<(Of <<'(String>)>>))
Adds elements to the ValueOptions collection
WithValueOptions(array<String>[]()[][])
Adds elements to the ValueOptions collection
WithValueType(String)
Sets the ValueType property

Inheritance Hierarchy

System..::..Object
  Amazon.ElasticBeanstalk.Model..::..ConfigurationOptionDescription

See Also