AWS v6.54.0, Sep 27 24

AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

aws.ecr.RegistryPolicy

Explore with Pulumi AI

AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

NOTE on ECR Registry Policies: While the AWS Management Console interface may suggest the ability to define multiple policies by creating multiple statements, ECR registry policies are effectively managed as singular entities at the regional level by the AWS APIs. Therefore, the aws.ecr.RegistryPolicy resource should be configured only once per region with all necessary statements defined in the same policy. Attempting to define multiple aws.ecr.RegistryPolicy resources may result in perpetual differences, with one policy overriding another.

Example Usage

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

const current = aws.getCallerIdentity({});
const currentGetRegion = aws.getRegion({});
const currentGetPartition = aws.getPartition({});
const example = new aws.ecr.RegistryPolicy("example", {policy: JSON.stringify({
    Version: "2012-10-17",
    Statement: [{
        Sid: "testpolicy",
        Effect: "Allow",
        Principal: {
            AWS: Promise.all([currentGetPartition, current]).then(([currentGetPartition, current]) => `arn:${currentGetPartition.partition}:iam::${current.accountId}:root`),
        },
        Action: ["ecr:ReplicateImage"],
        Resource: [Promise.all([currentGetPartition, currentGetRegion, current]).then(([currentGetPartition, currentGetRegion, current]) => `arn:${currentGetPartition.partition}:ecr:${currentGetRegion.name}:${current.accountId}:repository/*`)],
    }],
})});

import pulumi
import json
import pulumi_aws as aws

current = aws.get_caller_identity()
current_get_region = aws.get_region()
current_get_partition = aws.get_partition()
example = aws.ecr.RegistryPolicy("example", policy=json.dumps({
    "Version": "2012-10-17",
    "Statement": [{
        "Sid": "testpolicy",
        "Effect": "Allow",
        "Principal": {
            "AWS": f"arn:{current_get_partition.partition}:iam::{current.account_id}:root",
        },
        "Action": ["ecr:ReplicateImage"],
        "Resource": [f"arn:{current_get_partition.partition}:ecr:{current_get_region.name}:{current.account_id}:repository/*"],
    }],
}))

package main

