aws-cdk-lib 2.115.0__py3-none-any.whl → 2.116.1__py3-none-any.whl

aws_cdk/aws_ecr/__init__.py

@@ -176,6 +176,15 @@ repository.add_lifecycle_rule(tag_prefix_list=["prod"], max_image_count=9999)
 repository.add_lifecycle_rule(max_image_age=Duration.days(30))
 ```
 
+When using `tagPatternList`, an image is successfully matched if it matches
+the wildcard filter.
+
+```python
+# repository: ecr.Repository
+
+repository.add_lifecycle_rule(tag_pattern_list=["prod*"], max_image_count=9999)
+```
+
 ### Repository deletion
 
 When a repository is removed from a stack (or the stack is deleted), the ECR
@@ -185,12 +194,13 @@ policy is set to `RemovalPolicy.DESTROY`, the repository will be deleted as long
 as it does not contain any images.
 
 To override this and force all images to get deleted during repository deletion,
-enable the`autoDeleteImages` option.
+enable the `emptyOnDelete` option as well as setting the removal policy to
+`RemovalPolicy.DESTROY`.
 
 ```python
 repository = ecr.Repository(self, "MyTempRepo",
     removal_policy=RemovalPolicy.DESTROY,
-    auto_delete_images=True
+    empty_on_delete=True
 )
 ```
 
@@ -2871,6 +2881,7 @@ typing.cast(typing.Any, IRepository).__jsii_proxy_class__ = lambda : _IRepositor
         "max_image_age": "maxImageAge",
         "max_image_count": "maxImageCount",
         "rule_priority": "rulePriority",
+        "tag_pattern_list": "tagPatternList",
         "tag_prefix_list": "tagPrefixList",
         "tag_status": "tagStatus",
     },
@@ -2883,6 +2894,7 @@ class LifecycleRule:
         max_image_age: typing.Optional[_Duration_4839e8c3] = None,
         max_image_count: typing.Optional[jsii.Number] = None,
         rule_priority: typing.Optional[jsii.Number] = None,
+        tag_pattern_list: typing.Optional[typing.Sequence[builtins.str]] = None,
         tag_prefix_list: typing.Optional[typing.Sequence[builtins.str]] = None,
         tag_status: typing.Optional["TagStatus"] = None,
     ) -> None:
@@ -2892,8 +2904,9 @@ class LifecycleRule:
         :param max_image_age: The maximum age of images to retain. The value must represent a number of days. Specify exactly one of maxImageCount and maxImageAge.
         :param max_image_count: The maximum number of images to retain. Specify exactly one of maxImageCount and maxImageAge.
         :param rule_priority: Controls the order in which rules are evaluated (low to high). All rules must have a unique priority, where lower numbers have higher precedence. The first rule that matches is applied to an image. There can only be one rule with a tagStatus of Any, and it must have the highest rulePriority. All rules without a specified priority will have incrementing priorities automatically assigned to them, higher than any rules that DO have priorities. Default: Automatically assigned
-        :param tag_prefix_list: Select images that have ALL the given prefixes in their tag. Only if tagStatus == TagStatus.Tagged
-        :param tag_status: Select images based on tags. Only one rule is allowed to select untagged images, and it must have the highest rulePriority. Default: TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise
+        :param tag_pattern_list: Select images that have ALL the given patterns in their tag. There is a maximum limit of four wildcards (*) per string. For example, ["*test*1*2*3", "test*1*2*3*"] is valid but ["test*1*2*3*4*5*6"] is invalid. Both tagPrefixList and tagPatternList cannot be specified together in a rule. Only if tagStatus == TagStatus.Tagged
+        :param tag_prefix_list: Select images that have ALL the given prefixes in their tag. Both tagPrefixList and tagPatternList cannot be specified together in a rule. Only if tagStatus == TagStatus.Tagged
+        :param tag_status: Select images based on tags. Only one rule is allowed to select untagged images, and it must have the highest rulePriority. Default: TagStatus.Tagged if tagPrefixList or tagPatternList is given, TagStatus.Any otherwise
 
         :exampleMetadata: infused
 
@@ -2910,6 +2923,7 @@ class LifecycleRule:
             check_type(argname="argument max_image_age", value=max_image_age, expected_type=type_hints["max_image_age"])
             check_type(argname="argument max_image_count", value=max_image_count, expected_type=type_hints["max_image_count"])
             check_type(argname="argument rule_priority", value=rule_priority, expected_type=type_hints["rule_priority"])
+            check_type(argname="argument tag_pattern_list", value=tag_pattern_list, expected_type=type_hints["tag_pattern_list"])
             check_type(argname="argument tag_prefix_list", value=tag_prefix_list, expected_type=type_hints["tag_prefix_list"])
             check_type(argname="argument tag_status", value=tag_status, expected_type=type_hints["tag_status"])
         self._values: typing.Dict[builtins.str, typing.Any] = {}
@@ -2921,6 +2935,8 @@ class LifecycleRule:
             self._values["max_image_count"] = max_image_count
         if rule_priority is not None:
             self._values["rule_priority"] = rule_priority
+        if tag_pattern_list is not None:
+            self._values["tag_pattern_list"] = tag_pattern_list
         if tag_prefix_list is not None:
             self._values["tag_prefix_list"] = tag_prefix_list
         if tag_status is not None:
@@ -2971,10 +2987,29 @@ class LifecycleRule:
         result = self._values.get("rule_priority")
         return typing.cast(typing.Optional[jsii.Number], result)
 
+    @builtins.property
+    def tag_pattern_list(self) -> typing.Optional[typing.List[builtins.str]]:
+        '''Select images that have ALL the given patterns in their tag.
+
+        There is a maximum limit of four wildcards (*) per string.
+        For example, ["*test*1*2*3", "test*1*2*3*"] is valid but
+        ["test*1*2*3*4*5*6"] is invalid.
+
+        Both tagPrefixList and tagPatternList cannot be specified
+        together in a rule.
+
+        Only if tagStatus == TagStatus.Tagged
+        '''
+        result = self._values.get("tag_pattern_list")
+        return typing.cast(typing.Optional[typing.List[builtins.str]], result)
+
     @builtins.property
     def tag_prefix_list(self) -> typing.Optional[typing.List[builtins.str]]:
         '''Select images that have ALL the given prefixes in their tag.
 
+        Both tagPrefixList and tagPatternList cannot be specified
+        together in a rule.
+
         Only if tagStatus == TagStatus.Tagged
         '''
         result = self._values.get("tag_prefix_list")
@@ -2987,7 +3022,10 @@ class LifecycleRule:
         Only one rule is allowed to select untagged images, and it must
         have the highest rulePriority.
 
-        :default: TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise
+        :default:
+
+        TagStatus.Tagged if tagPrefixList or tagPatternList is
+        given, TagStatus.Any otherwise
         '''
         result = self._values.get("tag_status")
         return typing.cast(typing.Optional["TagStatus"], result)
@@ -3847,6 +3885,7 @@ class RepositoryEncryption(
     jsii_struct_bases=[],
     name_mapping={
         "auto_delete_images": "autoDeleteImages",
+        "empty_on_delete": "emptyOnDelete",
         "encryption": "encryption",
         "encryption_key": "encryptionKey",
         "image_scan_on_push": "imageScanOnPush",
@@ -3862,6 +3901,7 @@ class RepositoryProps:
         self,
         *,
         auto_delete_images: typing.Optional[builtins.bool] = None,
+        empty_on_delete: typing.Optional[builtins.bool] = None,
         encryption: typing.Optional[RepositoryEncryption] = None,
         encryption_key: typing.Optional[_IKey_5f11635f] = None,
         image_scan_on_push: typing.Optional[builtins.bool] = None,
@@ -3872,7 +3912,8 @@ class RepositoryProps:
         repository_name: typing.Optional[builtins.str] = None,
     ) -> None:
         '''
-        :param auto_delete_images: Whether all images should be automatically deleted when the repository is removed from the stack or when the stack is deleted. Requires the ``removalPolicy`` to be set to ``RemovalPolicy.DESTROY``. Default: false
+        :param auto_delete_images: (deprecated) Whether all images should be automatically deleted when the repository is removed from the stack or when the stack is deleted. Requires the ``removalPolicy`` to be set to ``RemovalPolicy.DESTROY``. Default: false
+        :param empty_on_delete: If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it. Default: false
         :param encryption: The kind of server-side encryption to apply to this repository. If you choose KMS, you can specify a KMS key via ``encryptionKey``. If encryptionKey is not specified, an AWS managed KMS key is used. Default: - ``KMS`` if ``encryptionKey`` is specified, or ``AES256`` otherwise.
         :param encryption_key: External KMS key to use for repository encryption. The 'encryption' property must be either not specified or set to "KMS". An error will be emitted if encryption is set to "AES256". Default: - If encryption is set to ``KMS`` and this property is undefined, an AWS managed KMS key is used.
         :param image_scan_on_push: Enable the scan on push when creating the repository. Default: false
@@ -3891,6 +3932,7 @@ class RepositoryProps:
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__638b63dd5eb589e01019ee47c63d6335810d02b0d769f767f2bf2fddc285af28)
             check_type(argname="argument auto_delete_images", value=auto_delete_images, expected_type=type_hints["auto_delete_images"])
+            check_type(argname="argument empty_on_delete", value=empty_on_delete, expected_type=type_hints["empty_on_delete"])
             check_type(argname="argument encryption", value=encryption, expected_type=type_hints["encryption"])
             check_type(argname="argument encryption_key", value=encryption_key, expected_type=type_hints["encryption_key"])
             check_type(argname="argument image_scan_on_push", value=image_scan_on_push, expected_type=type_hints["image_scan_on_push"])
@@ -3902,6 +3944,8 @@ class RepositoryProps:
         self._values: typing.Dict[builtins.str, typing.Any] = {}
         if auto_delete_images is not None:
             self._values["auto_delete_images"] = auto_delete_images
+        if empty_on_delete is not None:
+            self._values["empty_on_delete"] = empty_on_delete
         if encryption is not None:
             self._values["encryption"] = encryption
         if encryption_key is not None:
@@ -3921,15 +3965,30 @@ class RepositoryProps:
 
     @builtins.property
     def auto_delete_images(self) -> typing.Optional[builtins.bool]:
-        '''Whether all images should be automatically deleted when the repository is removed from the stack or when the stack is deleted.
+        '''(deprecated) Whether all images should be automatically deleted when the repository is removed from the stack or when the stack is deleted.
 
         Requires the ``removalPolicy`` to be set to ``RemovalPolicy.DESTROY``.
 
         :default: false
+
+        :deprecated: Use ``emptyOnDelete`` instead.
+
+        :stability: deprecated
         '''
         result = self._values.get("auto_delete_images")
         return typing.cast(typing.Optional[builtins.bool], result)
 
+    @builtins.property
+    def empty_on_delete(self) -> typing.Optional[builtins.bool]:
+        '''If true, deleting the repository force deletes the contents of the repository.
+
+        If false, the repository must be empty before attempting to delete it.
+
+        :default: false
+        '''
+        result = self._values.get("empty_on_delete")
+        return typing.cast(typing.Optional[builtins.bool], result)
+
     @builtins.property
     def encryption(self) -> typing.Optional[RepositoryEncryption]:
         '''The kind of server-side encryption to apply to this repository.
@@ -4090,6 +4149,7 @@ class Repository(
         id: builtins.str,
         *,
         auto_delete_images: typing.Optional[builtins.bool] = None,
+        empty_on_delete: typing.Optional[builtins.bool] = None,
         encryption: typing.Optional[RepositoryEncryption] = None,
         encryption_key: typing.Optional[_IKey_5f11635f] = None,
         image_scan_on_push: typing.Optional[builtins.bool] = None,
@@ -4102,7 +4162,8 @@ class Repository(
         '''
         :param scope: -
         :param id: -
-        :param auto_delete_images: Whether all images should be automatically deleted when the repository is removed from the stack or when the stack is deleted. Requires the ``removalPolicy`` to be set to ``RemovalPolicy.DESTROY``. Default: false
+        :param auto_delete_images: (deprecated) Whether all images should be automatically deleted when the repository is removed from the stack or when the stack is deleted. Requires the ``removalPolicy`` to be set to ``RemovalPolicy.DESTROY``. Default: false
+        :param empty_on_delete: If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it. Default: false
         :param encryption: The kind of server-side encryption to apply to this repository. If you choose KMS, you can specify a KMS key via ``encryptionKey``. If encryptionKey is not specified, an AWS managed KMS key is used. Default: - ``KMS`` if ``encryptionKey`` is specified, or ``AES256`` otherwise.
         :param encryption_key: External KMS key to use for repository encryption. The 'encryption' property must be either not specified or set to "KMS". An error will be emitted if encryption is set to "AES256". Default: - If encryption is set to ``KMS`` and this property is undefined, an AWS managed KMS key is used.
         :param image_scan_on_push: Enable the scan on push when creating the repository. Default: false
@@ -4118,6 +4179,7 @@ class Repository(
             check_type(argname="argument id", value=id, expected_type=type_hints["id"])
         props = RepositoryProps(
             auto_delete_images=auto_delete_images,
+            empty_on_delete=empty_on_delete,
             encryption=encryption,
             encryption_key=encryption_key,
             image_scan_on_push=image_scan_on_push,
@@ -4226,6 +4288,7 @@ class Repository(
         max_image_age: typing.Optional[_Duration_4839e8c3] = None,
         max_image_count: typing.Optional[jsii.Number] = None,
         rule_priority: typing.Optional[jsii.Number] = None,
+        tag_pattern_list: typing.Optional[typing.Sequence[builtins.str]] = None,
         tag_prefix_list: typing.Optional[typing.Sequence[builtins.str]] = None,
         tag_status: typing.Optional[TagStatus] = None,
     ) -> None:
@@ -4238,14 +4301,16 @@ class Repository(
         :param max_image_age: The maximum age of images to retain. The value must represent a number of days. Specify exactly one of maxImageCount and maxImageAge.
         :param max_image_count: The maximum number of images to retain. Specify exactly one of maxImageCount and maxImageAge.
         :param rule_priority: Controls the order in which rules are evaluated (low to high). All rules must have a unique priority, where lower numbers have higher precedence. The first rule that matches is applied to an image. There can only be one rule with a tagStatus of Any, and it must have the highest rulePriority. All rules without a specified priority will have incrementing priorities automatically assigned to them, higher than any rules that DO have priorities. Default: Automatically assigned
-        :param tag_prefix_list: Select images that have ALL the given prefixes in their tag. Only if tagStatus == TagStatus.Tagged
-        :param tag_status: Select images based on tags. Only one rule is allowed to select untagged images, and it must have the highest rulePriority. Default: TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise
+        :param tag_pattern_list: Select images that have ALL the given patterns in their tag. There is a maximum limit of four wildcards (*) per string. For example, ["*test*1*2*3", "test*1*2*3*"] is valid but ["test*1*2*3*4*5*6"] is invalid. Both tagPrefixList and tagPatternList cannot be specified together in a rule. Only if tagStatus == TagStatus.Tagged
+        :param tag_prefix_list: Select images that have ALL the given prefixes in their tag. Both tagPrefixList and tagPatternList cannot be specified together in a rule. Only if tagStatus == TagStatus.Tagged
+        :param tag_status: Select images based on tags. Only one rule is allowed to select untagged images, and it must have the highest rulePriority. Default: TagStatus.Tagged if tagPrefixList or tagPatternList is given, TagStatus.Any otherwise
         '''
         rule = LifecycleRule(
             description=description,
             max_image_age=max_image_age,
             max_image_count=max_image_count,
             rule_priority=rule_priority,
+            tag_pattern_list=tag_pattern_list,
             tag_prefix_list=tag_prefix_list,
             tag_status=tag_status,
         )
@@ -4767,6 +4832,7 @@ def _typecheckingstub__daefc01ac58c056180e96357fa989faf5de713c6f5bd46bb023e2579b
     max_image_age: typing.Optional[_Duration_4839e8c3] = None,
     max_image_count: typing.Optional[jsii.Number] = None,
     rule_priority: typing.Optional[jsii.Number] = None,
+    tag_pattern_list: typing.Optional[typing.Sequence[builtins.str]] = None,
     tag_prefix_list: typing.Optional[typing.Sequence[builtins.str]] = None,
     tag_status: typing.Optional[TagStatus] = None,
 ) -> None:
@@ -4937,6 +5003,7 @@ def _typecheckingstub__144b557444508fc0a954f4a654cd03105778da2972bab34f799be4e54
 def _typecheckingstub__638b63dd5eb589e01019ee47c63d6335810d02b0d769f767f2bf2fddc285af28(
     *,
     auto_delete_images: typing.Optional[builtins.bool] = None,
+    empty_on_delete: typing.Optional[builtins.bool] = None,
     encryption: typing.Optional[RepositoryEncryption] = None,
     encryption_key: typing.Optional[_IKey_5f11635f] = None,
     image_scan_on_push: typing.Optional[builtins.bool] = None,
@@ -4954,6 +5021,7 @@ def _typecheckingstub__0fcb489ea7ac91914ff0429ef13d64f8bd29978872d9ce4754ee9d397
     id: builtins.str,
     *,
     auto_delete_images: typing.Optional[builtins.bool] = None,
+    empty_on_delete: typing.Optional[builtins.bool] = None,
     encryption: typing.Optional[RepositoryEncryption] = None,
     encryption_key: typing.Optional[_IKey_5f11635f] = None,
     image_scan_on_push: typing.Optional[builtins.bool] = None,