software.amazon.awscdk.services.ecr

Class CfnPublicRepository

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.ecr.CfnPublicRepository

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.453Z")
public class CfnPublicRepository
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ECR::PublicRepository`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnPublicRepository.Builder A fluent builder for CfnPublicRepository.
static interface	CfnPublicRepository.RepositoryCatalogDataProperty Example:

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPublicRepository(Construct scope, java.lang.String id) Create a new `AWS::ECR::PublicRepository`.
	CfnPublicRepository(Construct scope, java.lang.String id, CfnPublicRepositoryProps props) Create a new `AWS::ECR::PublicRepository`.
protected	CfnPublicRepository(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPublicRepository(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() Returns the Amazon Resource Name (ARN) for the specified `AWS::ECR::PublicRepository` resource.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getRepositoryCatalogData() The details about the repository that are publicly visible in the Amazon ECR Public Gallery.
java.lang.String	getRepositoryName() The name to use for the public repository.
java.lang.Object	getRepositoryPolicyText() The JSON repository policy text to apply to the public repository.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setRepositoryCatalogData(java.lang.Object value) The details about the repository that are publicly visible in the Amazon ECR Public Gallery.
void	setRepositoryName(java.lang.String value) The name to use for the public repository.
void	setRepositoryPolicyText(java.lang.Object value) The JSON repository policy text to apply to the public repository.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPublicRepository

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

CfnPublicRepository

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

CfnPublicRepository

public CfnPublicRepository(Construct scope,
                           java.lang.String id,
                           CfnPublicRepositoryProps props)

Create a new `AWS::ECR::PublicRepository`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnPublicRepository

public CfnPublicRepository(Construct scope,
                           java.lang.String id)

Create a new `AWS::ECR::PublicRepository`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.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

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

An array of key-value pairs to apply to this resource.

getRepositoryCatalogData

public java.lang.Object getRepositoryCatalogData()

The details about the repository that are publicly visible in the Amazon ECR Public Gallery.

For more information, see Amazon ECR Public repository catalog data in the Amazon ECR Public User Guide .

setRepositoryCatalogData

public void setRepositoryCatalogData(java.lang.Object value)

The details about the repository that are publicly visible in the Amazon ECR Public Gallery.

For more information, see Amazon ECR Public repository catalog data in the Amazon ECR Public User Guide .

getRepositoryPolicyText

public java.lang.Object getRepositoryPolicyText()

The JSON repository policy text to apply to the public repository.

For more information, see Amazon ECR Public repository policies in the Amazon ECR Public User Guide .

setRepositoryPolicyText

public void setRepositoryPolicyText(java.lang.Object value)

The JSON repository policy text to apply to the public repository.

For more information, see Amazon ECR Public repository policies in the Amazon ECR Public User Guide .

getRepositoryName

public java.lang.String getRepositoryName()

The name to use for the public repository.

The repository name may be specified on its own (such as nginx-web-app ) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app ). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see Name Type .

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.

setRepositoryName

public void setRepositoryName(java.lang.String value)

The name to use for the public repository.

The repository name may be specified on its own (such as nginx-web-app ) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app ). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see Name Type .

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.