@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
108 lines (107 loc) • 4.28 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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 Usage
* ### Example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws_native from "@pulumi/aws-native";
*
* const myECRPullThroughCacheRule = new aws_native.ecr.PullThroughCacheRule("myECRPullThroughCacheRule", {
* ecrRepositoryPrefix: "my-ecr",
* upstreamRegistryUrl: "public.ecr.aws",
* });
*
* ```
* ### Example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws_native from "@pulumi/aws-native";
*
* const myECRPullThroughCacheRule = new aws_native.ecr.PullThroughCacheRule("myECRPullThroughCacheRule", {
* ecrRepositoryPrefix: "my-ecr",
* upstreamRegistryUrl: "public.ecr.aws",
* });
*
* ```
*/
export declare class PullThroughCacheRule extends pulumi.CustomResource {
/**
* Get an existing PullThroughCacheRule resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): PullThroughCacheRule;
/**
* Returns true if the given object is an instance of PullThroughCacheRule. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is PullThroughCacheRule;
/**
* The ARN of the Secrets Manager secret associated with the pull through cache rule.
*/
readonly credentialArn: pulumi.Output<string | undefined>;
/**
* The ARN of the IAM role associated with the pull through cache rule.
*/
readonly customRoleArn: pulumi.Output<string | undefined>;
/**
* The Amazon ECR repository prefix associated with the pull through cache rule.
*/
readonly ecrRepositoryPrefix: pulumi.Output<string | undefined>;
/**
* The name of the upstream source registry associated with the pull through cache rule.
*/
readonly upstreamRegistry: pulumi.Output<string | undefined>;
/**
* The upstream registry URL associated with the pull through cache rule.
*/
readonly upstreamRegistryUrl: pulumi.Output<string | undefined>;
/**
* The upstream repository prefix associated with the pull through cache rule.
*/
readonly upstreamRepositoryPrefix: pulumi.Output<string | undefined>;
/**
* Create a PullThroughCacheRule resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: PullThroughCacheRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a PullThroughCacheRule resource.
*/
export interface PullThroughCacheRuleArgs {
/**
* The ARN of the Secrets Manager secret associated with the pull through cache rule.
*/
credentialArn?: pulumi.Input<string>;
/**
* The ARN of the IAM role associated with the pull through cache rule.
*/
customRoleArn?: pulumi.Input<string>;
/**
* The Amazon ECR repository prefix associated with the pull through cache rule.
*/
ecrRepositoryPrefix?: pulumi.Input<string>;
/**
* The name of the upstream source registry associated with the pull through cache rule.
*/
upstreamRegistry?: pulumi.Input<string>;
/**
* The upstream registry URL associated with the pull through cache rule.
*/
upstreamRegistryUrl?: pulumi.Input<string>;
/**
* The upstream repository prefix associated with the pull through cache rule.
*/
upstreamRepositoryPrefix?: pulumi.Input<string>;
}