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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#change_severity ⇒ String

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) 


737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 737

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

#default_value ⇒ String

The default value for this configuration option.

Returns:

  • (String) 


737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 737

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

#max_length ⇒ Integer

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

Returns:

  • (Integer) 


737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 737

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

#max_value ⇒ Integer

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

Returns:

  • (Integer) 


737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 737

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

#min_value ⇒ Integer

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

Returns:

  • (Integer) 


737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 737

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

#name ⇒ String

The name of the configuration option.

Returns:

  • (String) 


737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 737

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

#namespace ⇒ String

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

Returns:

  • (String) 


737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 737

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

#regex ⇒ Types::OptionRestrictionRegex

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

Returns:



737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 737

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

#user_defined ⇒ Boolean

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) 


737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 737

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

#value_options ⇒ Array<String>

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

Returns:

  • (Array<String>) 


737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 737

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

#value_type ⇒ 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:

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


737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
 
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 737

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