libZSservicesZSamazonka-docdbZSamazonka-docdb
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DocumentDB.ApplyPendingMaintenanceAction

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

Read ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Show ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Generic ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Associated Types

type Rep ApplyPendingMaintenanceAction :: Type -> Type #

NFData ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Hashable ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

AWSRequest ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

ToHeaders ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

ToPath ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

ToQuery ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

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

newApplyPendingMaintenanceAction Source #

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 #

Instances

Instances details
Eq ApplyPendingMaintenanceActionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Read ApplyPendingMaintenanceActionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Show ApplyPendingMaintenanceActionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Generic ApplyPendingMaintenanceActionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

NFData ApplyPendingMaintenanceActionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

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)))

Response Lenses