Amazonka.ElasticBeanstalk.Types.ConfigurationOptionDescription

Documentation

data ConfigurationOptionDescription

Describes the possible values for a configuration option.

See: newConfigurationOptionDescription smart constructor.

Constructors

ConfigurationOptionDescription'

Fields

• changeSeverity :: Maybe Text

  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 :: Maybe Text

  The default value for this configuration option.

• maxLength :: Maybe Int

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

• maxValue :: Maybe Int

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

• minValue :: Maybe Int

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

• name :: Maybe Text

  The name of the configuration option.

• namespace :: Maybe Text

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

• regex :: Maybe OptionRestrictionRegex

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

• userDefined :: Maybe Bool

  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 :: Maybe [Text]

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

• valueType :: Maybe ConfigurationOptionValueType

  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.

Instances

FromXML ConfigurationOptionDescription

Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationOptionDescription

Methods

parseXML :: [Node] -> Either String ConfigurationOptionDescription

Generic ConfigurationOptionDescription

Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationOptionDescription

Associated Types

type Rep ConfigurationOptionDescription :: Type -> Type

Methods

from :: ConfigurationOptionDescription -> Rep ConfigurationOptionDescription x

to :: Rep ConfigurationOptionDescription x -> ConfigurationOptionDescription

Read ConfigurationOptionDescription

Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationOptionDescription

Methods

readsPrec :: Int -> ReadS ConfigurationOptionDescription

readList :: ReadS [ConfigurationOptionDescription]

readPrec :: ReadPrec ConfigurationOptionDescription

readListPrec :: ReadPrec [ConfigurationOptionDescription]

Show ConfigurationOptionDescription

Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationOptionDescription

Methods

showsPrec :: Int -> ConfigurationOptionDescription -> ShowS

show :: ConfigurationOptionDescription -> String

showList :: [ConfigurationOptionDescription] -> ShowS

NFData ConfigurationOptionDescription

Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationOptionDescription

Methods

rnf :: ConfigurationOptionDescription -> ()

Eq ConfigurationOptionDescription

Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationOptionDescription

Methods

(==) :: ConfigurationOptionDescription -> ConfigurationOptionDescription -> Bool

(/=) :: ConfigurationOptionDescription -> ConfigurationOptionDescription -> Bool

Hashable ConfigurationOptionDescription

Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationOptionDescription

Methods

hashWithSalt :: Int -> ConfigurationOptionDescription -> Int

hash :: ConfigurationOptionDescription -> Int

type Rep ConfigurationOptionDescription

Defined in Amazonka.ElasticBeanstalk.Types.ConfigurationOptionDescription

type Rep ConfigurationOptionDescription = D1 ('MetaData "ConfigurationOptionDescription" "Amazonka.ElasticBeanstalk.Types.ConfigurationOptionDescription" "amazonka-elasticbeanstalk-2.0-HLGGuY0kjXTIKSbM7JuMHy" 'False) (C1 ('MetaCons "ConfigurationOptionDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "changeSeverity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "defaultValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "maxValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "minValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "regex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OptionRestrictionRegex)))) :*: (S1 ('MetaSel ('Just "userDefined") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "valueOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "valueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfigurationOptionValueType)))))))

newConfigurationOptionDescription :: ConfigurationOptionDescription

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: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:maxLength:ConfigurationOptionDescription', configurationOptionDescription_maxLength - If specified, the configuration option must be a string value no longer than this value.

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

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

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

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

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

$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:valueOptions:ConfigurationOptionDescription', configurationOptionDescription_valueOptions - If specified, values for the configuration option are selected from this list.

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

configurationOptionDescription_changeSeverity :: Lens' ConfigurationOptionDescription (Maybe Text)

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.

configurationOptionDescription_defaultValue :: Lens' ConfigurationOptionDescription (Maybe Text)

The default value for this configuration option.

configurationOptionDescription_maxLength :: Lens' ConfigurationOptionDescription (Maybe Int)

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

configurationOptionDescription_maxValue :: Lens' ConfigurationOptionDescription (Maybe Int)

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

configurationOptionDescription_minValue :: Lens' ConfigurationOptionDescription (Maybe Int)

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

configurationOptionDescription_name :: Lens' ConfigurationOptionDescription (Maybe Text)

The name of the configuration option.

configurationOptionDescription_namespace :: Lens' ConfigurationOptionDescription (Maybe Text)

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

configurationOptionDescription_regex :: Lens' ConfigurationOptionDescription (Maybe OptionRestrictionRegex)

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

configurationOptionDescription_userDefined :: Lens' ConfigurationOptionDescription (Maybe Bool)

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

configurationOptionDescription_valueOptions :: Lens' ConfigurationOptionDescription (Maybe [Text])

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

configurationOptionDescription_valueType :: Lens' ConfigurationOptionDescription (Maybe ConfigurationOptionValueType)

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.