pub struct UpdateEnvironmentFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateEnvironment
.
Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.
Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination
error.
When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings
for this environment returns two setting descriptions with different DeploymentStatus
values.
Implementations§
Source§impl UpdateEnvironmentFluentBuilder
impl UpdateEnvironmentFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateEnvironmentInputBuilder
pub fn as_input(&self) -> &UpdateEnvironmentInputBuilder
Access the UpdateEnvironment as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateEnvironmentOutput, SdkError<UpdateEnvironmentError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateEnvironmentOutput, SdkError<UpdateEnvironmentError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<UpdateEnvironmentOutput, UpdateEnvironmentError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateEnvironmentOutput, UpdateEnvironmentError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn application_name(self, input: impl Into<String>) -> Self
pub fn application_name(self, input: impl Into<String>) -> Self
The name of the application with which the environment is associated.
Sourcepub fn set_application_name(self, input: Option<String>) -> Self
pub fn set_application_name(self, input: Option<String>) -> Self
The name of the application with which the environment is associated.
Sourcepub fn get_application_name(&self) -> &Option<String>
pub fn get_application_name(&self) -> &Option<String>
The name of the application with which the environment is associated.
Sourcepub fn environment_id(self, input: impl Into<String>) -> Self
pub fn environment_id(self, input: impl Into<String>) -> Self
The ID of the environment to update.
If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
Sourcepub fn set_environment_id(self, input: Option<String>) -> Self
pub fn set_environment_id(self, input: Option<String>) -> Self
The ID of the environment to update.
If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
Sourcepub fn get_environment_id(&self) -> &Option<String>
pub fn get_environment_id(&self) -> &Option<String>
The ID of the environment to update.
If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
Sourcepub fn environment_name(self, input: impl Into<String>) -> Self
pub fn environment_name(self, input: impl Into<String>) -> Self
The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
Sourcepub fn set_environment_name(self, input: Option<String>) -> Self
pub fn set_environment_name(self, input: Option<String>) -> Self
The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
Sourcepub fn get_environment_name(&self) -> &Option<String>
pub fn get_environment_name(&self) -> &Option<String>
The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
Sourcepub fn group_name(self, input: impl Into<String>) -> Self
pub fn group_name(self, input: impl Into<String>) -> Self
The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.
Sourcepub fn set_group_name(self, input: Option<String>) -> Self
pub fn set_group_name(self, input: Option<String>) -> Self
The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.
Sourcepub fn get_group_name(&self) -> &Option<String>
pub fn get_group_name(&self) -> &Option<String>
The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
Sourcepub fn tier(self, input: EnvironmentTier) -> Self
pub fn tier(self, input: EnvironmentTier) -> Self
This specifies the tier to use to update the environment.
Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue
error.
Sourcepub fn set_tier(self, input: Option<EnvironmentTier>) -> Self
pub fn set_tier(self, input: Option<EnvironmentTier>) -> Self
This specifies the tier to use to update the environment.
Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue
error.
Sourcepub fn get_tier(&self) -> &Option<EnvironmentTier>
pub fn get_tier(&self) -> &Option<EnvironmentTier>
This specifies the tier to use to update the environment.
Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue
error.
Sourcepub fn version_label(self, input: impl Into<String>) -> Self
pub fn version_label(self, input: impl Into<String>) -> Self
If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue
error.
Sourcepub fn set_version_label(self, input: Option<String>) -> Self
pub fn set_version_label(self, input: Option<String>) -> Self
If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue
error.
Sourcepub fn get_version_label(&self) -> &Option<String>
pub fn get_version_label(&self) -> &Option<String>
If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue
error.
Sourcepub fn template_name(self, input: impl Into<String>) -> Self
pub fn template_name(self, input: impl Into<String>) -> Self
If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
Sourcepub fn set_template_name(self, input: Option<String>) -> Self
pub fn set_template_name(self, input: Option<String>) -> Self
If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
Sourcepub fn get_template_name(&self) -> &Option<String>
pub fn get_template_name(&self) -> &Option<String>
If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
Sourcepub fn solution_stack_name(self, input: impl Into<String>) -> Self
pub fn solution_stack_name(self, input: impl Into<String>) -> Self
This specifies the platform version that the environment will run after the environment is updated.
Sourcepub fn set_solution_stack_name(self, input: Option<String>) -> Self
pub fn set_solution_stack_name(self, input: Option<String>) -> Self
This specifies the platform version that the environment will run after the environment is updated.
Sourcepub fn get_solution_stack_name(&self) -> &Option<String>
pub fn get_solution_stack_name(&self) -> &Option<String>
This specifies the platform version that the environment will run after the environment is updated.
Sourcepub fn platform_arn(self, input: impl Into<String>) -> Self
pub fn platform_arn(self, input: impl Into<String>) -> Self
The ARN of the platform, if used.
Sourcepub fn set_platform_arn(self, input: Option<String>) -> Self
pub fn set_platform_arn(self, input: Option<String>) -> Self
The ARN of the platform, if used.
Sourcepub fn get_platform_arn(&self) -> &Option<String>
pub fn get_platform_arn(&self) -> &Option<String>
The ARN of the platform, if used.
Sourcepub fn option_settings(self, input: ConfigurationOptionSetting) -> Self
pub fn option_settings(self, input: ConfigurationOptionSetting) -> Self
Appends an item to OptionSettings
.
To override the contents of this collection use set_option_settings
.
If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
Sourcepub fn set_option_settings(
self,
input: Option<Vec<ConfigurationOptionSetting>>,
) -> Self
pub fn set_option_settings( self, input: Option<Vec<ConfigurationOptionSetting>>, ) -> Self
If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
Sourcepub fn get_option_settings(&self) -> &Option<Vec<ConfigurationOptionSetting>>
pub fn get_option_settings(&self) -> &Option<Vec<ConfigurationOptionSetting>>
If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
Sourcepub fn options_to_remove(self, input: OptionSpecification) -> Self
pub fn options_to_remove(self, input: OptionSpecification) -> Self
Appends an item to OptionsToRemove
.
To override the contents of this collection use set_options_to_remove
.
A list of custom user-defined configuration options to remove from the configuration set for this environment.
Sourcepub fn set_options_to_remove(
self,
input: Option<Vec<OptionSpecification>>,
) -> Self
pub fn set_options_to_remove( self, input: Option<Vec<OptionSpecification>>, ) -> Self
A list of custom user-defined configuration options to remove from the configuration set for this environment.
Sourcepub fn get_options_to_remove(&self) -> &Option<Vec<OptionSpecification>>
pub fn get_options_to_remove(&self) -> &Option<Vec<OptionSpecification>>
A list of custom user-defined configuration options to remove from the configuration set for this environment.
Trait Implementations§
Source§impl Clone for UpdateEnvironmentFluentBuilder
impl Clone for UpdateEnvironmentFluentBuilder
Source§fn clone(&self) -> UpdateEnvironmentFluentBuilder
fn clone(&self) -> UpdateEnvironmentFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for UpdateEnvironmentFluentBuilder
impl !RefUnwindSafe for UpdateEnvironmentFluentBuilder
impl Send for UpdateEnvironmentFluentBuilder
impl Sync for UpdateEnvironmentFluentBuilder
impl Unpin for UpdateEnvironmentFluentBuilder
impl !UnwindSafe for UpdateEnvironmentFluentBuilder
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);