Struct ConfigurationOptionDescription

#[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>,
}

Describes the possible values for a configuration option.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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 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_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 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.

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

impl ConfigurationOptionDescription

pub fn namespace(&self) -> Option<&str>

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

pub fn name(&self) -> Option<&str>

The name of the configuration option.

pub fn default_value(&self) -> Option<&str>

The default value for this configuration option.

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.

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

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

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().

pub fn min_value(&self) -> Option<i32>

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

pub fn max_value(&self) -> Option<i32>

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

pub fn max_length(&self) -> Option<i32>

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

pub fn regex(&self) -> Option<&OptionRestrictionRegex>

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

impl ConfigurationOptionDescription

pub fn builder() -> ConfigurationOptionDescriptionBuilder

Creates a new builder-style object to manufacture ConfigurationOptionDescription.

Trait Implementations

impl Clone for ConfigurationOptionDescription

fn clone(&self) -> ConfigurationOptionDescription

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConfigurationOptionDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ConfigurationOptionDescription

fn eq(&self, other: &ConfigurationOptionDescription) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ConfigurationOptionDescription