aws-cdk-lib 2.171.1__py3-none-any.whl → 2.173.0__py3-none-any.whl

aws_cdk/aws_rbin/__init__.py

@@ -85,7 +85,12 @@ class CfnRule(
     metaclass=jsii.JSIIMeta,
     jsii_type="aws-cdk-lib.aws_rbin.CfnRule",
 ):
-    '''Resource Type definition for AWS::Rbin::Rule.
+    '''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 <https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin.html>`_ in the *Amazon EBS User Guide* .
 
     :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html
     :cloudformationResource: AWS::Rbin::Rule
@@ -144,12 +149,12 @@ class CfnRule(
         :param scope: Scope in which this resource is defined.
         :param id: Construct identifier for this resource (unique in its scope).
         :param resource_type: The resource type retained by the retention rule.
-        :param retention_period: The retention period of the rule.
-        :param description: The description of the retention rule.
+        :param retention_period: Information about the retention period for which the retention rule is to retain resources.
+        :param description: The retention rule description.
         :param exclude_resource_tags: Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
-        :param lock_configuration: 
-        :param resource_tags: Information about the resource tags used to identify resources that are retained by the retention rule.
-        :param status: The state of the retention rule. Only retention rules that are in the available state retain resources.
+        :param lock_configuration: Information about the retention rule lock configuration.
+        :param resource_tags: [Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.
+        :param status: The state of the retention rule. Only retention rules that are in the ``available`` state retain resources.
         :param tags: Information about the tags assigned to the retention rule.
         '''
         if __debug__:
@@ -202,7 +207,7 @@ class CfnRule(
     @builtins.property
     @jsii.member(jsii_name="attrArn")
     def attr_arn(self) -> builtins.str:
-        '''Rule Arn is unique for each rule.
+        '''The Amazon Resource Name (ARN) of the retention rule.
 
         :cloudformationAttribute: Arn
         '''
@@ -220,7 +225,12 @@ class CfnRule(
     @builtins.property
     @jsii.member(jsii_name="attrLockState")
     def attr_lock_state(self) -> builtins.str:
-        '''The lock state for the retention rule.
+        '''[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`` .
 
         :cloudformationAttribute: LockState
         '''
@@ -255,7 +265,7 @@ class CfnRule(
     def retention_period(
         self,
     ) -> typing.Union[_IResolvable_da3f097b, "CfnRule.RetentionPeriodProperty"]:
-        '''The retention period of the rule.'''
+        '''Information about the retention period for which the retention rule is to retain resources.'''
         return typing.cast(typing.Union[_IResolvable_da3f097b, "CfnRule.RetentionPeriodProperty"], jsii.get(self, "retentionPeriod"))
 
     @retention_period.setter
@@ -271,7 +281,7 @@ class CfnRule(
     @builtins.property
     @jsii.member(jsii_name="description")
     def description(self) -> typing.Optional[builtins.str]:
-        '''The description of the retention rule.'''
+        '''The retention rule description.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
 
     @description.setter
@@ -304,6 +314,7 @@ class CfnRule(
     def lock_configuration(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnRule.UnlockDelayProperty"]]:
+        '''Information about the retention rule lock configuration.'''
         return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnRule.UnlockDelayProperty"]], jsii.get(self, "lockConfiguration"))
 
     @lock_configuration.setter
@@ -321,7 +332,7 @@ class CfnRule(
     def resource_tags(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnRule.ResourceTagProperty"]]]]:
-        '''Information about the resource tags used to identify resources that are retained by the retention rule.'''
+        '''[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.'''
         return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnRule.ResourceTagProperty"]]]], jsii.get(self, "resourceTags"))
 
     @resource_tags.setter
@@ -375,10 +386,10 @@ class CfnRule(
             resource_tag_key: builtins.str,
             resource_tag_value: builtins.str,
         ) -> None:
-            '''The resource tag of the rule.
+            '''[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.
 
-            :param resource_tag_key: The tag key of the resource.
-            :param resource_tag_value: The tag value of the resource.
+            :param resource_tag_key: The tag key.
+            :param resource_tag_value: The tag value.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-resourcetag.html
             :exampleMetadata: fixture=_generated
@@ -405,7 +416,7 @@ class CfnRule(
 
         @builtins.property
         def resource_tag_key(self) -> builtins.str:
-            '''The tag key of the resource.
+            '''The tag key.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-resourcetag.html#cfn-rbin-rule-resourcetag-resourcetagkey
             '''
@@ -415,7 +426,7 @@ class CfnRule(
 
         @builtins.property
         def resource_tag_value(self) -> builtins.str:
-            '''The tag value of the resource.
+            '''The tag value.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-resourcetag.html#cfn-rbin-rule-resourcetag-resourcetagvalue
             '''
@@ -449,10 +460,10 @@ class CfnRule(
             retention_period_unit: builtins.str,
             retention_period_value: jsii.Number,
         ) -> None:
-            '''The retention period of the rule.
+            '''Information about the retention period for which the retention rule is to retain resources.
 
-            :param retention_period_unit: The retention period unit of the rule.
-            :param retention_period_value: The retention period value of the rule.
+            :param retention_period_unit: The unit of time in which the retention period is measured. Currently, only ``DAYS`` is supported.
+            :param retention_period_value: The period value for which the retention rule is to retain resources. The period is measured using the unit specified for *RetentionPeriodUnit* .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-retentionperiod.html
             :exampleMetadata: fixture=_generated
@@ -479,7 +490,9 @@ class CfnRule(
 
         @builtins.property
         def retention_period_unit(self) -> builtins.str:
-            '''The retention period unit of the rule.
+            '''The unit of time in which the retention period is measured.
+
+            Currently, only ``DAYS`` is supported.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-retentionperiod.html#cfn-rbin-rule-retentionperiod-retentionperiodunit
             '''
@@ -489,7 +502,9 @@ class CfnRule(
 
         @builtins.property
         def retention_period_value(self) -> jsii.Number:
-            '''The retention period value of the rule.
+            '''The period value for which the retention rule is to retain resources.
+
+            The period is measured using the unit specified for *RetentionPeriodUnit* .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-retentionperiod.html#cfn-rbin-rule-retentionperiod-retentionperiodvalue
             '''
@@ -523,9 +538,12 @@ class CfnRule(
             unlock_delay_unit: typing.Optional[builtins.str] = None,
             unlock_delay_value: typing.Optional[jsii.Number] = None,
         ) -> None:
-            '''
+            '''Information about the retention rule unlock delay.
+
+            The unlock delay is the period after which a retention rule can be modified or edited after it has been unlocked by a user with the required permissions. The retention rule can't be modified or deleted during the unlock delay.
+
             :param unlock_delay_unit: The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.
-            :param unlock_delay_value: The unlock delay period, measured in the unit specified for UnlockDelayUnit.
+            :param unlock_delay_value: The unlock delay period, measured in the unit specified for *UnlockDelayUnit* .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-unlockdelay.html
             :exampleMetadata: fixture=_generated
@@ -564,7 +582,7 @@ class CfnRule(
 
         @builtins.property
         def unlock_delay_value(self) -> typing.Optional[jsii.Number]:
-            '''The unlock delay period, measured in the unit specified for UnlockDelayUnit.
+            '''The unlock delay period, measured in the unit specified for *UnlockDelayUnit* .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-unlockdelay.html#cfn-rbin-rule-unlockdelay-unlockdelayvalue
             '''
@@ -613,12 +631,12 @@ class CfnRuleProps:
         '''Properties for defining a ``CfnRule``.
 
         :param resource_type: The resource type retained by the retention rule.
-        :param retention_period: The retention period of the rule.
-        :param description: The description of the retention rule.
+        :param retention_period: Information about the retention period for which the retention rule is to retain resources.
+        :param description: The retention rule description.
         :param exclude_resource_tags: Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
-        :param lock_configuration: 
-        :param resource_tags: Information about the resource tags used to identify resources that are retained by the retention rule.
-        :param status: The state of the retention rule. Only retention rules that are in the available state retain resources.
+        :param lock_configuration: Information about the retention rule lock configuration.
+        :param resource_tags: [Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.
+        :param status: The state of the retention rule. Only retention rules that are in the ``available`` state retain resources.
         :param tags: Information about the tags assigned to the retention rule.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html
@@ -699,7 +717,7 @@ class CfnRuleProps:
     def retention_period(
         self,
     ) -> typing.Union[_IResolvable_da3f097b, CfnRule.RetentionPeriodProperty]:
-        '''The retention period of the rule.
+        '''Information about the retention period for which the retention rule is to retain resources.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-retentionperiod
         '''
@@ -709,7 +727,7 @@ class CfnRuleProps:
 
     @builtins.property
     def description(self) -> typing.Optional[builtins.str]:
-        '''The description of the retention rule.
+        '''The retention rule description.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-description
         '''
@@ -731,7 +749,8 @@ class CfnRuleProps:
     def lock_configuration(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnRule.UnlockDelayProperty]]:
-        '''
+        '''Information about the retention rule lock configuration.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-lockconfiguration
         '''
         result = self._values.get("lock_configuration")
@@ -741,7 +760,7 @@ class CfnRuleProps:
     def resource_tags(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnRule.ResourceTagProperty]]]]:
-        '''Information about the resource tags used to identify resources that are retained by the retention rule.
+        '''[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-resourcetags
         '''
@@ -752,7 +771,7 @@ class CfnRuleProps:
     def status(self) -> typing.Optional[builtins.str]:
         '''The state of the retention rule.
 
-        Only retention rules that are in the available state retain resources.
+        Only retention rules that are in the ``available`` state retain resources.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-status
         '''