getLifecyclePolicyDocument function

Future<GetLifecyclePolicyDocumentResult> getLifecyclePolicyDocument(
  1. GetLifecyclePolicyDocumentArgs args, {
  2. InvokeOptions? options,
})

Generates an ECR lifecycle policy document in JSON format. Can be used with resources such as the aws.ecr.LifecyclePolicy resource.

> For more information about building AWS ECR lifecycle policy documents, see the AWS ECR Lifecycle Policy Document Guide.

Example Usage

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

const example = aws.ecr.getLifecyclePolicyDocument({
    rules: [{
        selection: {
            tagStatus: "tagged",
            tagPrefixLists: ["prod"],
            countType: "imageCountMoreThan",
            countNumber: 100,
        },
        priority: 1,
        description: "This is a test.",
    }],
});
const exampleLifecyclePolicy = new aws.ecr.LifecyclePolicy("example", {
    repository: exampleAwsEcrRepository.name,
    policy: example.then(example => example.json),
});
import pulumi
import pulumi_aws as aws

example = aws.ecr.get_lifecycle_policy_document(rules=[{
    "selection": {
        "tag_status": "tagged",
        "tag_prefix_lists": ["prod"],
        "count_type": "imageCountMoreThan",
        "count_number": 100,
    },
    "priority": 1,
    "description": "This is a test.",
}])
example_lifecycle_policy = aws.ecr.LifecyclePolicy("example",
    repository=example_aws_ecr_repository["name"],
    policy=example.json)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = Aws.Ecr.GetLifecyclePolicyDocument.Invoke(new()
    {
        Rules = new[]
        {
            new Aws.Ecr.Inputs.GetLifecyclePolicyDocumentRuleInputArgs
            {
                Selection = new Aws.Ecr.Inputs.GetLifecyclePolicyDocumentRuleSelectionInputArgs
                {
                    TagStatus = "tagged",
                    TagPrefixLists = new[]
                    {
                        "prod",
                    },
                    CountType = "imageCountMoreThan",
                    CountNumber = 100,
                },
                Priority = 1,
                Description = "This is a test.",
            },
        },
    });

    var exampleLifecyclePolicy = new Aws.Ecr.LifecyclePolicy("example", new()
    {
        Repository = exampleAwsEcrRepository.Name,
        Policy = example.Apply(getLifecyclePolicyDocumentResult => getLifecyclePolicyDocumentResult.Json),
    });

});
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.GetLifecyclePolicyDocument(ctx, &ecr.GetLifecyclePolicyDocumentArgs{
			Rules: []ecr.GetLifecyclePolicyDocumentRule{
				{
					Selection: {
						TagStatus: "tagged",
						TagPrefixLists: []string{
							"prod",
						},
						CountType:   "imageCountMoreThan",
						CountNumber: 100,
					},
					Priority:    1,
					Description: pulumi.StringRef("This is a test."),
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = ecr.NewLifecyclePolicy(ctx, "example", &ecr.LifecyclePolicyArgs{
			Repository: pulumi.Any(exampleAwsEcrRepository.Name),
			Policy:     pulumi.String(example.Json),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ecr_getlifecyclepolicydocument" "example" {
  rules {
    selection = {
      tag_status       = "tagged"
      tag_prefix_lists = ["prod"]
      count_type       = "imageCountMoreThan"
      count_number     = 100
    }
    priority    = 1
    description = "This is a test."
  }
}

resource "aws_ecr_lifecyclepolicy" "example" {
  repository = exampleAwsEcrRepository.name
  policy     = data.aws_ecr_getlifecyclepolicydocument.example.json
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ecr.EcrFunctions;
import com.pulumi.aws.ecr.inputs.GetLifecyclePolicyDocumentArgs;
import com.pulumi.aws.ecr.inputs.GetLifecyclePolicyDocumentRuleArgs;
import com.pulumi.aws.ecr.inputs.GetLifecyclePolicyDocumentRuleSelectionArgs;
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) {
        final var example = EcrFunctions.getLifecyclePolicyDocument(GetLifecyclePolicyDocumentArgs.builder()
            .rules(GetLifecyclePolicyDocumentRuleArgs.builder()
                .selection(GetLifecyclePolicyDocumentRuleSelectionArgs.builder()
                    .tagStatus("tagged")
                    .tagPrefixLists("prod")
                    .countType("imageCountMoreThan")
                    .countNumber(100)
                    .build())
                .priority(1)
                .description("This is a test.")
                .build())
            .build());

        var exampleLifecyclePolicy = new LifecyclePolicy("exampleLifecyclePolicy", LifecyclePolicyArgs.builder()
            .repository(exampleAwsEcrRepository.name())
            .policy(example.json())
            .build());

    }
}
resources:
  exampleLifecyclePolicy:
    type: aws:ecr:LifecyclePolicy
    name: example
    properties:
      repository: ${exampleAwsEcrRepository.name}
      policy: ${example.json}
variables:
  example:
    fn::invoke:
      function: aws:ecr:getLifecyclePolicyDocument
      arguments:
        rules:
          - selection:
              tagStatus: tagged
              tagPrefixLists:
                - prod
              countType: imageCountMoreThan
              countNumber: 100
            priority: 1
            description: This is a test.

args Arguments passed to this invoke. Arguments for getLifecyclePolicyDocument. options Invoke options controlling this call.

Implementation

Future<GetLifecyclePolicyDocumentResult> getLifecyclePolicyDocument(
  GetLifecyclePolicyDocumentArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:ecr/getLifecyclePolicyDocument:getLifecyclePolicyDocument',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetLifecyclePolicyDocumentResult.fromMap(result);
}