Package software.amazon.awscdk.services.ecr

Class CfnPublicRepository

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.CfnPublicRepository
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IPublicRepositoryRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:40.564Z") @Stability(Stable) public class CfnPublicRepository extends CfnResource implements IInspectable, IPublicRepositoryRef, ITaggable
The AWS::ECR::PublicRepository resource specifies an Amazon Elastic Container Registry Public (Amazon ECR Public) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts.

For more information, see Amazon ECR public repositories in the Amazon ECR Public 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 repositoryCatalogData;
 Object repositoryPolicyText;
 CfnPublicRepository cfnPublicRepository = CfnPublicRepository.Builder.create(this, "MyCfnPublicRepository")
         .repositoryCatalogData(repositoryCatalogData)
         .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

    • CfnPublicRepository

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

    • CfnPublicRepository

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

    • CfnPublicRepository

      @Stability(Stable) public CfnPublicRepository(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnPublicRepositoryProps props)
      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.

    • CfnPublicRepository

      @Stability(Stable) public CfnPublicRepository(@NotNull software.constructs.Construct scope, @NotNull String id)
      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

    • fromPublicRepositoryArn

      @Stability(Stable) @NotNull public static IPublicRepositoryRef fromPublicRepositoryArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IPublicRepositoryRef 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 IPublicRepositoryRef fromRepositoryName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String repositoryName)
      Creates a new IPublicRepositoryRef from a repositoryName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      repositoryName - 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::PublicRepository resource.

      For example, arn:aws:ecr-public:: *123456789012* :repository/ *test-repository* .

    • getCfnProperties

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

    • getPublicRepositoryRef

      @Stability(Stable) @NotNull public PublicRepositoryReference getPublicRepositoryRef()
      A reference to a PublicRepository resource.
      Specified by:
      getPublicRepositoryRef in interface IPublicRepositoryRef

    • getTags

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

    • getRepositoryCatalogData

      @Stability(Stable) @Nullable public Object getRepositoryCatalogData()
      The details about the repository that are publicly visible in the Amazon ECR Public Gallery.

    • setRepositoryCatalogData

      @Stability(Stable) public void setRepositoryCatalogData(@Nullable Object value)
      The details about the repository that are publicly visible in the Amazon ECR Public Gallery.

    • getRepositoryName

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

    • setRepositoryName

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

    • getRepositoryPolicyText

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

    • setRepositoryPolicyText

      @Stability(Stable) public void setRepositoryPolicyText(@Nullable Object value)
      The JSON repository policy text to apply to the public 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.