Interface UpdateEnvironmentRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateEnvironmentRequest.Builder,
,UpdateEnvironmentRequest> M2Request.Builder
,SdkBuilder<UpdateEnvironmentRequest.Builder,
,UpdateEnvironmentRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateEnvironmentRequest
-
Method Summary
Modifier and TypeMethodDescriptionapplyDuringMaintenanceWindow
(Boolean applyDuringMaintenanceWindow) Indicates whether to update the runtime environment during the maintenance window.desiredCapacity
(Integer desiredCapacity) The desired capacity for the runtime environment to update.engineVersion
(String engineVersion) The version of the runtime engine for the runtime environment.environmentId
(String environmentId) The unique identifier of the runtime environment that you want to update.forceUpdate
(Boolean forceUpdate) Forces the updates on the environment.instanceType
(String instanceType) The instance type for the runtime environment to update.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.preferredMaintenanceWindow
(String preferredMaintenanceWindow) Configures the maintenance window that you want for the runtime environment.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.m2.model.M2Request.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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 ifapplyDuringMaintenanceWindow
is true. If any parameter other thanengineVersion
is provided inUpdateEnvironmentRequest
, it will fail ifapplyDuringMaintenanceWindow
is set to true.- Parameters:
applyDuringMaintenanceWindow
- Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts theengineVersion
parameter only ifapplyDuringMaintenanceWindow
is true. If any parameter other thanengineVersion
is provided inUpdateEnvironmentRequest
, it will fail ifapplyDuringMaintenanceWindow
is set to true.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
desiredCapacity
The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.
- Parameters:
desiredCapacity
- The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engineVersion
The version of the runtime engine for the runtime environment.
- Parameters:
engineVersion
- The version of the runtime engine for the runtime environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
environmentId
The unique identifier of the runtime environment that you want to update.
- Parameters:
environmentId
- The unique identifier of the runtime environment that you want to update.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
instanceType
The instance type for the runtime environment to update.
- Parameters:
instanceType
- The instance type for the runtime environment to update.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
orsat:01:00-sat:03:00
.If you do not provide a value, a random system-generated value will be assigned.
- Parameters:
preferredMaintenanceWindow
- Configures the maintenance window that you want for the runtime environment. The maintenance window must have the formatddd: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
orsat:01:00-sat:03:00
.If you do not provide a value, a random system-generated value will be assigned.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateEnvironmentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateEnvironmentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-