Module ecr

@pulumi/aws > ecr

Index

ecr/getCredentials.ts ecr/getRepository.ts ecr/lifecyclePolicy.ts ecr/repository.ts ecr/repositoryPolicy.ts

class LifecyclePolicy

Manages an ECR repository lifecycle policy.

~> NOTE: Only one aws_ecr_lifecycle_policy resource can be used with the same ECR repository. To apply multiple rules, they must be combined in the policy JSON.

~> NOTE: The AWS ECR API seems to reorder rules based on rulePriority. If you define multiple rules that are not sorted in ascending rulePriority order in the Terraform code, the resource will be flagged for recreation every terraform plan.

constructor

new LifecyclePolicy(name: string, args: LifecyclePolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a LifecyclePolicy resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: LifecyclePolicyState): LifecyclePolicy

Get an existing LifecyclePolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property policy

public policy: pulumi.Output<string>;

The policy document. This is a JSON formatted string. See more details about Policy Parameters in the official AWS docs. For more information about building IAM policy documents with Terraform, see the AWS IAM Policy Document Guide.

property registryId

public registryId: pulumi.Output<string>;

The registry ID where the repository was created.

property repository

public repository: pulumi.Output<string>;

Name of the repository to apply the policy.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Repository

Provides an EC2 Container Registry Repository.

~> NOTE on ECR Availability: The EC2 Container Registry is not yet rolled out in all regions - available regions are listed the AWS Docs.

constructor

new Repository(name: string, args?: RepositoryArgs, opts?: pulumi.CustomResourceOptions)

Create a Repository resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RepositoryState): Repository

Get an existing Repository resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Full ARN of the repository.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Name of the repository.

property registryId

public registryId: pulumi.Output<string>;

The registry ID where the repository was created.

property repositoryUrl

public repositoryUrl: pulumi.Output<string>;

The URL of the repository (in the form aws_account_id.dkr.ecr.region.amazonaws.com/repositoryName

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class RepositoryPolicy

Provides an ECR repository policy.

Note that currently only one policy may be applied to a repository.

~> NOTE on ECR Availability: The EC2 Container Registry is not yet rolled out in all regions - available regions are listed the AWS Docs.

constructor

new RepositoryPolicy(name: string, args: RepositoryPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a RepositoryPolicy resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RepositoryPolicyState): RepositoryPolicy

Get an existing RepositoryPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property policy

public policy: pulumi.Output<string>;

The policy document. This is a JSON formatted string. For more information about building IAM policy documents with Terraform, see the AWS IAM Policy Document Guide

property registryId

public registryId: pulumi.Output<string>;

The registry ID where the repository was created.

property repository

public repository: pulumi.Output<string>;

Name of the repository to apply the policy.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

function getCredentials

getCredentials(args: GetCredentialsArgs, opts?: pulumi.InvokeOptions): Promise<GetCredentialsResult>

function getRepository

getRepository(args: GetRepositoryArgs, opts?: pulumi.InvokeOptions): Promise<GetRepositoryResult>

The ECR Repository data source allows the ARN, Repository URI and Registry ID to be retrieved for an ECR repository.

interface GetCredentialsArgs

A collection of arguments for invoking getCredentials.

property registryId

registryId: string;

interface GetCredentialsResult

A collection of values returned by getCredentials.

property authorizationToken

authorizationToken: string;

property expiresAt

expiresAt: string;

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property proxyEndpoint

proxyEndpoint: string;

interface GetRepositoryArgs

A collection of arguments for invoking getRepository.

property name

name: string;

The name of the ECR Repository.

interface GetRepositoryResult

A collection of values returned by getRepository.

property arn

arn: string;

Full ARN of the repository.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property registryId

registryId: string;

The registry ID where the repository was created.

property repositoryUrl

repositoryUrl: string;

The URL of the repository (in the form aws_account_id.dkr.ecr.region.amazonaws.com/repositoryName).

interface LifecyclePolicyArgs

The set of arguments for constructing a LifecyclePolicy resource.

property policy

policy: pulumi.Input<string>;

The policy document. This is a JSON formatted string. See more details about Policy Parameters in the official AWS docs. For more information about building IAM policy documents with Terraform, see the AWS IAM Policy Document Guide.

property repository

repository: pulumi.Input<string>;

Name of the repository to apply the policy.

interface LifecyclePolicyState

Input properties used for looking up and filtering LifecyclePolicy resources.

property policy

policy?: pulumi.Input<string>;

The policy document. This is a JSON formatted string. See more details about Policy Parameters in the official AWS docs. For more information about building IAM policy documents with Terraform, see the AWS IAM Policy Document Guide.

property registryId

registryId?: pulumi.Input<string>;

The registry ID where the repository was created.

property repository

repository?: pulumi.Input<string>;

Name of the repository to apply the policy.

interface RepositoryArgs

The set of arguments for constructing a Repository resource.

property name

name?: pulumi.Input<string>;

Name of the repository.

interface RepositoryPolicyArgs

The set of arguments for constructing a RepositoryPolicy resource.

property policy

policy: pulumi.Input<string>;

The policy document. This is a JSON formatted string. For more information about building IAM policy documents with Terraform, see the AWS IAM Policy Document Guide

property repository

repository: pulumi.Input<string>;

Name of the repository to apply the policy.

interface RepositoryPolicyState

Input properties used for looking up and filtering RepositoryPolicy resources.

property policy

policy?: pulumi.Input<string>;

The policy document. This is a JSON formatted string. For more information about building IAM policy documents with Terraform, see the AWS IAM Policy Document Guide

property registryId

registryId?: pulumi.Input<string>;

The registry ID where the repository was created.

property repository

repository?: pulumi.Input<string>;

Name of the repository to apply the policy.

interface RepositoryState

Input properties used for looking up and filtering Repository resources.

property arn

arn?: pulumi.Input<string>;

Full ARN of the repository.

property name

name?: pulumi.Input<string>;

Name of the repository.

property registryId

registryId?: pulumi.Input<string>;

The registry ID where the repository was created.

property repositoryUrl

repositoryUrl?: pulumi.Input<string>;

The URL of the repository (in the form aws_account_id.dkr.ecr.region.amazonaws.com/repositoryName