Repository class

Provides an Elastic Container Registry Repository.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const foo = new aws.ecr.Repository("foo", {
    imageScanningConfiguration: {
        scanOnPush: true,
    },
    name: "bar",
    imageTagMutability: "MUTABLE",
});
import pulumi
import pulumi_aws as aws

foo = aws.ecr.Repository("foo",
    image_scanning_configuration={
        "scan_on_push": True,
    },
    name="bar",
    image_tag_mutability="MUTABLE")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var foo = new Aws.Ecr.Repository("foo", new()
    {
        ImageScanningConfiguration = new Aws.Ecr.Inputs.RepositoryImageScanningConfigurationArgs
        {
            ScanOnPush = true,
        },
        Name = "bar",
        ImageTagMutability = "MUTABLE",
    });

});
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.NewRepository(ctx, "foo", &ecr.RepositoryArgs{
			ImageScanningConfiguration: &ecr.RepositoryImageScanningConfigurationArgs{
				ScanOnPush: pulumi.Bool(true),
			},
			Name:               pulumi.String("bar"),
			ImageTagMutability: pulumi.String("MUTABLE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ecr_repository" "foo" {
  image_scanning_configuration = {
    scan_on_push = true
  }
  name                 = "bar"
  image_tag_mutability = "MUTABLE"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ecr.Repository;
import com.pulumi.aws.ecr.RepositoryArgs;
import com.pulumi.aws.ecr.inputs.RepositoryImageScanningConfigurationArgs;
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 foo = new Repository("foo", RepositoryArgs.builder()
            .imageScanningConfiguration(RepositoryImageScanningConfigurationArgs.builder()
                .scanOnPush(true)
                .build())
            .name("bar")
            .imageTagMutability("MUTABLE")
            .build());

    }
}
resources:
  foo:
    type: aws:ecr:Repository
    properties:
      imageScanningConfiguration:
        scanOnPush: true
      name: bar
      imageTagMutability: MUTABLE

With Image Tag Mutability Exclusion

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ecr.Repository("example", {
    imageTagMutabilityExclusionFilters: [
        {
            filter: "latest*",
            filterType: "WILDCARD",
        },
        {
            filter: "dev-*",
            filterType: "WILDCARD",
        },
    ],
    name: "example-repo",
    imageTagMutability: "IMMUTABLE_WITH_EXCLUSION",
});
import pulumi
import pulumi_aws as aws

example = aws.ecr.Repository("example",
    image_tag_mutability_exclusion_filters=[
        {
            "filter": "latest*",
            "filter_type": "WILDCARD",
        },
        {
            "filter": "dev-*",
            "filter_type": "WILDCARD",
        },
    ],
    name="example-repo",
    image_tag_mutability="IMMUTABLE_WITH_EXCLUSION")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Ecr.Repository("example", new()
    {
        ImageTagMutabilityExclusionFilters = new[]
        {
            new Aws.Ecr.Inputs.RepositoryImageTagMutabilityExclusionFilterArgs
            {
                Filter = "latest*",
                FilterType = "WILDCARD",
            },
            new Aws.Ecr.Inputs.RepositoryImageTagMutabilityExclusionFilterArgs
            {
                Filter = "dev-*",
                FilterType = "WILDCARD",
            },
        },
        Name = "example-repo",
        ImageTagMutability = "IMMUTABLE_WITH_EXCLUSION",
    });

});
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.NewRepository(ctx, "example", &ecr.RepositoryArgs{
			ImageTagMutabilityExclusionFilters: ecr.RepositoryImageTagMutabilityExclusionFilterArray{
				&ecr.RepositoryImageTagMutabilityExclusionFilterArgs{
					Filter:     pulumi.String("latest*"),
					FilterType: pulumi.String("WILDCARD"),
				},
				&ecr.RepositoryImageTagMutabilityExclusionFilterArgs{
					Filter:     pulumi.String("dev-*"),
					FilterType: pulumi.String("WILDCARD"),
				},
			},
			Name:               pulumi.String("example-repo"),
			ImageTagMutability: pulumi.String("IMMUTABLE_WITH_EXCLUSION"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ecr_repository" "example" {
  image_tag_mutability_exclusion_filters {
    filter      = "latest*"
    filter_type = "WILDCARD"
  }
  image_tag_mutability_exclusion_filters {
    filter      = "dev-*"
    filter_type = "WILDCARD"
  }
  name                 = "example-repo"
  image_tag_mutability = "IMMUTABLE_WITH_EXCLUSION"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ecr.Repository;
import com.pulumi.aws.ecr.RepositoryArgs;
import com.pulumi.aws.ecr.inputs.RepositoryImageTagMutabilityExclusionFilterArgs;
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 Repository("example", RepositoryArgs.builder()
            .imageTagMutabilityExclusionFilters(
                RepositoryImageTagMutabilityExclusionFilterArgs.builder()
                    .filter("latest*")
                    .filterType("WILDCARD")
                    .build(),
                RepositoryImageTagMutabilityExclusionFilterArgs.builder()
                    .filter("dev-*")
                    .filterType("WILDCARD")
                    .build())
            .name("example-repo")
            .imageTagMutability("IMMUTABLE_WITH_EXCLUSION")
            .build());

    }
}
resources:
  example:
    type: aws:ecr:Repository
    properties:
      imageTagMutabilityExclusionFilters:
        - filter: latest*
          filterType: WILDCARD
        - filter: dev-*
          filterType: WILDCARD
      name: example-repo
      imageTagMutability: IMMUTABLE_WITH_EXCLUSION

Import

Identity Schema

Required

  • name - (String) Name of the ECR repository.

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

Using pulumi import, import ECR Repositories using the name. For example:

$ pulumi import aws:ecr/repository:Repository service test-service

Constructors

Repository(String name, {RepositoryArgs? args, CustomResourceOptions? options})
Creates a new Repository. name The Pulumi resource name. args Arguments used to configure this Repository. The set of arguments for Repository. options Resource options controlling this resource's behavior.
Repository.reference(String urn)
Creates a typed reference to an existing Repository resource.

Properties

arn ↔ Output<String>
Full ARN of the repository.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
encryptionConfigurations ↔ Output<List<RepositoryEncryptionConfiguration>?>
Encryption configuration for the repository. See below for schema.
latefinal
forceDelete ↔ Output<bool?>
If true, will delete the repository even if it contains images. Defaults to false.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
imageScanningConfiguration ↔ Output<RepositoryImageScanningConfiguration?>
Configuration block that defines image scanning configuration for the repository. By default, image scanning must be manually triggered. See the ECR User Guide for more information about image scanning.
latefinal
imageTagMutability ↔ Output<String?>
The tag mutability setting for the repository. Must be one of: MUTABLE, IMMUTABLE, IMMUTABLE_WITH_EXCLUSION, or MUTABLE_WITH_EXCLUSION. Defaults to MUTABLE.
latefinal
imageTagMutabilityExclusionFilters ↔ Output<List<RepositoryImageTagMutabilityExclusionFilter>?>
Configuration block that defines filters to specify which image tags can override the default tag mutability setting. Only applicable when imageTagMutability is set to IMMUTABLE_WITH_EXCLUSION or MUTABLE_WITH_EXCLUSION. See below for schema.
latefinal
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
name ↔ Output<String>
Name of the repository.
latefinal
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
repositoryUrl ↔ Output<String>
The URL of the repository (in the form aws_account_id.dkr.ecr.region.amazonaws.com/repositoryName).
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
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, {RepositoryState? state, CustomResourceOptions? options}) → Repository
Gets an existing Repository resource's state with the given name and id.