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:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.528Z")
 @Stability(value=Stable)
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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPublicRepository(software.constructs.Construct scope, String id) Create a new `AWS::ECR::PublicRepository`.
	CfnPublicRepository(software.constructs.Construct scope, 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
String	getAttrArn() Returns the Amazon Resource Name (ARN) for the specified `AWS::ECR::PublicRepository` resource.
protected Map<String,Object>	getCfnProperties()
Object	getRepositoryCatalogData() The details about the repository that are publicly visible in the Amazon ECR Public Gallery.
String	getRepositoryName() The name to use for the public repository.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setRepositoryCatalogData(Object value) The details about the repository that are publicly visible in the Amazon ECR Public Gallery.
void	setRepositoryName(String value) The name to use for the public repository.
void	setRepositoryPolicyText(Object value) The JSON repository policy text to apply to the public repository.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

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

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

@Stability(value=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(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getRepositoryCatalogData

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setRepositoryCatalogData(@NotNull
                                                              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

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setRepositoryPolicyText(@NotNull
                                                             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

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setRepositoryName(@Nullable
                                                       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.