Package software.amazon.awscdk.services.ecr

Class CfnRegistryPolicy

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.CfnRegistryPolicy

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-12T17:54:12.397Z")
@Stability(Stable)
public class CfnRegistryPolicy
extends CfnResource
implements IInspectable, IRegistryPolicyRef

The AWS::ECR::RegistryPolicy resource creates or updates the permissions policy for a private registry.

A private registry policy is used to specify permissions for another AWS account and is used when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry 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 policyText;
 CfnRegistryPolicy cfnRegistryPolicy = CfnRegistryPolicy.Builder.create(this, "MyCfnRegistryPolicy")
         .policyText(policyText)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnRegistryPolicy.Builder	A fluent builder for CfnRegistryPolicy.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.ecr.IRegistryPolicyRef

IRegistryPolicyRef.Jsii$Default, IRegistryPolicyRef.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnRegistryPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRegistryPolicy(software.amazon.jsii.JsiiObjectRef objRef)
	CfnRegistryPolicy(software.constructs.Construct scope, String id, CfnRegistryPolicyProps props)	Create a new AWS::ECR::RegistryPolicy.

Method Summary

Modifier and Type	Method	Description
String	getAttrRegistryId()	The account ID of the private registry the policy is associated with.
protected Map<String,Object>	getCfnProperties()
Object	getPolicyText()	The JSON policy text for your registry.
RegistryPolicyReference	getRegistryPolicyRef()	A reference to a RegistryPolicy resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnRegistryPolicy(Object x)	Checks whether the given object is a CfnRegistryPolicy.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setPolicyText(Object value)	The JSON policy text for your registry.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

CfnRegistryPolicy

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

CfnRegistryPolicy

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

CfnRegistryPolicy

@Stability(Stable)
public CfnRegistryPolicy(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnRegistryPolicyProps props)

Create a new AWS::ECR::RegistryPolicy.

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. This parameter is required.

Method Details

isCfnRegistryPolicy

@Stability(Stable)
@NotNull
public static Boolean isCfnRegistryPolicy(@NotNull
 Object x)

Checks whether the given object is a CfnRegistryPolicy.

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.

getAttrRegistryId

@Stability(Stable)
@NotNull
public String getAttrRegistryId()

The account ID of the private registry the policy is associated with.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getRegistryPolicyRef

@Stability(Stable)
@NotNull
public RegistryPolicyReference getRegistryPolicyRef()

A reference to a RegistryPolicy resource.

Specified by:

getRegistryPolicyRef in interface IRegistryPolicyRef

getPolicyText

@Stability(Stable)
@NotNull
public Object getPolicyText()

The JSON policy text for your registry.

setPolicyText

@Stability(Stable)
public void setPolicyText(@NotNull
 Object value)

The JSON policy text for your registry.