Package software.amazon.awscdk.services.ecr

Class CfnRepository

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ecr.CfnRepository
All Implemented Interfaces:
IInspectable, IRepositoryRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:09.400Z") @Stability(Stable) public class CfnRepository extends CfnResource implements IInspectable, IRepositoryRef, ITaggable
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 in the Amazon ECR User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecr.*;
 Object repositoryPolicyText;
 CfnRepository cfnRepository = CfnRepository.Builder.create(this, "MyCfnRepository")
         .emptyOnDelete(false)
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .encryptionType("encryptionType")
                 // the properties below are optional
                 .kmsKey("kmsKey")
                 .build())
         .imageScanningConfiguration(ImageScanningConfigurationProperty.builder()
                 .scanOnPush(false)
                 .build())
         .imageTagMutability("imageTagMutability")
         .imageTagMutabilityExclusionFilters(List.of(ImageTagMutabilityExclusionFilterProperty.builder()
                 .imageTagMutabilityExclusionFilterType("imageTagMutabilityExclusionFilterType")
                 .imageTagMutabilityExclusionFilterValue("imageTagMutabilityExclusionFilterValue")
                 .build()))
         .lifecyclePolicy(LifecyclePolicyProperty.builder()
                 .lifecyclePolicyText("lifecyclePolicyText")
                 .registryId("registryId")
                 .build())
         .repositoryName("repositoryName")
         .repositoryPolicyText(repositoryPolicyText)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRepository

      protected CfnRepository(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnRepository

      protected CfnRepository(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnRepository

      @Stability(Stable) public CfnRepository(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnRepositoryProps props)
      Create a new AWS::ECR::Repository.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnRepository

      @Stability(Stable) public CfnRepository(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::ECR::Repository.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForRepository

      @Stability(Stable) @NotNull public static String arnForRepository(@NotNull IRepositoryRef resource)
      Parameters:
      resource - This parameter is required.

    • fromRepositoryArn

      @Stability(Stable) @NotNull public static IRepositoryRef fromRepositoryArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IRepositoryRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromRepositoryName

      @Stability(Stable) @NotNull public static IRepositoryRef fromRepositoryName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String repositoryName)
      Creates a new IRepositoryRef from a repositoryName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      repositoryName - This parameter is required.

    • isCfnRepository

      @Stability(Stable) @NotNull public static Boolean isCfnRepository(@NotNull Object x)
      Checks whether the given object is a CfnRepository.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Returns the Amazon Resource Name (ARN) for the specified AWS::ECR::Repository resource.

      For example, arn:aws:ecr: *eu-west-1* : *123456789012* :repository/ *test-repository* .

    • getAttrRepositoryUri

      @Stability(Stable) @NotNull public String getAttrRepositoryUri()
      Returns the URI for the specified AWS::ECR::Repository resource.

      For example, *123456789012* .dkr.ecr. *us-west-2* .amazonaws.com/repository .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRepositoryRef

      @Stability(Stable) @NotNull public RepositoryReference getRepositoryRef()
      A reference to a Repository resource.
      Specified by:
      getRepositoryRef in interface IRepositoryRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getEmptyOnDelete

      @Stability(Stable) @Nullable public Object getEmptyOnDelete()
      If true, deleting the repository force deletes the contents of the repository.

      Returns union: either Boolean or IResolvable

    • setEmptyOnDelete

      @Stability(Stable) public void setEmptyOnDelete(@Nullable Boolean value)
      If true, deleting the repository force deletes the contents of the repository.

    • setEmptyOnDelete

      @Stability(Stable) public void setEmptyOnDelete(@Nullable IResolvable value)
      If true, deleting the repository force deletes the contents of the repository.

    • getEncryptionConfiguration

      @Stability(Stable) @Nullable public Object getEncryptionConfiguration()
      The encryption configuration for the repository.

      Returns union: either IResolvable or CfnRepository.EncryptionConfigurationProperty

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable IResolvable value)
      The encryption configuration for the repository.

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable CfnRepository.EncryptionConfigurationProperty value)
      The encryption configuration for the repository.

    • getImageScanningConfiguration

      @Stability(Stable) @Nullable public Object getImageScanningConfiguration()

      The imageScanningConfiguration parameter is being deprecated, in favor of specifying the image scanning configuration at the registry level.

      Returns union: either IResolvable or CfnRepository.ImageScanningConfigurationProperty

    • setImageScanningConfiguration

      @Stability(Stable) public void setImageScanningConfiguration(@Nullable IResolvable value)

      The imageScanningConfiguration parameter is being deprecated, in favor of specifying the image scanning configuration at the registry level.

    • setImageScanningConfiguration

      @Stability(Stable) public void setImageScanningConfiguration(@Nullable CfnRepository.ImageScanningConfigurationProperty value)

      The imageScanningConfiguration parameter is being deprecated, in favor of specifying the image scanning configuration at the registry level.

    • getImageTagMutability

      @Stability(Stable) @Nullable public String getImageTagMutability()
      The tag mutability setting for the repository.

    • setImageTagMutability

      @Stability(Stable) public void setImageTagMutability(@Nullable String value)
      The tag mutability setting for the repository.

    • getImageTagMutabilityExclusionFilters

      @Stability(Stable) @Nullable public Object getImageTagMutabilityExclusionFilters()
      A list of filters that specify which image tags are excluded from the repository's image tag mutability setting.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRepository.ImageTagMutabilityExclusionFilterProperty>

    • setImageTagMutabilityExclusionFilters

      @Stability(Stable) public void setImageTagMutabilityExclusionFilters(@Nullable IResolvable value)
      A list of filters that specify which image tags are excluded from the repository's image tag mutability setting.

    • setImageTagMutabilityExclusionFilters

      @Stability(Stable) public void setImageTagMutabilityExclusionFilters(@Nullable List<Object> value)
      A list of filters that specify which image tags are excluded from the repository's image tag mutability setting.

    • getLifecyclePolicy

      @Stability(Stable) @Nullable public Object getLifecyclePolicy()
      Creates or updates a lifecycle policy.

      Returns union: either IResolvable or CfnRepository.LifecyclePolicyProperty

    • setLifecyclePolicy

      @Stability(Stable) public void setLifecyclePolicy(@Nullable IResolvable value)
      Creates or updates a lifecycle policy.

    • setLifecyclePolicy

      @Stability(Stable) public void setLifecyclePolicy(@Nullable CfnRepository.LifecyclePolicyProperty value)
      Creates or updates a lifecycle policy.

    • getRepositoryName

      @Stability(Stable) @Nullable public String getRepositoryName()
      The name to use for the repository.

    • setRepositoryName

      @Stability(Stable) public void setRepositoryName(@Nullable String value)
      The name to use for the repository.

    • getRepositoryPolicyText

      @Stability(Stable) @Nullable public Object getRepositoryPolicyText()
      The JSON repository policy text to apply to the repository.

    • setRepositoryPolicyText

      @Stability(Stable) public void setRepositoryPolicyText(@Nullable Object value)
      The JSON repository policy text to apply to the repository.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.