AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElasticBeanstalk::Types::ConfigurationOptionDescription

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes the possible values for a configuration option.

Instance Attribute Summary collapse

Instance Attribute Details

#change_severityString

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.

Returns:

  • (String)

    An indication of which action is required if the value for this configuration option changes:.

#default_valueString

The default value for this configuration option.

Returns:

  • (String)

    The default value for this configuration option.

#max_lengthInteger

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

Returns:

  • (Integer)

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

#max_valueInteger

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

Returns:

  • (Integer)

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

#min_valueInteger

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

Returns:

  • (Integer)

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

#nameString

The name of the configuration option.

Returns:

  • (String)

    The name of the configuration option.

#namespaceString

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

Returns:

  • (String)

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

#regexTypes::OptionRestrictionRegex

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

Returns:

#user_definedBoolean

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

Returns:

  • (Boolean)

    An indication of whether the user defined this configuration option:.

#value_optionsArray<String>

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

Returns:

  • (Array<String>)

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

#value_typeString

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.

    Possible values:

    • Scalar
    • List

Returns:

  • (String)

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