Struct aws_sdk_m2::operation::update_environment::UpdateEnvironmentInput

#[non_exhaustive]
pub struct UpdateEnvironmentInput {
    pub environment_id: Option<String>,
    pub desired_capacity: Option<i32>,
    pub instance_type: Option<String>,
    pub engine_version: Option<String>,
    pub preferred_maintenance_window: Option<String>,
    pub apply_during_maintenance_window: Option<bool>,
    pub force_update: Option<bool>,
}

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.

environment_id: Option<String>

The unique identifier of the runtime environment that you want to update.

desired_capacity: Option<i32>

The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.

instance_type: Option<String>

The instance type for the runtime environment to update.

engine_version: Option<String>

The version of the runtime engine for the runtime environment.

preferred_maintenance_window: Option<String>

Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

If you do not provide a value, a random system-generated value will be assigned.

apply_during_maintenance_window: Option<bool>

Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.

force_update: Option<bool>

Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.

If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.

This option is not needed if the attribute being updated is preferredMaintenanceWindow.

Implementations

impl UpdateEnvironmentInput

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

The unique identifier of the runtime environment that you want to update.

pub fn desired_capacity(&self) -> Option<i32>

The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.

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

The instance type for the runtime environment to update.

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

The version of the runtime engine for the runtime environment.

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

Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

If you do not provide a value, a random system-generated value will be assigned.

pub fn apply_during_maintenance_window(&self) -> Option<bool>

Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.

pub fn force_update(&self) -> Option<bool>

Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.

If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.

This option is not needed if the attribute being updated is preferredMaintenanceWindow.

impl UpdateEnvironmentInput

pub fn builder() -> UpdateEnvironmentInputBuilder

Creates a new builder-style object to manufacture UpdateEnvironmentInput.

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 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateEnvironmentInput