Skip to content

UpdateRuleRequest

Source code in docs_src/capo_rbin/types/update_rule_request.py
class UpdateRuleRequest(TypedDict, closed=True):
    identifier: "capo_rbin.types.rule_identifier.RuleIdentifier"
    """<p>The unique ID of the retention rule.</p>"""
    retention_period: NotRequired["capo_rbin.types.retention_period.RetentionPeriod"]
    """<p>Information about the retention period for which the retention rule is to retain resources.</p>"""
    description: NotRequired["capo_rbin.types.description.Description"]
    """<p>The retention rule description.</p>"""
    resource_type: NotRequired["capo_rbin.types.resource_type.ResourceType"]
    """<note> <p>This parameter is currently not supported. You can't update a retention rule's resource type after creation.</p> </note>"""
    resource_tags: NotRequired["capo_rbin.types.resource_tags.ResourceTags"]
    """<p>[Tag-level retention rules only] 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.</p> <p>You can add the same tag key and value pair to a maximum or five retention rules.</p> <p>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.</p>"""
    exclude_resource_tags: NotRequired[
        "capo_rbin.types.exclude_resource_tags.ExcludeResourceTags"
    ]
    """<p>[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule. Resources that have any of these tags are not retained by the retention rule upon deletion.</p> <p>You can't specify exclusion tags for tag-level retention rules.</p>"""

description instance-attribute

description: NotRequired[Description]

The retention rule description.

exclude_resource_tags instance-attribute

exclude_resource_tags: NotRequired[ExcludeResourceTags]

[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule. Resources that have any of these tags are not retained by the retention rule upon deletion.

You can't specify exclusion tags for tag-level retention rules.

identifier instance-attribute

identifier: RuleIdentifier

The unique ID of the retention rule.

resource_tags instance-attribute

resource_tags: NotRequired[ResourceTags]

[Tag-level retention rules only] 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.

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

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

retention_period instance-attribute

retention_period: NotRequired[RetentionPeriod]

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