Package software.amazon.awssdk.services.m2.model

Class UpdateEnvironmentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.m2.model.M2Request

software.amazon.awssdk.services.m2.model.UpdateEnvironmentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateEnvironmentRequest
extends M2Request
implements ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateEnvironmentRequest.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	applyDuringMaintenanceWindow()	Indicates whether to update the runtime environment during the maintenance window.
static UpdateEnvironmentRequest.Builder	builder()
Integer	desiredCapacity()	The desired capacity for the runtime environment to update.
String	engineVersion()	The version of the runtime engine for the runtime environment.
String	environmentId()	The unique identifier of the runtime environment that you want to update.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	forceUpdate()	Forces the updates on the environment.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	instanceType()	The instance type for the runtime environment to update.
String	preferredMaintenanceWindow()	Configures the maintenance window that you want for the runtime environment.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateEnvironmentRequest.Builder>	serializableBuilderClass()
UpdateEnvironmentRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

applyDuringMaintenanceWindow

public final Boolean applyDuringMaintenanceWindow()

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.

Returns:

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.

desiredCapacity

public final Integer desiredCapacity()

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

Returns:

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

engineVersion

public final String engineVersion()

The version of the runtime engine for the runtime environment.

Returns:

The version of the runtime engine for the runtime environment.

environmentId

public final String environmentId()

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

Returns:

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

forceUpdate

public final Boolean forceUpdate()

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.

Returns:

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.

instanceType

public final String instanceType()

The instance type for the runtime environment to update.

Returns:

The instance type for the runtime environment to update.

preferredMaintenanceWindow

public final String preferredMaintenanceWindow()

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.

Returns:

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.

toBuilder

public UpdateEnvironmentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

Specified by:

toBuilder in class M2Request

builder

public static UpdateEnvironmentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateEnvironmentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo