UpdateEnvironmentRequest ¶

class UpdateEnvironmentRequest(TypedDict, closed=True):
    environment_id: "capo_m2.types.identifier.Identifier"
    """<p>The unique identifier of the runtime environment that you want to update.</p>"""
    desired_capacity: NotRequired["capo_m2.types.capacity_value.CapacityValue"]
    """<p>The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.</p>"""
    instance_type: NotRequired["capo_m2.types.string20.String20"]
    """<p>The instance type for the runtime environment to update.</p>"""
    engine_version: NotRequired["capo_m2.types.engine_version.EngineVersion"]
    """<p>The version of the runtime engine for the runtime environment.</p>"""
    preferred_maintenance_window: NotRequired["str"]
    """<p>Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format <code>ddd:hh24:mi-ddd:hh24:mi</code> and must be less than 24 hours. The following two examples are valid maintenance windows: <code>sun:23:45-mon:00:15</code> or <code>sat:01:00-sat:03:00</code>. </p> <p>If you do not provide a value, a random system-generated value will be assigned.</p>"""
    apply_during_maintenance_window: "capo_m2.types.boolean.Boolean"
    """<p>Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the <code>engineVersion</code> parameter only if <code>applyDuringMaintenanceWindow</code> is true. If any parameter other than <code>engineVersion</code> is provided in <code>UpdateEnvironmentRequest</code>, it will fail if <code>applyDuringMaintenanceWindow</code> is set to true.</p>"""
    force_update: "capo_m2.types.boolean.Boolean"
    """<p>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.</p> <p>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.</p> <p>This option is not needed if the attribute being updated is <code>preferredMaintenanceWindow</code>.</p>"""