#[non_exhaustive]pub struct ConfigurationOptionDescription {
pub namespace: Option<String>,
pub name: Option<String>,
pub default_value: Option<String>,
pub change_severity: Option<String>,
pub user_defined: Option<bool>,
pub value_type: Option<ConfigurationOptionValueType>,
pub value_options: Option<Vec<String>>,
pub min_value: Option<i32>,
pub max_value: Option<i32>,
pub max_length: Option<i32>,
pub regex: Option<OptionRestrictionRegex>,
}
Expand description
Describes the possible values for a configuration option.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.namespace: Option<String>
A unique namespace identifying the option's associated AWS resource.
name: Option<String>
The name of the configuration option.
default_value: Option<String>
The default value for this configuration option.
change_severity: Option<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.
user_defined: Option<bool>
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 anOption 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_type: Option<ConfigurationOptionValueType>
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 theMIN/MAX/Regex
constraints. -
List
: Values for this option are multiple selections from the possible values. -
Boolean
: Values for this option are eithertrue
orfalse
. -
Json
: Values for this option are a JSON representation of aConfigDocument
.
value_options: Option<Vec<String>>
If specified, values for the configuration option are selected from this list.
min_value: Option<i32>
If specified, the configuration option must be a numeric value greater than this value.
max_value: Option<i32>
If specified, the configuration option must be a numeric value less than this value.
max_length: Option<i32>
If specified, the configuration option must be a string value no longer than this value.
regex: Option<OptionRestrictionRegex>
If specified, the configuration option must be a string value that satisfies this regular expression.
Implementations§
source§impl ConfigurationOptionDescription
impl ConfigurationOptionDescription
sourcepub fn namespace(&self) -> Option<&str>
pub fn namespace(&self) -> Option<&str>
A unique namespace identifying the option's associated AWS resource.
sourcepub fn default_value(&self) -> Option<&str>
pub fn default_value(&self) -> Option<&str>
The default value for this configuration option.
sourcepub fn change_severity(&self) -> Option<&str>
pub fn change_severity(&self) -> Option<&str>
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.
sourcepub fn user_defined(&self) -> Option<bool>
pub fn user_defined(&self) -> Option<bool>
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 anOption 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
sourcepub fn value_type(&self) -> Option<&ConfigurationOptionValueType>
pub fn value_type(&self) -> Option<&ConfigurationOptionValueType>
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 theMIN/MAX/Regex
constraints. -
List
: Values for this option are multiple selections from the possible values. -
Boolean
: Values for this option are eithertrue
orfalse
. -
Json
: Values for this option are a JSON representation of aConfigDocument
.
sourcepub fn value_options(&self) -> &[String]
pub fn value_options(&self) -> &[String]
If specified, values for the configuration option are selected from this list.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .value_options.is_none()
.
sourcepub fn min_value(&self) -> Option<i32>
pub fn min_value(&self) -> Option<i32>
If specified, the configuration option must be a numeric value greater than this value.
sourcepub fn max_value(&self) -> Option<i32>
pub fn max_value(&self) -> Option<i32>
If specified, the configuration option must be a numeric value less than this value.
sourcepub fn max_length(&self) -> Option<i32>
pub fn max_length(&self) -> Option<i32>
If specified, the configuration option must be a string value no longer than this value.
sourcepub fn regex(&self) -> Option<&OptionRestrictionRegex>
pub fn regex(&self) -> Option<&OptionRestrictionRegex>
If specified, the configuration option must be a string value that satisfies this regular expression.
source§impl ConfigurationOptionDescription
impl ConfigurationOptionDescription
sourcepub fn builder() -> ConfigurationOptionDescriptionBuilder
pub fn builder() -> ConfigurationOptionDescriptionBuilder
Creates a new builder-style object to manufacture ConfigurationOptionDescription
.
Trait Implementations§
source§impl Clone for ConfigurationOptionDescription
impl Clone for ConfigurationOptionDescription
source§fn clone(&self) -> ConfigurationOptionDescription
fn clone(&self) -> ConfigurationOptionDescription
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl PartialEq for ConfigurationOptionDescription
impl PartialEq for ConfigurationOptionDescription
source§fn eq(&self, other: &ConfigurationOptionDescription) -> bool
fn eq(&self, other: &ConfigurationOptionDescription) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for ConfigurationOptionDescription
Auto Trait Implementations§
impl Freeze for ConfigurationOptionDescription
impl RefUnwindSafe for ConfigurationOptionDescription
impl Send for ConfigurationOptionDescription
impl Sync for ConfigurationOptionDescription
impl Unpin for ConfigurationOptionDescription
impl UnwindSafe for ConfigurationOptionDescription
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more