AWS CDK Reference

Appearance

v2.273.0

RepositoryProps Struct ​

Source
aws-ecr/lib/repository.ts
Type last changed
v2.224.0 · 13 Nov 2025

Example ​

ts
const repository = new ecr.Repository(this, "TestRepository", {
  repositoryName: "test-agent-runtime",
});
const agentRuntimeArtifact = agentcore.AgentRuntimeArtifact.fromEcrRepository(repository, "v1.0.0");

// Explicitly using public network (this is the default)
const runtime = new agentcore.Runtime(this, "MyAgentRuntime", {
  runtimeName: "myAgent",
  agentRuntimeArtifact: agentRuntimeArtifact,
  networkConfiguration: agentcore.RuntimeNetworkConfiguration.usingPublicNetwork(),
});

Properties ​

autoDeleteImagesbooleanauto_delete_imagesboolautoDeleteImagesBooleanAutoDeleteImagesboolAutoDeleteImages*bool= falsedeprecated#
Use `emptyOnDelete` instead.

Requires the removalPolicy to be set to RemovalPolicy.DESTROY.

emptyOnDeletebooleanempty_on_deleteboolemptyOnDeleteBooleanEmptyOnDeleteboolEmptyOnDelete*bool= 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.

encryptionRepositoryEncryptionencryptionRepositoryEncryptionencryptionRepositoryEncryptionEncryptionRepositoryEncryptionEncryptionRepositoryEncryption= `KMS` if `encryptionKey` is spec…#
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

Default: KMS if encryptionKey is specified, or AES256 otherwise.

encryptionKeyIKeyRefencryption_keyIKeyRefencryptionKeyIKeyRefEncryptionKeyIKeyRefEncryptionKeyIKeyRef= If encryption is set to `KMS` an…#
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

Default: If encryption is set to KMS and this property is undefined, an AWS managed KMS key is used.

imageScanOnPushbooleanimage_scan_on_pushboolimageScanOnPushBooleanImageScanOnPushboolImageScanOnPush*bool= false#
Enable the scan on push when creating the repository.
imageTagMutabilityTagMutabilityimage_tag_mutabilityTagMutabilityimageTagMutabilityTagMutabilityImageTagMutabilityTagMutabilityImageTagMutabilityTagMutability= 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.

imageTagMutabilityExclusionFiltersImageTagMutabilityExclusionFilter[]image_tag_mutability_exclusion_filterstyping.List[ImageTagMutabilityExclusionFilter]imageTagMutabilityExclusionFiltersList<ImageTagMutabilityExclusionFilter>ImageTagMutabilityExclusionFiltersImageTagMutabilityExclusionFilter[]ImageTagMutabilityExclusionFilters*[]ImageTagMutabilityExclusionFilter= undefined - AWS ECR default is n…#
The image tag mutability exclusion filters for the repository.

These filters specify which image tags can override the repository's default image tag mutability setting.

default

Default: undefined - AWS ECR default is no exclusion filters

lifecycleRegistryIdstringlifecycle_registry_idstrlifecycleRegistryIdStringLifecycleRegistryIdstringLifecycleRegistryId*string= The default registry is assumed.#
The AWS account ID associated with the registry that contains the repository.
lifecycleRulesLifecycleRule[]lifecycle_rulestyping.List[LifecycleRule]lifecycleRulesList<LifecycleRule>LifecycleRulesLifecycleRule[]LifecycleRules*[]LifecycleRule= No life cycle rules#
Life cycle rules to apply to this registry.
removalPolicyRemovalPolicyremoval_policyRemovalPolicyremovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicy= RemovalPolicy.Retain#
Determine what happens to the repository when the resource/stack is deleted.
repositoryNamestringrepository_namestrrepositoryNameStringRepositoryNamestringRepositoryName*string= Automatically generated name.#
Name for this repository.
notes

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.

Used as props by ​