import (
	"encoding/json"
	"fmt"

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := aws.GetCallerIdentity(ctx, nil, nil)
		if err != nil {
			return err
		}
		currentGetRegion, err := aws.GetRegion(ctx, nil, nil)
		if err != nil {
			return err
		}
		currentGetPartition, err := aws.GetPartition(ctx, nil, nil)
		if err != nil {
			return err
		}
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"Version": "2012-10-17",
			"Statement": []map[string]interface{}{
				map[string]interface{}{
					"Sid":    "testpolicy",
					"Effect": "Allow",
					"Principal": map[string]interface{}{
						"AWS": fmt.Sprintf("arn:%v:iam::%v:root", currentGetPartition.Partition, current.AccountId),
					},
					"Action": []string{
						"ecr:ReplicateImage",
					},
					"Resource": []string{
						fmt.Sprintf("arn:%v:ecr:%v:%v:repository/*", currentGetPartition.Partition, currentGetRegion.Name, current.AccountId),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = ecr.NewRegistryPolicy(ctx, "example", &ecr.RegistryPolicyArgs{
			Policy: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var current = Aws.GetCallerIdentity.Invoke();

    var currentGetRegion = Aws.GetRegion.Invoke();

    var currentGetPartition = Aws.GetPartition.Invoke();

    var example = new Aws.Ecr.RegistryPolicy("example", new()
    {
        Policy = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["Version"] = "2012-10-17",
            ["Statement"] = new[]
            {
                new Dictionary<string, object?>
                {
                    ["Sid"] = "testpolicy",
                    ["Effect"] = "Allow",
                    ["Principal"] = new Dictionary<string, object?>
                    {
                        ["AWS"] = Output.Tuple(currentGetPartition, current).Apply(values =>
                        {
                            var currentGetPartition = values.Item1;
                            var current = values.Item2;
                            return $"arn:{currentGetPartition.Apply(getPartitionResult => getPartitionResult.Partition)}:iam::{current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId)}:root";
                        }),
                    },
                    ["Action"] = new[]
                    {
                        "ecr:ReplicateImage",
                    },
                    ["Resource"] = new[]
                    {
                        Output.Tuple(currentGetPartition, currentGetRegion, current).Apply(values =>
                        {
                            var currentGetPartition = values.Item1;
                            var currentGetRegion = values.Item2;
                            var current = values.Item3;
                            return $"arn:{currentGetPartition.Apply(getPartitionResult => getPartitionResult.Partition)}:ecr:{currentGetRegion.Apply(getRegionResult => getRegionResult.Name)}:{current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId)}:repository/*";
                        }),
                    },
                },
            },
        }),
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.inputs.GetCallerIdentityArgs;
import com.pulumi.aws.inputs.GetRegionArgs;
import com.pulumi.aws.inputs.GetPartitionArgs;
import com.pulumi.aws.ecr.RegistryPolicy;
import com.pulumi.aws.ecr.RegistryPolicyArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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) {
        final var current = AwsFunctions.getCallerIdentity();

        final var currentGetRegion = AwsFunctions.getRegion();

        final var currentGetPartition = AwsFunctions.getPartition();

        var example = new RegistryPolicy("example", RegistryPolicyArgs.builder()
            .policy(serializeJson(
                jsonObject(
                    jsonProperty("Version", "2012-10-17"),
                    jsonProperty("Statement", jsonArray(jsonObject(
                        jsonProperty("Sid", "testpolicy"),
                        jsonProperty("Effect", "Allow"),
                        jsonProperty("Principal", jsonObject(
                            jsonProperty("AWS", String.format("arn:%s:iam::%s:root", currentGetPartition.applyValue(getPartitionResult -> getPartitionResult.partition()),current.applyValue(getCallerIdentityResult -> getCallerIdentityResult.accountId())))
                        )),
                        jsonProperty("Action", jsonArray("ecr:ReplicateImage")),
                        jsonProperty("Resource", jsonArray(String.format("arn:%s:ecr:%s:%s:repository/*", currentGetPartition.applyValue(getPartitionResult -> getPartitionResult.partition()),currentGetRegion.applyValue(getRegionResult -> getRegionResult.name()),current.applyValue(getCallerIdentityResult -> getCallerIdentityResult.accountId()))))
                    )))
                )))
            .build());

    }
}

resources:
  example:
    type: aws:ecr:RegistryPolicy
    properties:
      policy:
        fn::toJSON:
          Version: 2012-10-17
          Statement:
            - Sid: testpolicy
              Effect: Allow
              Principal:
                AWS: arn:${currentGetPartition.partition}:iam::${current.accountId}:root
              Action:
                - ecr:ReplicateImage
              Resource:
                - arn:${currentGetPartition.partition}:ecr:${currentGetRegion.name}:${current.accountId}:repository/*
variables:
  current:
    fn::invoke:
      Function: aws:getCallerIdentity
      Arguments: {}
  currentGetRegion:
    fn::invoke:
      Function: aws:getRegion
      Arguments: {}
  currentGetPartition:
    fn::invoke:
      Function: aws:getPartition
      Arguments: {}

Create RegistryPolicy Resource

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

Constructor syntax

new RegistryPolicy(name: string, args: RegistryPolicyArgs, opts?: CustomResourceOptions);

@overload
def RegistryPolicy(resource_name: str,
                   args: RegistryPolicyArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def RegistryPolicy(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   policy: Optional[str] = None)

func NewRegistryPolicy(ctx *Context, name string, args RegistryPolicyArgs, opts ...ResourceOption) (*RegistryPolicy, error)

public RegistryPolicy(string name, RegistryPolicyArgs args, CustomResourceOptions? opts = null)

public RegistryPolicy(String name, RegistryPolicyArgs args)
public RegistryPolicy(String name, RegistryPolicyArgs args, CustomResourceOptions options)

type: aws:ecr:RegistryPolicy
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 RegistryPolicyArgs: 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 RegistryPolicyArgs: 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 RegistryPolicyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RegistryPolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RegistryPolicyArgs: 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 registryPolicyResource = new Aws.Ecr.RegistryPolicy("registryPolicyResource", new()
{
    Policy = "string",
});

example, err := ecr.NewRegistryPolicy(ctx, "registryPolicyResource", &ecr.RegistryPolicyArgs{
	Policy: pulumi.Any("string"),
})

var registryPolicyResource = new RegistryPolicy("registryPolicyResource", RegistryPolicyArgs.builder()
    .policy("string")
    .build());

registry_policy_resource = aws.ecr.RegistryPolicy("registryPolicyResource", policy="string")

const registryPolicyResource = new aws.ecr.RegistryPolicy("registryPolicyResource", {policy: "string"});

type: aws:ecr:RegistryPolicy
properties:
    policy: string

RegistryPolicy Resource Properties

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

Inputs

The RegistryPolicy resource accepts the following input properties:

Policy string | string: The policy document. This is a JSON formatted string.

Policy string | string: The policy document. This is a JSON formatted string.

policy String | String: The policy document. This is a JSON formatted string.

policy string | PolicyDocument: The policy document. This is a JSON formatted string.

policy str | str: The policy document. This is a JSON formatted string.

policy String |: The policy document. This is a JSON formatted string.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
RegistryId string: The registry ID where the registry was created.

Id string: The provider-assigned unique ID for this managed resource.
RegistryId string: The registry ID where the registry was created.

id String: The provider-assigned unique ID for this managed resource.
registryId String: The registry ID where the registry was created.

id string: The provider-assigned unique ID for this managed resource.
registryId string: The registry ID where the registry was created.

id str: The provider-assigned unique ID for this managed resource.
registry_id str: The registry ID where the registry was created.

id String: The provider-assigned unique ID for this managed resource.
registryId String: The registry ID where the registry was created.

Look up Existing RegistryPolicy Resource

Get an existing RegistryPolicy 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?: RegistryPolicyState, opts?: CustomResourceOptions): RegistryPolicy

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        policy: Optional[str] = None,
        registry_id: Optional[str] = None) -> RegistryPolicy

func GetRegistryPolicy(ctx *Context, name string, id IDInput, state *RegistryPolicyState, opts ...ResourceOption) (*RegistryPolicy, error)

public static RegistryPolicy Get(string name, Input<string> id, RegistryPolicyState? state, CustomResourceOptions? opts = null)

public static RegistryPolicy get(String name, Output<String> id, RegistryPolicyState 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 registry was created.

Policy string | string: The policy document. This is a JSON formatted string.
RegistryId string: The registry ID where the registry was created.

policy String | String: The policy document. This is a JSON formatted string.
registryId String: The registry ID where the registry was created.

policy string | PolicyDocument: The policy document. This is a JSON formatted string.
registryId string: The registry ID where the registry was created.

policy str | str: The policy document. This is a JSON formatted string.
registry_id str: The registry ID where the registry was created.

policy String |: The policy document. This is a JSON formatted string.
registryId String: The registry ID where the registry was created.

Import

Using pulumi import, import ECR Registry Policy using the registry id. For example:

$ pulumi import aws:ecr/registryPolicy:RegistryPolicy example 123456789012

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 v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

pulumi/pulumi-aws

aws.ecr.RegistryPolicy

On this page

On this page

Example Usage

Create RegistryPolicy Resource

Constructor syntax

Parameters

Constructor example

RegistryPolicy Resource Properties

Inputs

Outputs

Look up Existing RegistryPolicy Resource

Import

Package Details

On this page

On this page