Package software.amazon.awscdk.services.ecr

Class CfnPullThroughCacheRule

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:37.409Z")
@Stability(Stable)
public class CfnPullThroughCacheRule
extends CfnResource
implements IInspectable

A CloudFormation AWS::ECR::PullThroughCacheRule.

Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an external public registry in your Amazon ECR private registry.

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.*;
 CfnPullThroughCacheRule cfnPullThroughCacheRule = CfnPullThroughCacheRule.Builder.create(this, "MyCfnPullThroughCacheRule")
         .ecrRepositoryPrefix("ecrRepositoryPrefix")
         .upstreamRegistryUrl("upstreamRegistryUrl")
         .build();
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IConstruct.Jsii$Default

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.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
	CfnPullThroughCacheRule(Construct scope, String id)	Create a new AWS::ECR::PullThroughCacheRule.
	CfnPullThroughCacheRule(Construct scope, String id, CfnPullThroughCacheRuleProps props)	Create a new AWS::ECR::PullThroughCacheRule.
protected	CfnPullThroughCacheRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPullThroughCacheRule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
String	getEcrRepositoryPrefix()	The Amazon ECR repository prefix associated with the pull through cache rule.
String	getUpstreamRegistryUrl()	The upstream registry URL associated with the pull through cache rule.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setEcrRepositoryPrefix(String value)	The Amazon ECR repository prefix associated with the pull through cache rule.
void	setUpstreamRegistryUrl(String value)	The upstream registry URL associated with the pull through cache rule.

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

CfnPullThroughCacheRule

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

CfnPullThroughCacheRule

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

CfnPullThroughCacheRule

@Stability(Stable)
public CfnPullThroughCacheRule(@NotNull
 Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnPullThroughCacheRuleProps props)

Create a new AWS::ECR::PullThroughCacheRule.

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.

CfnPullThroughCacheRule

@Stability(Stable)
public CfnPullThroughCacheRule(@NotNull
 Construct scope,
 @NotNull
 String id)

Create a new AWS::ECR::PullThroughCacheRule.

Parameters:

scope -

• scope in which this resource is defined.

This parameter is required.

id -

• scoped id of the resource.

This parameter is required.

Method Details

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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getEcrRepositoryPrefix

@Stability(Stable)
@Nullable
public String getEcrRepositoryPrefix()

The Amazon ECR repository prefix associated with the pull through cache rule.

setEcrRepositoryPrefix

@Stability(Stable)
public void setEcrRepositoryPrefix(@Nullable
 String value)

The Amazon ECR repository prefix associated with the pull through cache rule.

getUpstreamRegistryUrl

@Stability(Stable)
@Nullable
public String getUpstreamRegistryUrl()

The upstream registry URL associated with the pull through cache rule.

setUpstreamRegistryUrl

@Stability(Stable)
public void setUpstreamRegistryUrl(@Nullable
 String value)

The upstream registry URL associated with the pull through cache rule.