Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).

Synopsis

Creating a Request

data ApplyPendingMaintenanceAction Source #

Represents the input to ApplyPendingMaintenanceAction.

See: newApplyPendingMaintenanceAction smart constructor.

Constructors

ApplyPendingMaintenanceAction'

Fields

resourceIdentifier :: Text
The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.
applyAction :: Text
The pending maintenance action to apply to this resource.
Valid values: system-update, db-upgrade
optInType :: Text
A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can't be undone.
Valid values:
- immediate - Apply the maintenance action immediately.
- next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
- undo-opt-in - Cancel any existing next-maintenance opt-in requests.

Instances

Instances details

Eq ApplyPendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction Methods (==) :: ApplyPendingMaintenanceAction -> ApplyPendingMaintenanceAction -> Bool # (/=) :: ApplyPendingMaintenanceAction -> ApplyPendingMaintenanceAction -> Bool #
Read ApplyPendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction Methods readsPrec :: Int -> ReadS ApplyPendingMaintenanceAction # readList :: ReadS [ApplyPendingMaintenanceAction] # readPrec :: ReadPrec ApplyPendingMaintenanceAction # readListPrec :: ReadPrec [ApplyPendingMaintenanceAction] #
Show ApplyPendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction Methods showsPrec :: Int -> ApplyPendingMaintenanceAction -> ShowS # show :: ApplyPendingMaintenanceAction -> String # showList :: [ApplyPendingMaintenanceAction] -> ShowS #
Generic ApplyPendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction Associated Types type Rep ApplyPendingMaintenanceAction :: Type -> Type # Methods from :: ApplyPendingMaintenanceAction -> Rep ApplyPendingMaintenanceAction x # to :: Rep ApplyPendingMaintenanceAction x -> ApplyPendingMaintenanceAction #
NFData ApplyPendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction Methods rnf :: ApplyPendingMaintenanceAction -> () #
Hashable ApplyPendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction Methods hashWithSalt :: Int -> ApplyPendingMaintenanceAction -> Int # hash :: ApplyPendingMaintenanceAction -> Int #
AWSRequest ApplyPendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction Associated Types type AWSResponse ApplyPendingMaintenanceAction # Methods request :: ApplyPendingMaintenanceAction -> Request ApplyPendingMaintenanceAction # response :: MonadResource m => Logger -> Service -> Proxy ApplyPendingMaintenanceAction -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ApplyPendingMaintenanceAction))) #
ToHeaders ApplyPendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction Methods toHeaders :: ApplyPendingMaintenanceAction -> [Header] #
ToPath ApplyPendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction Methods toPath :: ApplyPendingMaintenanceAction -> ByteString #
ToQuery ApplyPendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction Methods toQuery :: ApplyPendingMaintenanceAction -> QueryString #
type Rep ApplyPendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction type Rep ApplyPendingMaintenanceAction = D1 ('MetaData "ApplyPendingMaintenanceAction" "Amazonka.DocumentDB.ApplyPendingMaintenanceAction" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "ApplyPendingMaintenanceAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "applyAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "optInType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ApplyPendingMaintenanceAction Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction type AWSResponse ApplyPendingMaintenanceAction = ApplyPendingMaintenanceActionResponse

newApplyPendingMaintenanceAction Source #

Arguments

:: Text	`$sel:resourceIdentifier:ApplyPendingMaintenanceAction'`
-> Text	`$sel:applyAction:ApplyPendingMaintenanceAction'`
-> Text	`$sel:optInType:ApplyPendingMaintenanceAction'`
-> ApplyPendingMaintenanceAction

Create a value of ApplyPendingMaintenanceAction 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:resourceIdentifier:ApplyPendingMaintenanceAction', applyPendingMaintenanceAction_resourceIdentifier - The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.

$sel:applyAction:ApplyPendingMaintenanceAction', applyPendingMaintenanceAction_applyAction - The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

$sel:optInType:ApplyPendingMaintenanceAction', applyPendingMaintenanceAction_optInType - A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can't be undone.

Valid values:

immediate - Apply the maintenance action immediately.
next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
undo-opt-in - Cancel any existing next-maintenance opt-in requests.

Request Lenses

applyPendingMaintenanceAction_resourceIdentifier :: Lens' ApplyPendingMaintenanceAction Text Source #

The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.

applyPendingMaintenanceAction_applyAction :: Lens' ApplyPendingMaintenanceAction Text Source #

The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

applyPendingMaintenanceAction_optInType :: Lens' ApplyPendingMaintenanceAction Text Source #

A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can't be undone.

Valid values:

immediate - Apply the maintenance action immediately.
next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
undo-opt-in - Cancel any existing next-maintenance opt-in requests.

Destructuring the Response

data ApplyPendingMaintenanceActionResponse Source #

See: newApplyPendingMaintenanceActionResponse smart constructor.

Constructors

ApplyPendingMaintenanceActionResponse'
Fields resourcePendingMaintenanceActions :: Maybe ResourcePendingMaintenanceActions httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ApplyPendingMaintenanceActionResponse Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction Methods (==) :: ApplyPendingMaintenanceActionResponse -> ApplyPendingMaintenanceActionResponse -> Bool # (/=) :: ApplyPendingMaintenanceActionResponse -> ApplyPendingMaintenanceActionResponse -> Bool #
Read ApplyPendingMaintenanceActionResponse Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction Methods readsPrec :: Int -> ReadS ApplyPendingMaintenanceActionResponse # readList :: ReadS [ApplyPendingMaintenanceActionResponse] # readPrec :: ReadPrec ApplyPendingMaintenanceActionResponse # readListPrec :: ReadPrec [ApplyPendingMaintenanceActionResponse] #
Show ApplyPendingMaintenanceActionResponse Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction Methods showsPrec :: Int -> ApplyPendingMaintenanceActionResponse -> ShowS # show :: ApplyPendingMaintenanceActionResponse -> String # showList :: [ApplyPendingMaintenanceActionResponse] -> ShowS #
Generic ApplyPendingMaintenanceActionResponse Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction Associated Types type Rep ApplyPendingMaintenanceActionResponse :: Type -> Type # Methods from :: ApplyPendingMaintenanceActionResponse -> Rep ApplyPendingMaintenanceActionResponse x # to :: Rep ApplyPendingMaintenanceActionResponse x -> ApplyPendingMaintenanceActionResponse #
NFData ApplyPendingMaintenanceActionResponse Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction Methods rnf :: ApplyPendingMaintenanceActionResponse -> () #
type Rep ApplyPendingMaintenanceActionResponse Source #
Instance details Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction type Rep ApplyPendingMaintenanceActionResponse = D1 ('MetaData "ApplyPendingMaintenanceActionResponse" "Amazonka.DocumentDB.ApplyPendingMaintenanceAction" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "ApplyPendingMaintenanceActionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourcePendingMaintenanceActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourcePendingMaintenanceActions)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newApplyPendingMaintenanceActionResponse Source #

Arguments

:: Int	`$sel:httpStatus:ApplyPendingMaintenanceActionResponse'`
-> ApplyPendingMaintenanceActionResponse

Create a value of ApplyPendingMaintenanceActionResponse 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:resourcePendingMaintenanceActions:ApplyPendingMaintenanceActionResponse', applyPendingMaintenanceActionResponse_resourcePendingMaintenanceActions - Undocumented member.

$sel:httpStatus:ApplyPendingMaintenanceActionResponse', applyPendingMaintenanceActionResponse_httpStatus - The response's http status code.

Response Lenses

applyPendingMaintenanceActionResponse_resourcePendingMaintenanceActions :: Lens' ApplyPendingMaintenanceActionResponse (Maybe ResourcePendingMaintenanceActions) Source #

Undocumented member.

applyPendingMaintenanceActionResponse_httpStatus :: Lens' ApplyPendingMaintenanceActionResponse Int Source #

The response's http status code.