Package software.amazon.awscdk.services.rbin

Class CfnRule

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.rbin.CfnRule
All Implemented Interfaces:
IInspectable, ITaggableV2, IRuleRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:46.761Z") @Stability(Stable) public class CfnRule extends CfnResource implements IInspectable, IRuleRef, ITaggableV2
Creates a Recycle Bin retention rule. You can create two types of retention rules:.

  • Tag-level retention rules - These retention rules use resource tags to identify the resources to protect. For each retention rule, you specify one or more tag key and value pairs. Resources (of the specified type) that have at least one of these tag key and value pairs are automatically retained in the Recycle Bin upon deletion. Use this type of retention rule to protect specific resources in your account based on their tags.
  • Region-level retention rules - These retention rules, by default, apply to all of the resources (of the specified type) in the Region, even if the resources are not tagged. However, you can specify exclusion tags to exclude resources that have specific tags. Use this type of retention rule to protect all resources of a specific type in a Region.

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.rbin.*;
 CfnRule cfnRule = CfnRule.Builder.create(this, "MyCfnRule")
         .resourceType("resourceType")
         .retentionPeriod(RetentionPeriodProperty.builder()
                 .retentionPeriodUnit("retentionPeriodUnit")
                 .retentionPeriodValue(123)
                 .build())
         // the properties below are optional
         .description("description")
         .excludeResourceTags(List.of(ResourceTagProperty.builder()
                 .resourceTagKey("resourceTagKey")
                 .resourceTagValue("resourceTagValue")
                 .build()))
         .lockConfiguration(UnlockDelayProperty.builder()
                 .unlockDelayUnit("unlockDelayUnit")
                 .unlockDelayValue(123)
                 .build())
         .resourceTags(List.of(ResourceTagProperty.builder()
                 .resourceTagKey("resourceTagKey")
                 .resourceTagValue("resourceTagValue")
                 .build()))
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRule

      protected CfnRule(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnRule

      protected CfnRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnRule

      @Stability(Stable) public CfnRule(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRuleProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the retention rule.

    • getAttrIdentifier

      @Stability(Stable) @NotNull public String getAttrIdentifier()
      The unique ID of the retention rule.

    • getAttrLockState

      @Stability(Stable) @NotNull public String getAttrLockState()
      [Region-level retention rules only] The lock state for the retention rule.

      • locked - The retention rule is locked and can't be modified or deleted.
      • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.
      • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.
      • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null .

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRuleRef

      @Stability(Stable) @NotNull public RuleReference getRuleRef()
      A reference to a Rule resource.
      Specified by:
      getRuleRef in interface IRuleRef

    • getResourceType

      @Stability(Stable) @NotNull public String getResourceType()
      The resource type to be retained by the retention rule.

    • setResourceType

      @Stability(Stable) public void setResourceType(@NotNull String value)
      The resource type to be retained by the retention rule.

    • getRetentionPeriod

      @Stability(Stable) @NotNull public Object getRetentionPeriod()
      Information about the retention period for which the retention rule is to retain resources.

      Returns union: either IResolvable or CfnRule.RetentionPeriodProperty

    • setRetentionPeriod

      @Stability(Stable) public void setRetentionPeriod(@NotNull IResolvable value)
      Information about the retention period for which the retention rule is to retain resources.

    • setRetentionPeriod

      @Stability(Stable) public void setRetentionPeriod(@NotNull CfnRule.RetentionPeriodProperty value)
      Information about the retention period for which the retention rule is to retain resources.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The retention rule description.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The retention rule description.

    • getExcludeResourceTags

      @Stability(Stable) @Nullable public Object getExcludeResourceTags()
      [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.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRule.ResourceTagProperty>

    • setExcludeResourceTags

      @Stability(Stable) public void setExcludeResourceTags(@Nullable IResolvable value)
      [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.

    • setExcludeResourceTags

      @Stability(Stable) public void setExcludeResourceTags(@Nullable List<Object> value)
      [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.

    • getLockConfiguration

      @Stability(Stable) @Nullable public Object getLockConfiguration()
      Information about the retention rule lock configuration.

      Returns union: either IResolvable or CfnRule.UnlockDelayProperty

    • setLockConfiguration

      @Stability(Stable) public void setLockConfiguration(@Nullable IResolvable value)
      Information about the retention rule lock configuration.

    • setLockConfiguration

      @Stability(Stable) public void setLockConfiguration(@Nullable CfnRule.UnlockDelayProperty value)
      Information about the retention rule lock configuration.

    • getResourceTags

      @Stability(Stable) @Nullable public Object getResourceTags()
      [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.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRule.ResourceTagProperty>

    • setResourceTags

      @Stability(Stable) public void setResourceTags(@Nullable IResolvable value)
      [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.

    • setResourceTags

      @Stability(Stable) public void setResourceTags(@Nullable List<Object> value)
      [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.

    • getStatus

      @Stability(Stable) @Nullable public String getStatus()
      The state of the retention rule.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      The state of the retention rule.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Information about the tags to assign to the retention rule.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Information about the tags to assign to the retention rule.