Class LifecyclePolicy


  • public class LifecyclePolicy
    extends com.pulumi.resources.CustomResource
    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
     
     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());
     
         }
     }
     
     
    ### Policy on Tagged Images
     
     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());
     
         }
     }
     
     
    ### Policy to Archive and Delete
     
     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());
     
         }
     }
     
     
    ## 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: ```sh $ pulumi import aws:ecr/lifecyclePolicy:LifecyclePolicy example tf-example ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static LifecyclePolicy get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, LifecyclePolicyState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> policy()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> registryId()  
      com.pulumi.core.Output<java.lang.String> repository()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • LifecyclePolicy

        public LifecyclePolicy​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • LifecyclePolicy

        public LifecyclePolicy​(java.lang.String name,
                               LifecyclePolicyArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • LifecyclePolicy

        public LifecyclePolicy​(java.lang.String name,
                               LifecyclePolicyArgs args,
                               @Nullable
                               com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • policy

        public com.pulumi.core.Output<java.lang.String> policy()
        Returns:
        The policy document. This is a JSON formatted string. See more details about [Policy Parameters](http://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html#lifecycle_policy_parameters) in the official AWS docs. Consider using the `aws.ecr.getLifecyclePolicyDocument` dataSource to generate/manage the JSON document used for the `policy` argument.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • registryId

        public com.pulumi.core.Output<java.lang.String> registryId()
        Returns:
        The registry ID where the repository was created.
      • repository

        public com.pulumi.core.Output<java.lang.String> repository()
        Returns:
        Name of the repository to apply the policy.
      • get

        public static LifecyclePolicy get​(java.lang.String name,
                                          com.pulumi.core.Output<java.lang.String> id,
                                          @Nullable
                                          LifecyclePolicyState state,
                                          @Nullable
                                          com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.