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

Amazonka.M2.UpdateEnvironment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the configuration details for a specific runtime environment.

Synopsis

data UpdateEnvironment = UpdateEnvironment' {
- applyDuringMaintenanceWindow :: Maybe Bool
- desiredCapacity :: Maybe Natural
- engineVersion :: Maybe Text
- instanceType :: Maybe Text
- preferredMaintenanceWindow :: Maybe Text
- environmentId :: Text
}
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.

Constructors

UpdateEnvironment'

Fields

applyDuringMaintenanceWindow :: Maybe Bool
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 :: Maybe Natural
The desired capacity for the runtime environment to update.
engineVersion :: Maybe Text
The version of the runtime engine for the runtime environment.
instanceType :: Maybe Text
The instance type for the runtime environment to update.
preferredMaintenanceWindow :: Maybe Text
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.
environmentId :: Text
The unique identifier of the runtime environment that you want to update.

Instances

Instances details

ToJSON UpdateEnvironment Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment Methods toJSON :: UpdateEnvironment -> Value # toEncoding :: UpdateEnvironment -> Encoding # toJSONList :: [UpdateEnvironment] -> Value # toEncodingList :: [UpdateEnvironment] -> Encoding #
ToHeaders UpdateEnvironment Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment Methods toHeaders :: UpdateEnvironment -> [Header] #
ToPath UpdateEnvironment Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment Methods toPath :: UpdateEnvironment -> ByteString #
ToQuery UpdateEnvironment Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment Methods toQuery :: UpdateEnvironment -> QueryString #
AWSRequest UpdateEnvironment Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment Associated Types type AWSResponse UpdateEnvironment # Methods request :: (Service -> Service) -> UpdateEnvironment -> Request UpdateEnvironment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateEnvironment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateEnvironment))) #
Generic UpdateEnvironment Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment Associated Types type Rep UpdateEnvironment :: Type -> Type # Methods from :: UpdateEnvironment -> Rep UpdateEnvironment x # to :: Rep UpdateEnvironment x -> UpdateEnvironment #
Read UpdateEnvironment Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment Methods readsPrec :: Int -> ReadS UpdateEnvironment # readList :: ReadS [UpdateEnvironment] # readPrec :: ReadPrec UpdateEnvironment # readListPrec :: ReadPrec [UpdateEnvironment] #
Show UpdateEnvironment Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment Methods showsPrec :: Int -> UpdateEnvironment -> ShowS # show :: UpdateEnvironment -> String # showList :: [UpdateEnvironment] -> ShowS #
NFData UpdateEnvironment Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment Methods rnf :: UpdateEnvironment -> () #
Eq UpdateEnvironment Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment Methods (==) :: UpdateEnvironment -> UpdateEnvironment -> Bool # (/=) :: UpdateEnvironment -> UpdateEnvironment -> Bool #
Hashable UpdateEnvironment Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment Methods hashWithSalt :: Int -> UpdateEnvironment -> Int # hash :: UpdateEnvironment -> Int #
type AWSResponse UpdateEnvironment Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment type AWSResponse UpdateEnvironment = UpdateEnvironmentResponse
type Rep UpdateEnvironment Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment type Rep UpdateEnvironment = D1 ('MetaData "UpdateEnvironment" "Amazonka.M2.UpdateEnvironment" "amazonka-m2-2.0-1kXEGTJs74f5RPbatSDeMH" 'False) (C1 ('MetaCons "UpdateEnvironment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applyDuringMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "desiredCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateEnvironment Source #

Arguments

:: Text	`UpdateEnvironment`
-> UpdateEnvironment

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.

Constructors

UpdateEnvironmentResponse'
Fields httpStatus :: Int The response's http status code. environmentId :: Text The unique identifier of the runtime environment that was updated.

Instances

Instances details

Generic UpdateEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment Associated Types type Rep UpdateEnvironmentResponse :: Type -> Type # Methods from :: UpdateEnvironmentResponse -> Rep UpdateEnvironmentResponse x # to :: Rep UpdateEnvironmentResponse x -> UpdateEnvironmentResponse #
Read UpdateEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment Methods readsPrec :: Int -> ReadS UpdateEnvironmentResponse # readList :: ReadS [UpdateEnvironmentResponse] # readPrec :: ReadPrec UpdateEnvironmentResponse # readListPrec :: ReadPrec [UpdateEnvironmentResponse] #
Show UpdateEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment Methods showsPrec :: Int -> UpdateEnvironmentResponse -> ShowS # show :: UpdateEnvironmentResponse -> String # showList :: [UpdateEnvironmentResponse] -> ShowS #
NFData UpdateEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment Methods rnf :: UpdateEnvironmentResponse -> () #
Eq UpdateEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment Methods (==) :: UpdateEnvironmentResponse -> UpdateEnvironmentResponse -> Bool # (/=) :: UpdateEnvironmentResponse -> UpdateEnvironmentResponse -> Bool #
type Rep UpdateEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.UpdateEnvironment type Rep UpdateEnvironmentResponse = D1 ('MetaData "UpdateEnvironmentResponse" "Amazonka.M2.UpdateEnvironment" "amazonka-m2-2.0-1kXEGTJs74f5RPbatSDeMH" 'False) (C1 ('MetaCons "UpdateEnvironmentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateEnvironmentResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateEnvironmentResponse'`
-> Text	`UpdateEnvironment`
-> 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.