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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb

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)


709
710
711
712
713
714
715
716
717
718
719
720
721
722
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 709

class ConfigurationOptionDescription < Struct.new(
  :namespace,
  :name,
  :default_value,
  :change_severity,
  :user_defined,
  :value_type,
  :value_options,
  :min_value,
  :max_value,
  :max_length,
  :regex)
  include Aws::Structure
end

#default_valueString

The default value for this configuration option.

Returns:

  • (String)


709
710
711
712
713
714
715
716
717
718
719
720
721
722
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 709

class ConfigurationOptionDescription < Struct.new(
  :namespace,
  :name,
  :default_value,
  :change_severity,
  :user_defined,
  :value_type,
  :value_options,
  :min_value,
  :max_value,
  :max_length,
  :regex)
  include Aws::Structure
end

#max_lengthInteger

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

Returns:

  • (Integer)


709
710
711
712
713
714
715
716
717
718
719
720
721
722
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 709

class ConfigurationOptionDescription < Struct.new(
  :namespace,
  :name,
  :default_value,
  :change_severity,
  :user_defined,
  :value_type,
  :value_options,
  :min_value,
  :max_value,
  :max_length,
  :regex)
  include Aws::Structure
end

#max_valueInteger

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

Returns:

  • (Integer)


709
710
711
712
713
714
715
716
717
718
719
720
721
722
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 709

class ConfigurationOptionDescription < Struct.new(
  :namespace,
  :name,
  :default_value,
  :change_severity,
  :user_defined,
  :value_type,
  :value_options,
  :min_value,
  :max_value,
  :max_length,
  :regex)
  include Aws::Structure
end

#min_valueInteger

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

Returns:

  • (Integer)


709
710
711
712
713
714
715
716
717
718
719
720
721
722
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 709

class ConfigurationOptionDescription < Struct.new(
  :namespace,
  :name,
  :default_value,
  :change_severity,
  :user_defined,
  :value_type,
  :value_options,
  :min_value,
  :max_value,
  :max_length,
  :regex)
  include Aws::Structure
end

#nameString

The name of the configuration option.

Returns:

  • (String)


709
710
711
712
713
714
715
716
717
718
719
720
721
722
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 709

class ConfigurationOptionDescription < Struct.new(
  :namespace,
  :name,
  :default_value,
  :change_severity,
  :user_defined,
  :value_type,
  :value_options,
  :min_value,
  :max_value,
  :max_length,
  :regex)
  include Aws::Structure
end

#namespaceString

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

Returns:

  • (String)


709
710
711
712
713
714
715
716
717
718
719
720
721
722
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 709

class ConfigurationOptionDescription < Struct.new(
  :namespace,
  :name,
  :default_value,
  :change_severity,
  :user_defined,
  :value_type,
  :value_options,
  :min_value,
  :max_value,
  :max_length,
  :regex)
  include Aws::Structure
end

#regexTypes::OptionRestrictionRegex

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



709
710
711
712
713
714
715
716
717
718
719
720
721
722
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 709

class ConfigurationOptionDescription < Struct.new(
  :namespace,
  :name,
  :default_value,
  :change_severity,
  :user_defined,
  :value_type,
  :value_options,
  :min_value,
  :max_value,
  :max_length,
  :regex)
  include Aws::Structure
end

#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)


709
710
711
712
713
714
715
716
717
718
719
720
721
722
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 709

class ConfigurationOptionDescription < Struct.new(
  :namespace,
  :name,
  :default_value,
  :change_severity,
  :user_defined,
  :value_type,
  :value_options,
  :min_value,
  :max_value,
  :max_length,
  :regex)
  include Aws::Structure
end

#value_optionsArray<String>

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

Returns:

  • (Array<String>)


709
710
711
712
713
714
715
716
717
718
719
720
721
722
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 709

class ConfigurationOptionDescription < Struct.new(
  :namespace,
  :name,
  :default_value,
  :change_severity,
  :user_defined,
  :value_type,
  :value_options,
  :min_value,
  :max_value,
  :max_length,
  :regex)
  include Aws::Structure
end

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

Returns:

  • (String)


709
710
711
712
713
714
715
716
717
718
719
720
721
722
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 709

class ConfigurationOptionDescription < Struct.new(
  :namespace,
  :name,
  :default_value,
  :change_severity,
  :user_defined,
  :value_type,
  :value_options,
  :min_value,
  :max_value,
  :max_length,
  :regex)
  include Aws::Structure
end