Package com.pulumi.aws.ecr

Class PullThroughCacheRule

  • public class PullThroughCacheRule
extends com.pulumi.resources.CustomResource
    Provides an Elastic Container Registry Pull Through Cache Rule. More information about pull through cache rules, including the set of supported upstream repositories, see [Using pull through cache rules](https://docs.aws.amazon.com/AmazonECR/latest/userguide/pull-through-cache.html). ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.ecr.PullThroughCacheRule;
 import com.pulumi.aws.ecr.PullThroughCacheRuleArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new PullThroughCacheRule("example", PullThroughCacheRuleArgs.builder()
             .ecrRepositoryPrefix("ecr-public")
             .upstreamRegistryUrl("public.ecr.aws")
             .credentialArn("arn:aws:secretsmanager:us-east-1:123456789:secret:ecr-pullthroughcache/ecrpublic")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import a pull-through cache rule using the `ecrRepositoryPrefix`. For example: ```sh $ pulumi import aws:ecr/pullThroughCacheRule:PullThroughCacheRule example ecr-public ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> credentialArn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> customRoleArn()  
      com.pulumi.core.Output<java.lang.String> ecrRepositoryPrefix()  
      static PullThroughCacheRule get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, PullThroughCacheRuleState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> registryId()  
      com.pulumi.core.Output<java.lang.String> upstreamRegistryUrl()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> upstreamRepositoryPrefix()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PullThroughCacheRule

        public PullThroughCacheRule​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • PullThroughCacheRule

        public PullThroughCacheRule​(java.lang.String name,
                            PullThroughCacheRuleArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • PullThroughCacheRule

        public PullThroughCacheRule​(java.lang.String name,
                            PullThroughCacheRuleArgs args,
                            @Nullable
                            com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • credentialArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> credentialArn()
        Returns:
        ARN of the Secret which will be used to authenticate against the registry.

      • customRoleArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> customRoleArn()
        Returns:
        The ARN of the IAM role associated with the pull through cache rule. Must be specified if the upstream registry is a cross-account ECR private registry. See [AWS Document - Setting up permissions for cross-account ECR to ECR PTC](https://docs.aws.amazon.com/AmazonECR/latest/userguide/pull-through-cache-private.html).

      • ecrRepositoryPrefix

        public com.pulumi.core.Output<java.lang.String> ecrRepositoryPrefix()
        Returns:
        The repository name prefix to use when caching images from the source registry. Use `ROOT` as the prefix to apply a template to all repositories in your registry that don't have an associated pull through cache rule.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • registryId

        public com.pulumi.core.Output<java.lang.String> registryId()
        Returns:
        The registry ID where the repository was created.

      • upstreamRegistryUrl

        public com.pulumi.core.Output<java.lang.String> upstreamRegistryUrl()
        Returns:
        The registry URL of the upstream registry to use as the source.

      • upstreamRepositoryPrefix

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> upstreamRepositoryPrefix()
        Returns:
        The upstream repository prefix associated with the pull through cache rule. Used if the upstream registry is an ECR private registry. If not specified, it's set to `ROOT`, which allows matching with any upstream repository. See [AWS Document - Customizing repository prefixes for ECR to ECR pull through cache](https://docs.aws.amazon.com/AmazonECR/latest/userguide/pull-through-cache-private-wildcards.html).

      • get

        public static PullThroughCacheRule get​(java.lang.String name,
                                       com.pulumi.core.Output<java.lang.String> id,
                                       @Nullable
                                       PullThroughCacheRuleState state,
                                       @Nullable
                                       com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.