Metadata-Version: 2.1
Name: aws-cdk.aws-ecr
Version: 1.98.0
Summary: The CDK Construct Library for AWS::ECR
Home-page: https://github.com/aws/aws-cdk
Author: Amazon Web Services
License: Apache-2.0
Project-URL: Source, https://github.com/aws/aws-cdk.git
Description: # Amazon ECR Construct Library
        
        <!--BEGIN STABILITY BANNER-->---
        
        
        ![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)
        
        ![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge)
        
        ---
        <!--END STABILITY BANNER-->
        
        This package contains constructs for working with Amazon Elastic Container Registry.
        
        ## Repositories
        
        Define a repository by creating a new instance of `Repository`. A repository
        holds multiple verions of a single container image.
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        repository = ecr.Repository(self, "Repository")
        ```
        
        ## Image scanning
        
        Amazon ECR image scanning helps in identifying software vulnerabilities in your container images. You can manually scan container images stored in Amazon ECR, or you can configure your repositories to scan images when you push them to a repository. To create a new repository to scan on push, simply enable `imageScanOnPush` in the properties
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        repository = ecr.Repository(stack, "Repo",
            image_scan_on_push=True
        )
        ```
        
        To create an `onImageScanCompleted` event rule and trigger the event target
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        repository.on_image_scan_completed("ImageScanComplete").add_target(...)
        ```
        
        ### Authorization Token
        
        Besides the Amazon ECR APIs, ECR also allows the Docker CLI or a language-specific Docker library to push and pull
        images from an ECR repository. However, the Docker CLI does not support native IAM authentication methods and
        additional steps must be taken so that Amazon ECR can authenticate and authorize Docker push and pull requests.
        More information can be found at at [Registry Authentication](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth).
        
        A Docker authorization token can be obtained using the `GetAuthorizationToken` ECR API. The following code snippets
        grants an IAM user access to call this API.
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        import aws_cdk.aws_iam as iam
        import aws_cdk.aws_ecr as ecr
        
        
        user = iam.User(self, "User", ...)
        ecr.AuthorizationToken.grant_read(user)
        ```
        
        If you access images in the [Public ECR Gallery](https://gallery.ecr.aws/) as well, it is recommended you authenticate to the registry to benefit from
        higher rate and bandwidth limits.
        
        > See `Pricing` in https://aws.amazon.com/blogs/aws/amazon-ecr-public-a-new-public-container-registry/ and [Service quotas](https://docs.aws.amazon.com/AmazonECR/latest/public/public-service-quotas.html).
        
        The following code snippet grants an IAM user access to retrieve an authorization token for the public gallery.
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        import aws_cdk.aws_iam as iam
        import aws_cdk.aws_ecr as ecr
        
        
        user = iam.User(self, "User", ...)
        ecr.PublicGalleryAuthorizationToken.grant_read(user)
        ```
        
        This user can then proceed to login to the registry using one of the [authentication methods](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth).
        
        ### Image tag immutability
        
        You can set tag immutability on images in our repository using the `imageTagMutability` construct prop.
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        ecr.Repository(stack, "Repo", image_tag_mutability=ecr.TagMutability.IMMUTABLE)
        ```
        
        ## Automatically clean up repositories
        
        You can set life cycle rules to automatically clean up old images from your
        repository. The first life cycle rule that matches an image will be applied
        against that image. For example, the following deletes images older than
        30 days, while keeping all images tagged with prod (note that the order
        is important here):
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        repository.add_lifecycle_rule(tag_prefix_list=["prod"], max_image_count=9999)
        repository.add_lifecycle_rule(max_image_age=cdk.Duration.days(30))
        ```
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Typing :: Typed
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved
Classifier: Framework :: AWS CDK
Classifier: Framework :: AWS CDK :: 1
Requires-Python: >=3.6
Description-Content-Type: text/markdown
