configuration_options

Creates, updates, deletes, gets or lists a configuration_options resource.

Overview

Name	configuration_options
Type	Resource
Id	aws.elasticbeanstalk.configuration_options

Fields

The following fields are returned by SELECT queries:

describe_configuration_options

Name	Datatype	Description
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.
default_value	string	The default value for this configuration option.
max_length	integer	If specified, the configuration option must be a string value no longer than this value.
max_value	integer	If specified, the configuration option must be a numeric value less than this value.
min_value	integer	If specified, the configuration option must be a numeric value greater than this value.
name	string	The name of the configuration option.
namespace	string	A unique namespace identifying the option's associated AWS resource.
regex	string	If specified, the configuration option must be a string value that satisfies this regular expression.
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
value_options	string	If specified, values for the configuration option are selected from this list.
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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_configuration_options	select	region	ApplicationName, TemplateName, EnvironmentName, SolutionStackName, PlatformArn, Options	Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
ApplicationName	string	The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.
EnvironmentName	string	The name of the environment whose configuration options you want to describe.
Options	array	If specified, restricts the descriptions to only the specified options.
PlatformArn	string	The ARN of the custom platform.
SolutionStackName	string	The name of the solution stack whose configuration options you want to describe.
TemplateName	string	The name of the configuration template whose configuration options you want to describe.

SELECT examples

describe_configuration_options

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

SELECT
change_severity,
default_value,
max_length,
max_value,
min_value,
name,
namespace,
regex,
user_defined,
value_options,
value_type
FROM aws.elasticbeanstalk.configuration_options
WHERE region = '{{ region }}' -- required
AND ApplicationName = '{{ ApplicationName }}'
AND TemplateName = '{{ TemplateName }}'
AND EnvironmentName = '{{ EnvironmentName }}'
AND SolutionStackName = '{{ SolutionStackName }}'
AND PlatformArn = '{{ PlatformArn }}'
AND Options = '{{ Options }}'
;