Package software.amazon.awscdk.services.ecr

Class CfnPullThroughCacheRule

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-12T19:34:01.061Z")
@Stability(Stable)
public class CfnPullThroughCacheRule
extends CfnResource
implements IInspectable

The AWS::ECR::PullThroughCacheRule resource creates or updates a pull through cache rule.

A pull through cache rule provides a way to cache images from an upstream 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")
         .credentialArn("credentialArn")
         .ecrRepositoryPrefix("ecrRepositoryPrefix")
         .upstreamRegistry("upstreamRegistry")
         .upstreamRegistryUrl("upstreamRegistryUrl")
         .build();
 

See Also:

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

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.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.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
protected	CfnPullThroughCacheRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPullThroughCacheRule(software.amazon.jsii.JsiiObjectRef objRef)
	CfnPullThroughCacheRule(software.constructs.Construct scope, String id)
	CfnPullThroughCacheRule(software.constructs.Construct scope, String id, CfnPullThroughCacheRuleProps props)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
String	getCredentialArn()	The ARN of the Secrets Manager secret associated with the pull through cache rule.
String	getEcrRepositoryPrefix()	The Amazon ECR repository prefix associated with the pull through cache rule.
String	getUpstreamRegistry()	The name of the upstream source registry 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	setCredentialArn(String value)	The ARN of the Secrets Manager secret associated with the pull through cache rule.
void	setEcrRepositoryPrefix(String value)	The Amazon ECR repository prefix associated with the pull through cache rule.
void	setUpstreamRegistry(String value)	The name of the upstream source registry 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.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, 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.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
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnPullThroughCacheRuleProps 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.

CfnPullThroughCacheRule

@Stability(Stable)
public CfnPullThroughCacheRule(@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

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

getCredentialArn

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

The ARN of the Secrets Manager secret associated with the pull through cache rule.

setCredentialArn

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

The ARN of the Secrets Manager secret associated with the pull through cache rule.

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.

getUpstreamRegistry

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

The name of the upstream source registry associated with the pull through cache rule.

setUpstreamRegistry

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

The name of the upstream source registry 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.