repositories

Creates, updates, deletes or gets a repository resource or lists repositories in a region

Overview

Name	repositories
Type	Resource
Description	The AWS::ECR::Repository resource specifies an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR private repositories](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the *Amazon ECR User Guide*.
Id	aws.ecr.repositories

Fields

Name	Datatype	Description
empty_on_delete	boolean	If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it.
lifecycle_policy	object	Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html).
repository_name	string	The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
repository_policy_text	object	The JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*.
tags	array	An array of key-value pairs to apply to this resource.
arn	string
repository_uri	string
image_tag_mutability	string	The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
image_scanning_configuration	object	The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.
encryption_configuration	object	The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all repositories in a region.

SELECT
region,
empty_on_delete,
lifecycle_policy,
repository_name,
repository_policy_text,
tags,
arn,
repository_uri,
image_tag_mutability,
image_scanning_configuration,
encryption_configuration
FROM aws.ecr.repositories
WHERE region = 'us-east-1';

Gets all properties from an individual repository.

SELECT
region,
empty_on_delete,
lifecycle_policy,
repository_name,
repository_policy_text,
tags,
arn,
repository_uri,
image_tag_mutability,
image_scanning_configuration,
encryption_configuration
FROM aws.ecr.repositories
WHERE region = 'us-east-1' AND data__Identifier = '<RepositoryName>';

INSERT example

Use the following StackQL query and manifest file to create a new repository resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.ecr.repositories (
 EmptyOnDelete,
 LifecyclePolicy,
 RepositoryName,
 RepositoryPolicyText,
 Tags,
 ImageTagMutability,
 ImageScanningConfiguration,
 EncryptionConfiguration,
 region
)
SELECT 
'{{ EmptyOnDelete }}',
 '{{ LifecyclePolicy }}',
 '{{ RepositoryName }}',
 '{{ RepositoryPolicyText }}',
 '{{ Tags }}',
 '{{ ImageTagMutability }}',
 '{{ ImageScanningConfiguration }}',
 '{{ EncryptionConfiguration }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ecr.repositories (
 EmptyOnDelete,
 LifecyclePolicy,
 RepositoryName,
 RepositoryPolicyText,
 Tags,
 ImageTagMutability,
 ImageScanningConfiguration,
 EncryptionConfiguration,
 region
)
SELECT 
 '{{ EmptyOnDelete }}',
 '{{ LifecyclePolicy }}',
 '{{ RepositoryName }}',
 '{{ RepositoryPolicyText }}',
 '{{ Tags }}',
 '{{ ImageTagMutability }}',
 '{{ ImageScanningConfiguration }}',
 '{{ EncryptionConfiguration }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: repository
    props:
      - name: EmptyOnDelete
        value: '{{ EmptyOnDelete }}'
      - name: LifecyclePolicy
        value:
          LifecyclePolicyText: '{{ LifecyclePolicyText }}'
          RegistryId: '{{ RegistryId }}'
      - name: RepositoryName
        value: '{{ RepositoryName }}'
      - name: RepositoryPolicyText
        value: {}
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: ImageTagMutability
        value: '{{ ImageTagMutability }}'
      - name: ImageScanningConfiguration
        value:
          ScanOnPush: '{{ ScanOnPush }}'
      - name: EncryptionConfiguration
        value:
          EncryptionType: '{{ EncryptionType }}'
          KmsKey: '{{ KmsKey }}'

DELETE example

/*+ delete */
DELETE FROM aws.ecr.repositories
WHERE data__Identifier = '<RepositoryName>'
AND region = 'us-east-1';

Permissions

To operate on the repositories resource, the following permissions are required:

Create

ecr:CreateRepository,
ecr:PutLifecyclePolicy,
ecr:SetRepositoryPolicy,
ecr:TagResource,
kms:DescribeKey,
kms:CreateGrant,
kms:RetireGrant

Read

ecr:DescribeRepositories,
ecr:GetLifecyclePolicy,
ecr:GetRepositoryPolicy,
ecr:ListTagsForResource

Update

ecr:DescribeRepositories,
ecr:PutLifecyclePolicy,
ecr:SetRepositoryPolicy,
ecr:ListTagsForResource,
ecr:TagResource,
ecr:UntagResource,
ecr:DeleteLifecyclePolicy,
ecr:DeleteRepositoryPolicy,
ecr:PutImageScanningConfiguration,
ecr:PutImageTagMutability,
kms:DescribeKey,
kms:CreateGrant,
kms:RetireGrant

Delete

ecr:DeleteRepository,
kms:RetireGrant

List

ecr:DescribeRepositories