Package software.amazon.awscdk.services.ecr

Interface RepositoryProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
RepositoryProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:03.640Z") @Stability(Stable) public interface RepositoryProps extends software.amazon.jsii.JsiiSerializable
Example: 

 Repository repository = Repository.Builder.create(this, "TestRepository")
         .repositoryName("test-agent-runtime")
         .build();
 AgentRuntimeArtifact agentRuntimeArtifact = AgentRuntimeArtifact.fromEcrRepository(repository, "v1.0.0");
 // Explicitly using public network (this is the default)
 Runtime runtime = Runtime.Builder.create(this, "MyAgentRuntime")
         .runtimeName("myAgent")
         .agentRuntimeArtifact(agentRuntimeArtifact)
         .networkConfiguration(RuntimeNetworkConfiguration.usingPublicNetwork())
         .build();

  • Method Details

    • getAutoDeleteImages

      @Stability(Deprecated) @Deprecated @Nullable default Boolean getAutoDeleteImages()
      Deprecated.
      Use emptyOnDelete instead.
      (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

    • getEmptyOnDelete

      @Stability(Stable) @Nullable default Boolean getEmptyOnDelete()
      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

    • getEncryption

      @Stability(Stable) @Nullable default RepositoryEncryption getEncryption()
      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.

    • getEncryptionKey

      @Stability(Stable) @Nullable default IKeyRef getEncryptionKey()
      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.

    • getImageScanOnPush

      @Stability(Stable) @Nullable default Boolean getImageScanOnPush()
      Enable the scan on push when creating the repository.

      Default: false

    • getImageTagMutability

      @Stability(Stable) @Nullable default TagMutability getImageTagMutability()
      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.

      Default: TagMutability.MUTABLE

    • getImageTagMutabilityExclusionFilters

      @Stability(Stable) @Nullable default List<ImageTagMutabilityExclusionFilter> getImageTagMutabilityExclusionFilters()
      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: undefined - AWS ECR default is no exclusion filters

      See Also:

    • getLifecycleRegistryId

      @Stability(Stable) @Nullable default String getLifecycleRegistryId()
      The AWS account ID associated with the registry that contains the repository.

      Default: The default registry is assumed.

      See Also:

    • getLifecycleRules

      @Stability(Stable) @Nullable default List<LifecycleRule> getLifecycleRules()
      Life cycle rules to apply to this registry.

      Default: No life cycle rules

    • getRemovalPolicy

      @Stability(Stable) @Nullable default RemovalPolicy getRemovalPolicy()
      Determine what happens to the repository when the resource/stack is deleted.

      Default: RemovalPolicy.Retain

    • getRepositoryName

      @Stability(Stable) @Nullable default String getRepositoryName()
      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.

      Default: Automatically generated name.

    • builder

      @Stability(Stable) static RepositoryProps.Builder builder()
      Returns:
      a RepositoryProps.Builder of RepositoryProps