#[non_exhaustive]pub struct UpdateEnvironmentInput {
pub application_name: Option<String>,
pub environment_id: Option<String>,
pub environment_name: Option<String>,
pub group_name: Option<String>,
pub description: Option<String>,
pub tier: Option<EnvironmentTier>,
pub version_label: Option<String>,
pub template_name: Option<String>,
pub solution_stack_name: Option<String>,
pub platform_arn: Option<String>,
pub option_settings: Option<Vec<ConfigurationOptionSetting>>,
pub options_to_remove: Option<Vec<OptionSpecification>>,
}
Expand description
Request to update an environment.
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.application_name: Option<String>
The name of the application with which the environment is associated.
environment_id: 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.
environment_name: 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.
group_name: 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.
description: Option<String>
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
tier: 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.
version_label: 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.
template_name: 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.
solution_stack_name: Option<String>
This specifies the platform version that the environment will run after the environment is updated.
platform_arn: Option<String>
The ARN of the platform, if used.
option_settings: 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.
options_to_remove: Option<Vec<OptionSpecification>>
A list of custom user-defined configuration options to remove from the configuration set for this environment.
Implementations§
source§impl UpdateEnvironmentInput
impl UpdateEnvironmentInput
sourcepub fn application_name(&self) -> Option<&str>
pub fn application_name(&self) -> Option<&str>
The name of the application with which the environment is associated.
sourcepub fn environment_id(&self) -> Option<&str>
pub fn environment_id(&self) -> Option<&str>
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) -> Option<&str>
pub fn environment_name(&self) -> Option<&str>
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) -> Option<&str>
pub fn group_name(&self) -> Option<&str>
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) -> Option<&str>
pub fn description(&self) -> Option<&str>
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
sourcepub fn tier(&self) -> Option<&EnvironmentTier>
pub fn 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) -> Option<&str>
pub fn version_label(&self) -> Option<&str>
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) -> Option<&str>
pub fn template_name(&self) -> Option<&str>
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) -> Option<&str>
pub fn solution_stack_name(&self) -> Option<&str>
This specifies the platform version that the environment will run after the environment is updated.
sourcepub fn platform_arn(&self) -> Option<&str>
pub fn platform_arn(&self) -> Option<&str>
The ARN of the platform, if used.
sourcepub fn option_settings(&self) -> &[ConfigurationOptionSetting]
pub fn option_settings(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .option_settings.is_none()
.
sourcepub fn options_to_remove(&self) -> &[OptionSpecification]
pub fn options_to_remove(&self) -> &[OptionSpecification]
A list of custom user-defined configuration options to remove from the configuration set for this environment.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .options_to_remove.is_none()
.
source§impl UpdateEnvironmentInput
impl UpdateEnvironmentInput
sourcepub fn builder() -> UpdateEnvironmentInputBuilder
pub fn builder() -> UpdateEnvironmentInputBuilder
Creates a new builder-style object to manufacture UpdateEnvironmentInput
.
Trait Implementations§
source§impl Clone for UpdateEnvironmentInput
impl Clone for UpdateEnvironmentInput
source§fn clone(&self) -> UpdateEnvironmentInput
fn clone(&self) -> UpdateEnvironmentInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for UpdateEnvironmentInput
impl Debug for UpdateEnvironmentInput
source§impl PartialEq for UpdateEnvironmentInput
impl PartialEq for UpdateEnvironmentInput
source§fn eq(&self, other: &UpdateEnvironmentInput) -> bool
fn eq(&self, other: &UpdateEnvironmentInput) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for UpdateEnvironmentInput
Auto Trait Implementations§
impl Freeze for UpdateEnvironmentInput
impl RefUnwindSafe for UpdateEnvironmentInput
impl Send for UpdateEnvironmentInput
impl Sync for UpdateEnvironmentInput
impl Unpin for UpdateEnvironmentInput
impl UnwindSafe for UpdateEnvironmentInput
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