interface RepositoryProps

Language	Type name
.NET	Amazon.CDK.AWS.ECR.RepositoryProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsecr#RepositoryProps
Java	software.amazon.awscdk.services.ecr.RepositoryProps
Python	aws_cdk.aws_ecr.RepositoryProps
TypeScript (source)	aws-cdk-lib » aws_ecr » RepositoryProps

Example

new ecr.Repository(this, 'Repo', { imageTagMutability: ecr.TagMutability.IMMUTABLE });

Properties

Name	Type	Description
autoDeleteImages?⚠️	boolean	Whether all images should be automatically deleted when the repository is removed from the stack or when the stack is deleted.
emptyOnDelete?	boolean	If true, deleting the repository force deletes the contents of the repository.
encryption?	RepositoryEncryption	The kind of server-side encryption to apply to this repository.
encryptionKey?	IKey	External KMS key to use for repository encryption.
imageScanOnPush?	boolean	Enable the scan on push when creating the repository.
imageTagMutability?	TagMutability	The tag mutability setting for the repository.
lifecycleRegistryId?	string	The AWS account ID associated with the registry that contains the repository.
lifecycleRules?	LifecycleRule[]	Life cycle rules to apply to this registry.
removalPolicy?	RemovalPolicy	Determine what happens to the repository when the resource/stack is deleted.
repositoryName?	string	Name for this repository.

---

autoDeleteImages?⚠️

⚠️ Deprecated: Use emptyOnDelete instead.

Type: boolean (optional, default: false)

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.

---

emptyOnDelete?

Type: boolean (optional, default: false)

If true, deleting the repository force deletes the contents of the repository.

If false, the repository must be empty before attempting to delete it.

---

encryption?

Type: RepositoryEncryption (optional, default: KMS if encryptionKey is specified, or AES256 otherwise.)

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.

---

encryptionKey?

Type: IKey (optional, default: If encryption is set to KMS and this property is undefined, an AWS managed KMS key is used.)

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".

---

imageScanOnPush?

Type: boolean (optional, default: false)

Enable the scan on push when creating the repository.

---

imageTagMutability?

Type: TagMutability (optional, default: TagMutability.MUTABLE)

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.

---

lifecycleRegistryId?

Type: string (optional, default: The default registry is assumed.)

The AWS account ID associated with the registry that contains the repository.

See also: https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html

---

lifecycleRules?

Type: LifecycleRule[] (optional, default: No life cycle rules)

Life cycle rules to apply to this registry.

---

removalPolicy?

Type: RemovalPolicy (optional, default: RemovalPolicy.Retain)

Determine what happens to the repository when the resource/stack is deleted.

---

repositoryName?

Type: string (optional, default: Automatically generated name.)

Name for this repository.

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.