Struct aws_sdk_elasticbeanstalk::input::UpdateEnvironmentInput

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

Request to update an environment.

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.

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

impl UpdateEnvironmentInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<UpdateEnvironment, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<UpdateEnvironment>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture UpdateEnvironmentInput

impl UpdateEnvironmentInput

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

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

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.

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.

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.

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

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

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.

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.

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.

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

This specifies the platform version that the environment will run after the environment is updated.

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

The ARN of the platform, if used.

pub fn option_settings(&self) -> Option<&[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.

pub fn options_to_remove(&self) -> Option<&[OptionSpecification]>

A list of custom user-defined configuration options to remove from the configuration set for this environment.

Trait Implementations

impl Clone for UpdateEnvironmentInput

fn clone(&self) -> UpdateEnvironmentInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateEnvironmentInput

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

Formats the value using the given formatter.

impl PartialEq<UpdateEnvironmentInput> for UpdateEnvironmentInput

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for UpdateEnvironmentInput