Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Updates the configuration details for a specific runtime environment.
Synopsis
- data UpdateEnvironment = UpdateEnvironment' {}
- newUpdateEnvironment :: Text -> UpdateEnvironment
- updateEnvironment_applyDuringMaintenanceWindow :: Lens' UpdateEnvironment (Maybe Bool)
- updateEnvironment_desiredCapacity :: Lens' UpdateEnvironment (Maybe Natural)
- updateEnvironment_engineVersion :: Lens' UpdateEnvironment (Maybe Text)
- updateEnvironment_instanceType :: Lens' UpdateEnvironment (Maybe Text)
- updateEnvironment_preferredMaintenanceWindow :: Lens' UpdateEnvironment (Maybe Text)
- updateEnvironment_environmentId :: Lens' UpdateEnvironment Text
- data UpdateEnvironmentResponse = UpdateEnvironmentResponse' {
- httpStatus :: Int
- environmentId :: Text
- newUpdateEnvironmentResponse :: Int -> Text -> UpdateEnvironmentResponse
- updateEnvironmentResponse_httpStatus :: Lens' UpdateEnvironmentResponse Int
- updateEnvironmentResponse_environmentId :: Lens' UpdateEnvironmentResponse Text
Creating a Request
data UpdateEnvironment Source #
See: newUpdateEnvironment
smart constructor.
UpdateEnvironment' | |
|
Instances
Create a value of UpdateEnvironment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applyDuringMaintenanceWindow:UpdateEnvironment'
, updateEnvironment_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.
UpdateEnvironment
, updateEnvironment_desiredCapacity
- The desired capacity for the runtime environment to update.
UpdateEnvironment
, updateEnvironment_engineVersion
- The version of the runtime engine for the runtime environment.
UpdateEnvironment
, updateEnvironment_instanceType
- The instance type for the runtime environment to update.
$sel:preferredMaintenanceWindow:UpdateEnvironment'
, updateEnvironment_preferredMaintenanceWindow
- Configures the maintenance window you want for the runtime environment.
If you do not provide a value, a random system-generated value will be
assigned.
UpdateEnvironment
, updateEnvironment_environmentId
- The unique identifier of the runtime environment that you want to
update.
Request Lenses
updateEnvironment_applyDuringMaintenanceWindow :: Lens' UpdateEnvironment (Maybe Bool) Source #
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.
updateEnvironment_desiredCapacity :: Lens' UpdateEnvironment (Maybe Natural) Source #
The desired capacity for the runtime environment to update.
updateEnvironment_engineVersion :: Lens' UpdateEnvironment (Maybe Text) Source #
The version of the runtime engine for the runtime environment.
updateEnvironment_instanceType :: Lens' UpdateEnvironment (Maybe Text) Source #
The instance type for the runtime environment to update.
updateEnvironment_preferredMaintenanceWindow :: Lens' UpdateEnvironment (Maybe Text) Source #
Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.
updateEnvironment_environmentId :: Lens' UpdateEnvironment Text Source #
The unique identifier of the runtime environment that you want to update.
Destructuring the Response
data UpdateEnvironmentResponse Source #
See: newUpdateEnvironmentResponse
smart constructor.
UpdateEnvironmentResponse' | |
|
Instances
newUpdateEnvironmentResponse Source #
:: Int | |
-> Text | |
-> UpdateEnvironmentResponse |
Create a value of UpdateEnvironmentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateEnvironmentResponse'
, updateEnvironmentResponse_httpStatus
- The response's http status code.
UpdateEnvironment
, updateEnvironmentResponse_environmentId
- The unique identifier of the runtime environment that was updated.
Response Lenses
updateEnvironmentResponse_httpStatus :: Lens' UpdateEnvironmentResponse Int Source #
The response's http status code.
updateEnvironmentResponse_environmentId :: Lens' UpdateEnvironmentResponse Text Source #
The unique identifier of the runtime environment that was updated.