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

Interface UpdateEnvironmentRequest.Builder

    • Method Detail

      • applyDuringMaintenanceWindow

        UpdateEnvironmentRequest.Builder applyDuringMaintenanceWindow​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • desiredCapacity

        UpdateEnvironmentRequest.Builder desiredCapacity​(Integer 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

        UpdateEnvironmentRequest.Builder engineVersion​(String 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

        UpdateEnvironmentRequest.Builder environmentId​(String 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

        UpdateEnvironmentRequest.Builder forceUpdate​(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.

        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

        UpdateEnvironmentRequest.Builder instanceType​(String 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

        UpdateEnvironmentRequest.Builder preferredMaintenanceWindow​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.