Struct aws_sdk_elasticbeanstalk::client::fluent_builders::UpdateEnvironment

pub struct UpdateEnvironment { /* private fields */ }

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

impl UpdateEnvironment

pub async fn send(
    self
) -> Result<UpdateEnvironmentOutput, SdkError<UpdateEnvironmentError>>

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.

pub fn application_name(self, input: impl Into<String>) -> Self

The name of the application with which the environment is associated.

pub fn set_application_name(self, input: Option<String>) -> Self

The name of the application with which the environment is associated.

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.

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.

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.

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.

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.

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.

pub fn description(self, input: impl Into<String>) -> Self

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

pub fn set_description(self, input: Option<String>) -> Self

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

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.

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.

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.

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.

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.

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.

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.

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.

pub fn platform_arn(self, input: impl Into<String>) -> Self

The ARN of the platform, if used.

pub fn set_platform_arn(self, input: Option<String>) -> Self

The ARN of the platform, if used.

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.

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.

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.

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.

Trait Implementations

impl Clone for UpdateEnvironment

fn clone(&self) -> UpdateEnvironment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateEnvironment

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

Formats the value using the given formatter.