Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ecr
  5. RepositoryPolicy
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.ecr.RepositoryPolicy

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides an Elastic Container Registry Repository Policy.

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

    Example Usage

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

const exampleRepository = new aws.ecr.Repository("example", {name: "example-repo"});
const example = aws.iam.getPolicyDocument({
    statements: [{
        sid: "new policy",
        effect: "Allow",
        principals: [{
            type: "AWS",
            identifiers: ["123456789012"],
        }],
        actions: [
            "ecr:GetDownloadUrlForLayer",
            "ecr:BatchGetImage",
            "ecr:BatchCheckLayerAvailability",
            "ecr:PutImage",
            "ecr:InitiateLayerUpload",
            "ecr:UploadLayerPart",
            "ecr:CompleteLayerUpload",
            "ecr:DescribeRepositories",
            "ecr:GetRepositoryPolicy",
            "ecr:ListImages",
            "ecr:DeleteRepository",
            "ecr:BatchDeleteImage",
            "ecr:SetRepositoryPolicy",
            "ecr:DeleteRepositoryPolicy",
        ],
    }],
});
const exampleRepositoryPolicy = new aws.ecr.RepositoryPolicy("example", {
    repository: exampleRepository.name,
    policy: example.then(example => example.json),
});

    import pulumi
import pulumi_aws as aws

example_repository = aws.ecr.Repository("example", name="example-repo")
example = aws.iam.get_policy_document(statements=[{
    "sid": "new policy",
    "effect": "Allow",
    "principals": [{
        "type": "AWS",
        "identifiers": ["123456789012"],
    }],
    "actions": [
        "ecr:GetDownloadUrlForLayer",
        "ecr:BatchGetImage",
        "ecr:BatchCheckLayerAvailability",
        "ecr:PutImage",
        "ecr:InitiateLayerUpload",
        "ecr:UploadLayerPart",
        "ecr:CompleteLayerUpload",
        "ecr:DescribeRepositories",
        "ecr:GetRepositoryPolicy",
        "ecr:ListImages",
        "ecr:DeleteRepository",
        "ecr:BatchDeleteImage",
        "ecr:SetRepositoryPolicy",
        "ecr:DeleteRepositoryPolicy",
    ],
}])
example_repository_policy = aws.ecr.RepositoryPolicy("example",
    repository=example_repository.name,
    policy=example.json)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ecr"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleRepository, err := ecr.NewRepository(ctx, "example", &ecr.RepositoryArgs{
			Name: pulumi.String("example-repo"),
		})
		if err != nil {
			return err
		}
		example, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
			Statements: []iam.GetPolicyDocumentStatement{
				{
					Sid:    pulumi.StringRef("new policy"),
					Effect: pulumi.StringRef("Allow"),
					Principals: []iam.GetPolicyDocumentStatementPrincipal{
						{
							Type: "AWS",
							Identifiers: []string{
								"123456789012",
							},
						},
					},
					Actions: []string{
						"ecr:GetDownloadUrlForLayer",
						"ecr:BatchGetImage",
						"ecr:BatchCheckLayerAvailability",
						"ecr:PutImage",
						"ecr:InitiateLayerUpload",
						"ecr:UploadLayerPart",
						"ecr:CompleteLayerUpload",
						"ecr:DescribeRepositories",
						"ecr:GetRepositoryPolicy",
						"ecr:ListImages",
						"ecr:DeleteRepository",
						"ecr:BatchDeleteImage",
						"ecr:SetRepositoryPolicy",
						"ecr:DeleteRepositoryPolicy",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = ecr.NewRepositoryPolicy(ctx, "example", &ecr.RepositoryPolicyArgs{
			Repository: exampleRepository.Name,
			Policy:     pulumi.String(example.Json),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var exampleRepository = new Aws.Ecr.Repository("example", new()
    {
        Name = "example-repo",
    });

    var example = Aws.Iam.GetPolicyDocument.Invoke(new()
    {
        Statements = new[]
        {
            new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
            {
                Sid = "new policy",
                Effect = "Allow",
                Principals = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                    {
                        Type = "AWS",
                        Identifiers = new[]
                        {
                            "123456789012",
                        },
                    },
                },
                Actions = new[]
                {
                    "ecr:GetDownloadUrlForLayer",
                    "ecr:BatchGetImage",
                    "ecr:BatchCheckLayerAvailability",
                    "ecr:PutImage",
                    "ecr:InitiateLayerUpload",
                    "ecr:UploadLayerPart",
                    "ecr:CompleteLayerUpload",
                    "ecr:DescribeRepositories",
                    "ecr:GetRepositoryPolicy",
                    "ecr:ListImages",
                    "ecr:DeleteRepository",
                    "ecr:BatchDeleteImage",
                    "ecr:SetRepositoryPolicy",
                    "ecr:DeleteRepositoryPolicy",
                },
            },
        },
    });

    var exampleRepositoryPolicy = new Aws.Ecr.RepositoryPolicy("example", new()
    {
        Repository = exampleRepository.Name,
        Policy = example.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
    });

});

    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.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
import com.pulumi.aws.ecr.RepositoryPolicy;
import com.pulumi.aws.ecr.RepositoryPolicyArgs;
import java.util.List;
import java.util.ArrayList;
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 exampleRepository = new Repository("exampleRepository", RepositoryArgs.builder()
            .name("example-repo")
            .build());

        final var example = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
            .statements(GetPolicyDocumentStatementArgs.builder()
                .sid("new policy")
                .effect("Allow")
                .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                    .type("AWS")
                    .identifiers("123456789012")
                    .build())
                .actions(                
                    "ecr:GetDownloadUrlForLayer",
                    "ecr:BatchGetImage",
                    "ecr:BatchCheckLayerAvailability",
                    "ecr:PutImage",
                    "ecr:InitiateLayerUpload",
                    "ecr:UploadLayerPart",
                    "ecr:CompleteLayerUpload",
                    "ecr:DescribeRepositories",
                    "ecr:GetRepositoryPolicy",
                    "ecr:ListImages",
                    "ecr:DeleteRepository",
                    "ecr:BatchDeleteImage",
                    "ecr:SetRepositoryPolicy",
                    "ecr:DeleteRepositoryPolicy")
                .build())
            .build());

        var exampleRepositoryPolicy = new RepositoryPolicy("exampleRepositoryPolicy", RepositoryPolicyArgs.builder()
            .repository(exampleRepository.name())
            .policy(example.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult.json()))
            .build());

    }
}

    resources:
  exampleRepository:
    type: aws:ecr:Repository
    name: example
    properties:
      name: example-repo
  exampleRepositoryPolicy:
    type: aws:ecr:RepositoryPolicy
    name: example
    properties:
      repository: ${exampleRepository.name}
      policy: ${example.json}
