You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RDS::PendingMaintenanceAction

Inherits:
Aws::Resources::Resource show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Aws::Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Aws::Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Aws::Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(target_arn, name, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

  • #initialize(target_arn, name, options = {}) ⇒ Object

    Parameters:

    • target_arn (String)
    • name (String)

    Options Hash (options):

    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

    • :target_arn (required, String)
    • :name (required, String)
    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#actionString (readonly)

The type of pending maintenance action that is available for the resource.

Returns:

  • (String)

    The type of pending maintenance action that is available for the resource.

#auto_applied_after_dateTime (readonly)

The date of the maintenance window when the action will be applied. The maintenance action will be applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

Returns:

  • (Time)

    The date of the maintenance window when the action will be applied.

#current_apply_dateTime (readonly)

The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

Returns:

  • (Time)

    The effective date when the pending maintenance action will be applied to the resource.

#descriptionString (readonly)

A description providing more detail about the maintenance action.

Returns:

  • (String)

    A description providing more detail about the maintenance action.

#forced_apply_dateTime (readonly)

The date when the maintenance action will be automatically applied. The maintenance action will be applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

Returns:

  • (Time)

    The date when the maintenance action will be automatically applied.

#nameString (readonly)

Returns:

  • (String)

#opt_in_statusString (readonly)

Indicates the type of opt-in request that has been received for the resource.

Returns:

  • (String)

    Indicates the type of opt-in request that has been received for the resource.

#target_arnString (readonly)

Returns:

  • (String)

Instance Method Details

#apply_immediatelyResourcePendingMaintenanceActionList

Examples:

Request syntax example with placeholder values


pendingmaintenanceaction.apply_immediately()

Basic usage

resourcependingmaintenanceactionlist = pendingmaintenanceaction.apply_immediately(options)
resourcependingmaintenanceactionlist.arn
#=> "resourcependingmaintenanceactionlist-arn"

Returns:

See Also:

#apply_on_next_maintenanceResourcePendingMaintenanceActionList

Examples:

Request syntax example with placeholder values


pendingmaintenanceaction.apply_on_next_maintenance()

Basic usage

resourcependingmaintenanceactionlist = pendingmaintenanceaction.apply_on_next_maintenance(options)
resourcependingmaintenanceactionlist.arn
#=> "resourcependingmaintenanceactionlist-arn"

Returns:

See Also:

#undo_opt_inResourcePendingMaintenanceActionList

Examples:

Request syntax example with placeholder values


pendingmaintenanceaction.undo_opt_in()

Basic usage

resourcependingmaintenanceactionlist = pendingmaintenanceaction.undo_opt_in(options)
resourcependingmaintenanceactionlist.arn
#=> "resourcependingmaintenanceactionlist-arn"

Returns:

See Also: