LifecyclePolicy class
Manages an ECR repository lifecycle policy.
> NOTE: Only one aws.ecr.LifecyclePolicy 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 this provider code, the resource will be flagged for recreation every deployment.
Example Usage
Policy on Untagged Images
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ecr.Repository("example", {name: "example-repo"});
const exampleLifecyclePolicy = new aws.ecr.LifecyclePolicy("example", {
repository: example.name,
policy: `{
\\"rules\\": [
{
\\"rulePriority\\": 1,
\\"description\\": \\"Expire images older than 14 days\\",
\\"selection\\": {
\\"tagStatus\\": \\"untagged\\",
\\"countType\\": \\"sinceImagePushed\\",
\\"countUnit\\": \\"days\\",
\\"countNumber\\": 14
},
\\"action\\": {
\\"type\\": \\"expire\\"
}
}
]
}
`,
});
import pulumi
import pulumi_aws as aws
example = aws.ecr.Repository("example", name="example-repo")
example_lifecycle_policy = aws.ecr.LifecyclePolicy("example",
repository=example.name,
policy="""{
\"rules\": [
{
\"rulePriority\": 1,
\"description\": \"Expire images older than 14 days\",
\"selection\": {
\"tagStatus\": \"untagged\",
\"countType\": \"sinceImagePushed\",
\"countUnit\": \"days\",
\"countNumber\": 14
},
\"action\": {
\"type\": \"expire\"
}
}
]
}
""")
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()
{
Name = "example-repo",
});
var exampleLifecyclePolicy = new Aws.Ecr.LifecyclePolicy("example", new()
{
Repository = example.Name,
Policy = @"{
\""rules\"": [
{
\""rulePriority\"": 1,
\""description\"": \""Expire images older than 14 days\"",
\""selection\"": {
\""tagStatus\"": \""untagged\"",
\""countType\"": \""sinceImagePushed\"",
\""countUnit\"": \""days\"",
\""countNumber\"": 14
},
\""action\"": {
\""type\"": \""expire\""
}
}
]
}
",
});
});
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 {
example, err := ecr.NewRepository(ctx, "example", &ecr.RepositoryArgs{
Name: pulumi.String("example-repo"),
})
if err != nil {
return err
}
_, err = ecr.NewLifecyclePolicy(ctx, "example", &ecr.LifecyclePolicyArgs{
Repository: example.Name,
Policy: pulumi.Any(`{
\"rules\": [
{
\"rulePriority\": 1,
\"description\": \"Expire images older than 14 days\",
\"selection\": {
\"tagStatus\": \"untagged\",
\"countType\": \"sinceImagePushed\",
\"countUnit\": \"days\",
\"countNumber\": 14
},
\"action\": {
\"type\": \"expire\"
}
}
]
}
`),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ecr_repository" "example" {
name = "example-repo"
}
resource "aws_ecr_lifecyclepolicy" "example" {
repository = aws_ecr_repository.example.name
policy = "{\n \\\"rules\\\": [\n {\n \\\"rulePriority\\\": 1,\n \\\"description\\\": \\\"Expire images older than 14 days\\\",\n \\\"selection\\\": {\n \\\"tagStatus\\\": \\\"untagged\\\",\n \\\"countType\\\": \\\"sinceImagePushed\\\",\n \\\"countUnit\\\": \\\"days\\\",\n \\\"countNumber\\\": 14\n },\n \\\"action\\\": {\n \\\"type\\\": \\\"expire\\\"\n }\n }\n ]\n}\n"
}
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.LifecyclePolicy;
import com.pulumi.aws.ecr.LifecyclePolicyArgs;
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()
.name("example-repo")
.build());
var exampleLifecyclePolicy = new LifecyclePolicy("exampleLifecyclePolicy", LifecyclePolicyArgs.builder()
.repository(example.name())
.policy("""
{
\"rules\": [
{
\"rulePriority\": 1,
\"description\": \"Expire images older than 14 days\",
\"selection\": {
\"tagStatus\": \"untagged\",
\"countType\": \"sinceImagePushed\",
\"countUnit\": \"days\",
\"countNumber\": 14
},
\"action\": {
\"type\": \"expire\"
}
}
]
}
""")
.build());
}
}
resources:
example:
type: aws:ecr:Repository
properties:
name: example-repo
exampleLifecyclePolicy:
type: aws:ecr:LifecyclePolicy
name: example
properties:
repository: ${example.name}
policy: |
{
\"rules\": [
{
\"rulePriority\": 1,
\"description\": \"Expire images older than 14 days\",
\"selection\": {
\"tagStatus\": \"untagged\",
\"countType\": \"sinceImagePushed\",
\"countUnit\": \"days\",
\"countNumber\": 14
},
\"action\": {
\"type\": \"expire\"
}
}
]
}
Policy on Tagged Images
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ecr.Repository("example", {name: "example-repo"});
const exampleLifecyclePolicy = new aws.ecr.LifecyclePolicy("example", {
repository: example.name,
policy: `{
\\"rules\\": [
{
\\"rulePriority\\": 1,
\\"description\\": \\"Keep last 30 images\\",
\\"selection\\": {
\\"tagStatus\\": \\"tagged\\",
\\"tagPrefixList\\": [\\"v\\"],
\\"countType\\": \\"imageCountMoreThan\\",
\\"countNumber\\": 30
},
\\"action\\": {
\\"type\\": \\"expire\\"
}
}
]
}
`,
});
import pulumi
import pulumi_aws as aws
example = aws.ecr.Repository("example", name="example-repo")
example_lifecycle_policy = aws.ecr.LifecyclePolicy("example",
repository=example.name,
policy="""{
\"rules\": [
{
\"rulePriority\": 1,
\"description\": \"Keep last 30 images\",
\"selection\": {
\"tagStatus\": \"tagged\",
\"tagPrefixList\": [\"v\"],
\"countType\": \"imageCountMoreThan\",
\"countNumber\": 30
},
\"action\": {
\"type\": \"expire\"
}
}
]
}
""")
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()
{
Name = "example-repo",
});
var exampleLifecyclePolicy = new Aws.Ecr.LifecyclePolicy("example", new()
{
Repository = example.Name,
Policy = @"{
\""rules\"": [
{
\""rulePriority\"": 1,
\""description\"": \""Keep last 30 images\"",
\""selection\"": {
\""tagStatus\"": \""tagged\"",
\""tagPrefixList\"": [\""v\""],
\""countType\"": \""imageCountMoreThan\"",
\""countNumber\"": 30
},
\""action\"": {
\""type\"": \""expire\""
}
}
]
}
",
});
});
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 {
example, err := ecr.NewRepository(ctx, "example", &ecr.RepositoryArgs{
Name: pulumi.String("example-repo"),
})
if err != nil {
return err
}
_, err = ecr.NewLifecyclePolicy(ctx, "example", &ecr.LifecyclePolicyArgs{
Repository: example.Name,
Policy: pulumi.Any(`{
\"rules\": [
{
\"rulePriority\": 1,
\"description\": \"Keep last 30 images\",
\"selection\": {
\"tagStatus\": \"tagged\",
\"tagPrefixList\": [\"v\"],
\"countType\": \"imageCountMoreThan\",
\"countNumber\": 30
},
\"action\": {
\"type\": \"expire\"
}
}
]
}
`),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ecr_repository" "example" {
name = "example-repo"
}
resource "aws_ecr_lifecyclepolicy" "example" {
repository = aws_ecr_repository.example.name
policy = "{\n \\\"rules\\\": [\n {\n \\\"rulePriority\\\": 1,\n \\\"description\\\": \\\"Keep last 30 images\\\",\n \\\"selection\\\": {\n \\\"tagStatus\\\": \\\"tagged\\\",\n \\\"tagPrefixList\\\": [\\\"v\\\"],\n \\\"countType\\\": \\\"imageCountMoreThan\\\",\n \\\"countNumber\\\": 30\n },\n \\\"action\\\": {\n \\\"type\\\": \\\"expire\\\"\n }\n }\n ]\n}\n"
}
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.LifecyclePolicy;
import com.pulumi.aws.ecr.LifecyclePolicyArgs;
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()
.name("example-repo")
.build());
var exampleLifecyclePolicy = new LifecyclePolicy("exampleLifecyclePolicy", LifecyclePolicyArgs.builder()
.repository(example.name())
.policy("""
{
\"rules\": [
{
\"rulePriority\": 1,
\"description\": \"Keep last 30 images\",
\"selection\": {
\"tagStatus\": \"tagged\",
\"tagPrefixList\": [\"v\"],
\"countType\": \"imageCountMoreThan\",
\"countNumber\": 30
},
\"action\": {
\"type\": \"expire\"
}
}
]
}
""")
.build());
}
}
resources:
example:
type: aws:ecr:Repository
properties:
name: example-repo
exampleLifecyclePolicy:
type: aws:ecr:LifecyclePolicy
name: example
properties:
repository: ${example.name}
policy: |
{
\"rules\": [
{
\"rulePriority\": 1,
\"description\": \"Keep last 30 images\",
\"selection\": {
\"tagStatus\": \"tagged\",
\"tagPrefixList\": [\"v\"],
\"countType\": \"imageCountMoreThan\",
\"countNumber\": 30
},
\"action\": {
\"type\": \"expire\"
}
}
]
}
Policy to Archive and Delete
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ecr.Repository("example", {name: "example-repo"});
const exampleLifecyclePolicy = new aws.ecr.LifecyclePolicy("example", {
repository: example.name,
policy: `{
\\"rules\\": [
{
\\"rulePriority\\": 1,
\\"description\\": \\"Archive images not pulled in 90 days\\",
\\"selection\\": {
\\"tagStatus\\": \\"any\\",
\\"countType\\": \\"sinceImagePulled\\",
\\"countUnit\\": \\"days\\",
\\"countNumber\\": 90
},
\\"action\\": {
\\"type\\": \\"transition\\",
\\"targetStorageClass\\": \\"archive\\"
}
},
{
\\"rulePriority\\": 2,
\\"description\\": \\"Delete images archived for more than 365 days\\",
\\"selection\\": {
\\"tagStatus\\": \\"any\\",
\\"storageClass\\": \\"archive\\",
\\"countType\\": \\"sinceImageTransitioned\\",
\\"countUnit\\": \\"days\\",
\\"countNumber\\": 365
},
\\"action\\": {
\\"type\\": \\"expire\\"
}
}
]
}
`,
});
import pulumi
import pulumi_aws as aws
example = aws.ecr.Repository("example", name="example-repo")
example_lifecycle_policy = aws.ecr.LifecyclePolicy("example",
repository=example.name,
policy="""{
\"rules\": [
{
\"rulePriority\": 1,
\"description\": \"Archive images not pulled in 90 days\",
\"selection\": {
\"tagStatus\": \"any\",
\"countType\": \"sinceImagePulled\",
\"countUnit\": \"days\",
\"countNumber\": 90
},
\"action\": {
\"type\": \"transition\",
\"targetStorageClass\": \"archive\"
}
},
{
\"rulePriority\": 2,
\"description\": \"Delete images archived for more than 365 days\",
\"selection\": {
\"tagStatus\": \"any\",
\"storageClass\": \"archive\",
\"countType\": \"sinceImageTransitioned\",
\"countUnit\": \"days\",
\"countNumber\": 365
},
\"action\": {
\"type\": \"expire\"
}
}
]
}
""")
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()
{
Name = "example-repo",
});
var exampleLifecyclePolicy = new Aws.Ecr.LifecyclePolicy("example", new()
{
Repository = example.Name,
Policy = @"{
\""rules\"": [
{
\""rulePriority\"": 1,
\""description\"": \""Archive images not pulled in 90 days\"",
\""selection\"": {
\""tagStatus\"": \""any\"",
\""countType\"": \""sinceImagePulled\"",
\""countUnit\"": \""days\"",
\""countNumber\"": 90
},
\""action\"": {
\""type\"": \""transition\"",
\""targetStorageClass\"": \""archive\""
}
},
{
\""rulePriority\"": 2,
\""description\"": \""Delete images archived for more than 365 days\"",
\""selection\"": {
\""tagStatus\"": \""any\"",
\""storageClass\"": \""archive\"",
\""countType\"": \""sinceImageTransitioned\"",
\""countUnit\"": \""days\"",
\""countNumber\"": 365
},
\""action\"": {
\""type\"": \""expire\""
}
}
]
}
",
});
});
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 {
example, err := ecr.NewRepository(ctx, "example", &ecr.RepositoryArgs{
Name: pulumi.String("example-repo"),
})
if err != nil {
return err
}
_, err = ecr.NewLifecyclePolicy(ctx, "example", &ecr.LifecyclePolicyArgs{
Repository: example.Name,
Policy: pulumi.Any(`{
\"rules\": [
{
\"rulePriority\": 1,
\"description\": \"Archive images not pulled in 90 days\",
\"selection\": {
\"tagStatus\": \"any\",
\"countType\": \"sinceImagePulled\",
\"countUnit\": \"days\",
\"countNumber\": 90
},
\"action\": {
\"type\": \"transition\",
\"targetStorageClass\": \"archive\"
}
},
{
\"rulePriority\": 2,
\"description\": \"Delete images archived for more than 365 days\",
\"selection\": {
\"tagStatus\": \"any\",
\"storageClass\": \"archive\",
\"countType\": \"sinceImageTransitioned\",
\"countUnit\": \"days\",
\"countNumber\": 365
},
\"action\": {
\"type\": \"expire\"
}
}
]
}
`),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ecr_repository" "example" {
name = "example-repo"
}
resource "aws_ecr_lifecyclepolicy" "example" {
repository = aws_ecr_repository.example.name
policy = "{\n \\\"rules\\\": [\n {\n \\\"rulePriority\\\": 1,\n \\\"description\\\": \\\"Archive images not pulled in 90 days\\\",\n \\\"selection\\\": {\n \\\"tagStatus\\\": \\\"any\\\",\n \\\"countType\\\": \\\"sinceImagePulled\\\",\n \\\"countUnit\\\": \\\"days\\\",\n \\\"countNumber\\\": 90\n },\n \\\"action\\\": {\n \\\"type\\\": \\\"transition\\\",\n \\\"targetStorageClass\\\": \\\"archive\\\"\n }\n },\n {\n \\\"rulePriority\\\": 2,\n \\\"description\\\": \\\"Delete images archived for more than 365 days\\\",\n \\\"selection\\\": {\n \\\"tagStatus\\\": \\\"any\\\",\n \\\"storageClass\\\": \\\"archive\\\",\n \\\"countType\\\": \\\"sinceImageTransitioned\\\",\n \\\"countUnit\\\": \\\"days\\\",\n \\\"countNumber\\\": 365\n },\n \\\"action\\\": {\n \\\"type\\\": \\\"expire\\\"\n }\n }\n ]\n}\n"
}
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.LifecyclePolicy;
import com.pulumi.aws.ecr.LifecyclePolicyArgs;
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()
.name("example-repo")
.build());
var exampleLifecyclePolicy = new LifecyclePolicy("exampleLifecyclePolicy", LifecyclePolicyArgs.builder()
.repository(example.name())
.policy("""
{
\"rules\": [
{
\"rulePriority\": 1,
\"description\": \"Archive images not pulled in 90 days\",
\"selection\": {
\"tagStatus\": \"any\",
\"countType\": \"sinceImagePulled\",
\"countUnit\": \"days\",
\"countNumber\": 90
},
\"action\": {
\"type\": \"transition\",
\"targetStorageClass\": \"archive\"
}
},
{
\"rulePriority\": 2,
\"description\": \"Delete images archived for more than 365 days\",
\"selection\": {
\"tagStatus\": \"any\",
\"storageClass\": \"archive\",
\"countType\": \"sinceImageTransitioned\",
\"countUnit\": \"days\",
\"countNumber\": 365
},
\"action\": {
\"type\": \"expire\"
}
}
]
}
""")
.build());
}
}
resources:
example:
type: aws:ecr:Repository
properties:
name: example-repo
exampleLifecyclePolicy:
type: aws:ecr:LifecyclePolicy
name: example
properties:
repository: ${example.name}
policy: |
{
\"rules\": [
{
\"rulePriority\": 1,
\"description\": \"Archive images not pulled in 90 days\",
\"selection\": {
\"tagStatus\": \"any\",
\"countType\": \"sinceImagePulled\",
\"countUnit\": \"days\",
\"countNumber\": 90
},
\"action\": {
\"type\": \"transition\",
\"targetStorageClass\": \"archive\"
}
},
{
\"rulePriority\": 2,
\"description\": \"Delete images archived for more than 365 days\",
\"selection\": {
\"tagStatus\": \"any\",
\"storageClass\": \"archive\",
\"countType\": \"sinceImageTransitioned\",
\"countUnit\": \"days\",
\"countNumber\": 365
},
\"action\": {
\"type\": \"expire\"
}
}
]
}
Import
Identity Schema
Required
repository- (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 Lifecycle Policy using the name of the repository. For example:
$ pulumi import aws:ecr/lifecyclePolicy:LifecyclePolicy example tf-example
Constructors
- LifecyclePolicy(String name, {LifecyclePolicyArgs? args, CustomResourceOptions? options})
-
Creates a new LifecyclePolicy.
nameThe Pulumi resource name.argsArguments used to configure this LifecyclePolicy. The set of arguments for LifecyclePolicy.optionsResource options controlling this resource's behavior. - LifecyclePolicy.reference(String urn)
- Creates a typed reference to an existing LifecyclePolicy resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- 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
-
policy
↔ Output<
String> -
The policy document. This is a JSON formatted string. See more details about Policy Parameters in the official AWS docs. Consider using the
aws.ecr.getLifecyclePolicyDocumentdataSource to generate/manage the JSON document used for thepolicyargument.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
-
repository
↔ Output<
String> -
Name of the repository to apply the policy.
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
-
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, {LifecyclePolicyState? state, CustomResourceOptions? options}) → LifecyclePolicy -
Gets an existing LifecyclePolicy resource's state with the given
nameandid.