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, IPullThroughCacheRuleRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:09.378Z") @Stability(Stable) public class CfnPullThroughCacheRule extends CfnResource implements IInspectable, IPullThroughCacheRuleRef
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")
         .customRoleArn("customRoleArn")
         .ecrRepositoryPrefix("ecrRepositoryPrefix")
         .upstreamRegistry("upstreamRegistry")
         .upstreamRegistryUrl("upstreamRegistryUrl")
         .upstreamRepositoryPrefix("upstreamRepositoryPrefix")
         .build();

See Also:

  • 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)
      Create a new AWS::ECR::PullThroughCacheRule.

      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)
      Create a new AWS::ECR::PullThroughCacheRule.

      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

    • isCfnPullThroughCacheRule

      @Stability(Stable) @NotNull public static Boolean isCfnPullThroughCacheRule(@NotNull Object x)
      Checks whether the given object is a CfnPullThroughCacheRule.

      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.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPullThroughCacheRuleRef

      @Stability(Stable) @NotNull public PullThroughCacheRuleReference getPullThroughCacheRuleRef()
      A reference to a PullThroughCacheRule resource.
      Specified by:
      getPullThroughCacheRuleRef in interface IPullThroughCacheRuleRef

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

    • getCustomRoleArn

      @Stability(Stable) @Nullable public String getCustomRoleArn()
      The ARN of the IAM role associated with the pull through cache rule.

    • setCustomRoleArn

      @Stability(Stable) public void setCustomRoleArn(@Nullable String value)
      The ARN of the IAM role 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.

    • getUpstreamRepositoryPrefix

      @Stability(Stable) @Nullable public String getUpstreamRepositoryPrefix()
      The upstream repository prefix associated with the pull through cache rule.

    • setUpstreamRepositoryPrefix

      @Stability(Stable) public void setUpstreamRepositoryPrefix(@Nullable String value)
      The upstream repository prefix associated with the pull through cache rule.