variables:
  example:
    fn::invoke:
      Function: aws:iam:getPolicyDocument
      Arguments:
        statements:
          - sid: new policy
            effect: Allow
            principals:
              - type: AWS
                identifiers:
                  - '123456789012'
            actions:
              - ecr:GetDownloadUrlForLayer
              - ecr:BatchGetImage
              - ecr:BatchCheckLayerAvailability
              - ecr:PutImage
              - ecr:InitiateLayerUpload
              - ecr:UploadLayerPart
              - ecr:CompleteLayerUpload
              - ecr:DescribeRepositories
              - ecr:GetRepositoryPolicy
              - ecr:ListImages
              - ecr:DeleteRepository
              - ecr:BatchDeleteImage
              - ecr:SetRepositoryPolicy
              - ecr:DeleteRepositoryPolicy

    Create RepositoryPolicy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RepositoryPolicy(name: string, args: RepositoryPolicyArgs, opts?: CustomResourceOptions);
    @overload
def RepositoryPolicy(resource_name: str,
                     args: RepositoryPolicyArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def RepositoryPolicy(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     policy: Optional[str] = None,
                     repository: Optional[str] = None)
    func NewRepositoryPolicy(ctx *Context, name string, args RepositoryPolicyArgs, opts ...ResourceOption) (*RepositoryPolicy, error)
    public RepositoryPolicy(string name, RepositoryPolicyArgs args, CustomResourceOptions? opts = null)
    public RepositoryPolicy(String name, RepositoryPolicyArgs args)
public RepositoryPolicy(String name, RepositoryPolicyArgs args, CustomResourceOptions options)

    type: aws:ecr:RepositoryPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RepositoryPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RepositoryPolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RepositoryPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RepositoryPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RepositoryPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var repositoryPolicyResource = new Aws.Ecr.RepositoryPolicy("repositoryPolicyResource", new()
{
    Policy = "string",
    Repository = "string",
});

    example, err := ecr.NewRepositoryPolicy(ctx, "repositoryPolicyResource", &ecr.RepositoryPolicyArgs{
	Policy:     pulumi.Any("string"),
	Repository: pulumi.String("string"),
})

    var repositoryPolicyResource = new RepositoryPolicy("repositoryPolicyResource", RepositoryPolicyArgs.builder()
    .policy("string")
    .repository("string")
    .build());

    repository_policy_resource = aws.ecr.RepositoryPolicy("repositoryPolicyResource",
    policy="string",
    repository="string")

    const repositoryPolicyResource = new aws.ecr.RepositoryPolicy("repositoryPolicyResource", {
    policy: "string",
    repository: "string",
});

    type: aws:ecr:RepositoryPolicy
properties:
    policy: string
    repository: string

    RepositoryPolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RepositoryPolicy resource accepts the following input properties:

    Policy string | string
    The policy document. This is a JSON formatted string.
    Repository string
    Name of the repository to apply the policy.
    Policy string | string
    The policy document. This is a JSON formatted string.
    Repository string
    Name of the repository to apply the policy.
    policy String | String
    The policy document. This is a JSON formatted string.
    repository String
    Name of the repository to apply the policy.
    policy string | PolicyDocument
    The policy document. This is a JSON formatted string.
    repository string
    Name of the repository to apply the policy.
    policy str | str
    The policy document. This is a JSON formatted string.
    repository str
    Name of the repository to apply the policy.
    policy String |
    The policy document. This is a JSON formatted string.
    repository String
    Name of the repository to apply the policy.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RepositoryPolicy resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    RegistryId string
    The registry ID where the repository was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    RegistryId string
    The registry ID where the repository was created.
    id String
    The provider-assigned unique ID for this managed resource.
    registryId String
    The registry ID where the repository was created.
    id string
    The provider-assigned unique ID for this managed resource.
    registryId string
    The registry ID where the repository was created.
    id str
    The provider-assigned unique ID for this managed resource.
    registry_id str
    The registry ID where the repository was created.
    id String
    The provider-assigned unique ID for this managed resource.
    registryId String
    The registry ID where the repository was created.

    Look up Existing RepositoryPolicy Resource

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

    public static get(name: string, id: Input<ID>, state?: RepositoryPolicyState, opts?: CustomResourceOptions): RepositoryPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        policy: Optional[str] = None,
        registry_id: Optional[str] = None,
        repository: Optional[str] = None) -> RepositoryPolicy
    func GetRepositoryPolicy(ctx *Context, name string, id IDInput, state *RepositoryPolicyState, opts ...ResourceOption) (*RepositoryPolicy, error)
    public static RepositoryPolicy Get(string name, Input<string> id, RepositoryPolicyState? state, CustomResourceOptions? opts = null)
    public static RepositoryPolicy get(String name, Output<String> id, RepositoryPolicyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Policy string | string
    The policy document. This is a JSON formatted string.
    RegistryId string
    The registry ID where the repository was created.
    Repository string
    Name of the repository to apply the policy.
    Policy string | string
    The policy document. This is a JSON formatted string.
    RegistryId string
    The registry ID where the repository was created.
    Repository string
    Name of the repository to apply the policy.
    policy String | String
    The policy document. This is a JSON formatted string.
    registryId String
    The registry ID where the repository was created.
    repository String
    Name of the repository to apply the policy.
    policy string | PolicyDocument
    The policy document. This is a JSON formatted string.
    registryId string
    The registry ID where the repository was created.
    repository string
    Name of the repository to apply the policy.
    policy str | str
    The policy document. This is a JSON formatted string.
    registry_id str
    The registry ID where the repository was created.
    repository str
    Name of the repository to apply the policy.
    policy String |
    The policy document. This is a JSON formatted string.
    registryId String
    The registry ID where the repository was created.
    repository String
    Name of the repository to apply the policy.

    Import

    Using pulumi import, import ECR Repository Policy using the repository name. For example:

    $ pulumi import aws:ecr/repositoryPolicy:RepositoryPolicy example example

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws