PullThroughCacheRule class
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.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ecr.PullThroughCacheRule("example", {
ecrRepositoryPrefix: "ecr-public",
upstreamRegistryUrl: "public.ecr.aws",
credentialArn: "arn:aws:secretsmanager:us-east-1:123456789:secret:ecr-pullthroughcache/ecrpublic",
});
import pulumi
import pulumi_aws as aws
example = aws.ecr.PullThroughCacheRule("example",
ecr_repository_prefix="ecr-public",
upstream_registry_url="public.ecr.aws",
credential_arn="arn:aws:secretsmanager:us-east-1:123456789:secret:ecr-pullthroughcache/ecrpublic")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Ecr.PullThroughCacheRule("example", new()
{
EcrRepositoryPrefix = "ecr-public",
UpstreamRegistryUrl = "public.ecr.aws",
CredentialArn = "arn:aws:secretsmanager:us-east-1:123456789:secret:ecr-pullthroughcache/ecrpublic",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ecr"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ecr.NewPullThroughCacheRule(ctx, "example", &ecr.PullThroughCacheRuleArgs{
EcrRepositoryPrefix: pulumi.String("ecr-public"),
UpstreamRegistryUrl: pulumi.String("public.ecr.aws"),
CredentialArn: pulumi.String("arn:aws:secretsmanager:us-east-1:123456789:secret:ecr-pullthroughcache/ecrpublic"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ecr_pullthroughcacherule" "example" {
ecr_repository_prefix = "ecr-public"
upstream_registry_url = "public.ecr.aws"
credential_arn = "arn:aws:secretsmanager:us-east-1:123456789:secret:ecr-pullthroughcache/ecrpublic"
}
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());
}
}
resources:
example:
type: aws:ecr:PullThroughCacheRule
properties:
ecrRepositoryPrefix: ecr-public
upstreamRegistryUrl: public.ecr.aws
credentialArn: arn:aws:secretsmanager:us-east-1:123456789:secret:ecr-pullthroughcache/ecrpublic
Import
Using pulumi import, import a pull-through cache rule using the ecrRepositoryPrefix. For example:
$ pulumi import aws:ecr/pullThroughCacheRule:PullThroughCacheRule example ecr-public
Constructors
- PullThroughCacheRule(String name, {PullThroughCacheRuleArgs? args, CustomResourceOptions? options})
-
Creates a new PullThroughCacheRule.
nameThe Pulumi resource name.argsArguments used to configure this PullThroughCacheRule. The set of arguments for PullThroughCacheRule.optionsResource options controlling this resource's behavior. - PullThroughCacheRule.reference(String urn)
- Creates a typed reference to an existing PullThroughCacheRule resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
credentialArn
↔ Output<
String?> -
ARN of the Secret which will be used to authenticate against the registry.
latefinal
-
customRoleArn
↔ Output<
String?> -
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.
latefinal
-
ecrRepositoryPrefix
↔ Output<
String> -
The repository name prefix to use when caching images from the source registry. Use
ROOTas the prefix to apply a template to all repositories in your registry that don't have an associated pull through cache rule.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
registryId
↔ Output<
String> -
The registry ID where the repository was created.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
upstreamRegistryUrl
↔ Output<
String> -
The registry URL of the upstream registry to use as the source.
latefinal
-
upstreamRepositoryPrefix
↔ Output<
String?> -
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.latefinal -
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {PullThroughCacheRuleState? state, CustomResourceOptions? options}) → PullThroughCacheRule -
Gets an existing PullThroughCacheRule resource's state with the given
nameandid.