#[non_exhaustive]pub struct ConfigurationOptionDescriptionBuilder { /* private fields */ }
Expand description
A builder for ConfigurationOptionDescription
.
Implementations§
Source§impl ConfigurationOptionDescriptionBuilder
impl ConfigurationOptionDescriptionBuilder
Sourcepub fn namespace(self, input: impl Into<String>) -> Self
pub fn namespace(self, input: impl Into<String>) -> Self
A unique namespace identifying the option's associated AWS resource.
Sourcepub fn set_namespace(self, input: Option<String>) -> Self
pub fn set_namespace(self, input: Option<String>) -> Self
A unique namespace identifying the option's associated AWS resource.
Sourcepub fn get_namespace(&self) -> &Option<String>
pub fn get_namespace(&self) -> &Option<String>
A unique namespace identifying the option's associated AWS resource.
Sourcepub fn default_value(self, input: impl Into<String>) -> Self
pub fn default_value(self, input: impl Into<String>) -> Self
The default value for this configuration option.
Sourcepub fn set_default_value(self, input: Option<String>) -> Self
pub fn set_default_value(self, input: Option<String>) -> Self
The default value for this configuration option.
Sourcepub fn get_default_value(&self) -> &Option<String>
pub fn get_default_value(&self) -> &Option<String>
The default value for this configuration option.
Sourcepub fn change_severity(self, input: impl Into<String>) -> Self
pub fn change_severity(self, input: impl Into<String>) -> Self
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 set_change_severity(self, input: Option<String>) -> Self
pub fn set_change_severity(self, input: Option<String>) -> Self
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 get_change_severity(&self) -> &Option<String>
pub fn get_change_severity(&self) -> &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.
Sourcepub fn user_defined(self, input: bool) -> Self
pub fn user_defined(self, input: bool) -> Self
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 set_user_defined(self, input: Option<bool>) -> Self
pub fn set_user_defined(self, input: Option<bool>) -> Self
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 get_user_defined(&self) -> &Option<bool>
pub fn get_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, input: ConfigurationOptionValueType) -> Self
pub fn value_type(self, input: ConfigurationOptionValueType) -> Self
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 set_value_type(self, input: Option<ConfigurationOptionValueType>) -> Self
pub fn set_value_type(self, input: Option<ConfigurationOptionValueType>) -> Self
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 get_value_type(&self) -> &Option<ConfigurationOptionValueType>
pub fn get_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, input: impl Into<String>) -> Self
pub fn value_options(self, input: impl Into<String>) -> Self
Appends an item to value_options
.
To override the contents of this collection use set_value_options
.
If specified, values for the configuration option are selected from this list.
Sourcepub fn set_value_options(self, input: Option<Vec<String>>) -> Self
pub fn set_value_options(self, input: Option<Vec<String>>) -> Self
If specified, values for the configuration option are selected from this list.
Sourcepub fn get_value_options(&self) -> &Option<Vec<String>>
pub fn get_value_options(&self) -> &Option<Vec<String>>
If specified, values for the configuration option are selected from this list.
Sourcepub fn min_value(self, input: i32) -> Self
pub fn min_value(self, input: i32) -> Self
If specified, the configuration option must be a numeric value greater than this value.
Sourcepub fn set_min_value(self, input: Option<i32>) -> Self
pub fn set_min_value(self, input: Option<i32>) -> Self
If specified, the configuration option must be a numeric value greater than this value.
Sourcepub fn get_min_value(&self) -> &Option<i32>
pub fn get_min_value(&self) -> &Option<i32>
If specified, the configuration option must be a numeric value greater than this value.
Sourcepub fn max_value(self, input: i32) -> Self
pub fn max_value(self, input: i32) -> Self
If specified, the configuration option must be a numeric value less than this value.
Sourcepub fn set_max_value(self, input: Option<i32>) -> Self
pub fn set_max_value(self, input: Option<i32>) -> Self
If specified, the configuration option must be a numeric value less than this value.
Sourcepub fn get_max_value(&self) -> &Option<i32>
pub fn get_max_value(&self) -> &Option<i32>
If specified, the configuration option must be a numeric value less than this value.
Sourcepub fn max_length(self, input: i32) -> Self
pub fn max_length(self, input: i32) -> Self
If specified, the configuration option must be a string value no longer than this value.
Sourcepub fn set_max_length(self, input: Option<i32>) -> Self
pub fn set_max_length(self, input: Option<i32>) -> Self
If specified, the configuration option must be a string value no longer than this value.
Sourcepub fn get_max_length(&self) -> &Option<i32>
pub fn get_max_length(&self) -> &Option<i32>
If specified, the configuration option must be a string value no longer than this value.
Sourcepub fn regex(self, input: OptionRestrictionRegex) -> Self
pub fn regex(self, input: OptionRestrictionRegex) -> Self
If specified, the configuration option must be a string value that satisfies this regular expression.
Sourcepub fn set_regex(self, input: Option<OptionRestrictionRegex>) -> Self
pub fn set_regex(self, input: Option<OptionRestrictionRegex>) -> Self
If specified, the configuration option must be a string value that satisfies this regular expression.
Sourcepub fn get_regex(&self) -> &Option<OptionRestrictionRegex>
pub fn get_regex(&self) -> &Option<OptionRestrictionRegex>
If specified, the configuration option must be a string value that satisfies this regular expression.
Sourcepub fn build(self) -> ConfigurationOptionDescription
pub fn build(self) -> ConfigurationOptionDescription
Consumes the builder and constructs a ConfigurationOptionDescription
.
Trait Implementations§
Source§impl Clone for ConfigurationOptionDescriptionBuilder
impl Clone for ConfigurationOptionDescriptionBuilder
Source§fn clone(&self) -> ConfigurationOptionDescriptionBuilder
fn clone(&self) -> ConfigurationOptionDescriptionBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for ConfigurationOptionDescriptionBuilder
impl Default for ConfigurationOptionDescriptionBuilder
Source§fn default() -> ConfigurationOptionDescriptionBuilder
fn default() -> ConfigurationOptionDescriptionBuilder
Source§impl PartialEq for ConfigurationOptionDescriptionBuilder
impl PartialEq for ConfigurationOptionDescriptionBuilder
Source§fn eq(&self, other: &ConfigurationOptionDescriptionBuilder) -> bool
fn eq(&self, other: &ConfigurationOptionDescriptionBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ConfigurationOptionDescriptionBuilder
Auto Trait Implementations§
impl Freeze for ConfigurationOptionDescriptionBuilder
impl RefUnwindSafe for ConfigurationOptionDescriptionBuilder
impl Send for ConfigurationOptionDescriptionBuilder
impl Sync for ConfigurationOptionDescriptionBuilder
impl Unpin for ConfigurationOptionDescriptionBuilder
impl UnwindSafe for ConfigurationOptionDescriptionBuilder
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);