Describe the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines.
Inputs
Expand All
フィールド
種類
説明
region [required]
enum
default: us-east-1
configurationIdentification [required]
<oneOf>
Select your configuration either through the environment name, the solution stack name or the template stack name.
Option 1
object
option [required]
string
Environment name option for configuration identification.
environmentName [required]
string
The name of the environment whose configuration options you want to describe.
applicationName
string
The name of the application associated with the configuration template or environment.
Option 2
object
option [required]
string
Solution stack name option for configuration identification.
solutionStackName [required]
string
The name of the solution stack whose configuration options you want to describe.
applicationName
string
The name of the application associated with the configuration template or environment.
Option 3
object
option [required]
string
Template name option for configuration identification.
templateName [required]
string
The name of the configuration template whose configuration options you want to describe.
applicationName [required]
string
The name of the application associated with the configuration template or environment.
Outputs
Expand All
フィールド
種類
説明
options [required]
[object]
Namespace
string
A unique namespace identifying the option's associated AWS resource.
Name
string
The name of the configuration option.
DefaultValue
string
The default value for this configuration option.
ChangeSeverity
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.
UserDefined
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
ValueType
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.
ValueOptions
[string]
If specified, values for the configuration option are selected from this list.
MinValue
number
If specified, the configuration option must be a numeric value greater than this value.
MaxValue
number
If specified, the configuration option must be a numeric value less than this value.
MaxLength
number
If specified, the configuration option must be a string value no longer than this value.
Regex
object
If specified, the configuration option must be a string value that satisfies this regular expression.
Pattern
string
The regular expression pattern that a string configuration option value with this restriction must match.
Label
string
A unique name representing this regular expression.
