Skip to content

/AWS1/CL_RBN=>UPDATERULE()

About UpdateRule

Updates an existing Recycle Bin retention rule. You can update a retention rule's description, resource tags, and retention period at any time after creation. You can't update a retention rule's resource type after creation. For more information, see Update Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

Method Signature

IMPORTING

Required arguments:

IV_IDENTIFIER TYPE /AWS1/RBNRULEIDENTIFIER /AWS1/RBNRULEIDENTIFIER

The unique ID of the retention rule.

Optional arguments:

IO_RETENTIONPERIOD TYPE REF TO /AWS1/CL_RBNRETENTIONPERIOD /AWS1/CL_RBNRETENTIONPERIOD

Information about the retention period for which the retention rule is to retain resources.

IV_DESCRIPTION TYPE /AWS1/RBNDESCRIPTION /AWS1/RBNDESCRIPTION

The retention rule description.

IV_RESOURCETYPE TYPE /AWS1/RBNRESOURCETYPE /AWS1/RBNRESOURCETYPE

This parameter is currently not supported. You can't update a retention rule's resource type after creation.

IT_RESOURCETAGS TYPE /AWS1/CL_RBNRESOURCETAG=>TT_RESOURCETAGS TT_RESOURCETAGS

Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_RBNUPDATERULERESPONSE /AWS1/CL_RBNUPDATERULERESPONSE