Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. codeartifact
  5. DomainPermissions
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

aws.codeartifact.DomainPermissions

Explore with Pulumi AI

AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

Provides a CodeArtifact Domains Permissions Policy Resource.

Example Usage

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

const example = new aws.kms.Key("example", {description: "domain key"});
const exampleDomain = new aws.codeartifact.Domain("example", {
    domain: "example",
    encryptionKey: example.arn,
});
const test = aws.iam.getPolicyDocumentOutput({
    statements: [{
        effect: "Allow",
        principals: [{
            type: "*",
            identifiers: ["*"],
        }],
        actions: ["codeartifact:CreateRepository"],
        resources: [exampleDomain.arn],
    }],
});
const testDomainPermissions = new aws.codeartifact.DomainPermissions("test", {
    domain: exampleDomain.domain,
    policyDocument: test.apply(test => test.json),
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.kms.Key("example", description="domain key")
example_domain = aws.codeartifact.Domain("example",
    domain="example",
    encryption_key=example.arn)
test = aws.iam.get_policy_document_output(statements=[{
    "effect": "Allow",
    "principals": [{
        "type": "*",
        "identifiers": ["*"],
    }],
    "actions": ["codeartifact:CreateRepository"],
    "resources": [example_domain.arn],
}])
test_domain_permissions = aws.codeartifact.DomainPermissions("test",
    domain=example_domain.domain,
    policy_document=test.json)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := kms.NewKey(ctx, "example", &kms.KeyArgs{
			Description: pulumi.String("domain key"),
		})
		if err != nil {
			return err
		}
		exampleDomain, err := codeartifact.NewDomain(ctx, "example", &codeartifact.DomainArgs{
			Domain:        pulumi.String("example"),
			EncryptionKey: example.Arn,
		})
		if err != nil {
			return err
		}
		test := iam.GetPolicyDocumentOutput(ctx, iam.GetPolicyDocumentOutputArgs{
			Statements: iam.GetPolicyDocumentStatementArray{
				&iam.GetPolicyDocumentStatementArgs{
					Effect: pulumi.String("Allow"),
					Principals: iam.GetPolicyDocumentStatementPrincipalArray{
						&iam.GetPolicyDocumentStatementPrincipalArgs{
							Type: pulumi.String("*"),
							Identifiers: pulumi.StringArray{
								pulumi.String("*"),
							},
						},
					},
					Actions: pulumi.StringArray{
						pulumi.String("codeartifact:CreateRepository"),
					},
					Resources: pulumi.StringArray{
						exampleDomain.Arn,
					},
				},
			},
		}, nil)
		_, err = codeartifact.NewDomainPermissions(ctx, "test", &codeartifact.DomainPermissionsArgs{
			Domain: exampleDomain.Domain,
			PolicyDocument: pulumi.String(test.ApplyT(func(test iam.GetPolicyDocumentResult) (*string, error) {
				return &test.Json, nil
			}).(pulumi.StringPtrOutput)),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Kms.Key("example", new()
    {
        Description = "domain key",
    });

    var exampleDomain = new Aws.CodeArtifact.Domain("example", new()
    {
        DomainName = "example",
        EncryptionKey = example.Arn,
    });

    var test = Aws.Iam.GetPolicyDocument.Invoke(new()
    {
        Statements = new[]
        {
            new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
            {
                Effect = "Allow",
                Principals = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                    {
                        Type = "*",
                        Identifiers = new[]
                        {
                            "*",
                        },
                    },
                },
                Actions = new[]
                {
                    "codeartifact:CreateRepository",
                },
                Resources = new[]
                {
                    exampleDomain.Arn,
                },
            },
        },
    });

    var testDomainPermissions = new Aws.CodeArtifact.DomainPermissions("test", new()
    {
        Domain = exampleDomain.DomainName,
        PolicyDocument = test.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kms.Key;
import com.pulumi.aws.kms.KeyArgs;
import com.pulumi.aws.codeartifact.Domain;
import com.pulumi.aws.codeartifact.DomainArgs;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
import com.pulumi.aws.codeartifact.DomainPermissions;
import com.pulumi.aws.codeartifact.DomainPermissionsArgs;
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 example = new Key("example", KeyArgs.builder()
            .description("domain key")
            .build());

        var exampleDomain = new Domain("exampleDomain", DomainArgs.builder()
            .domain("example")
            .encryptionKey(example.arn())
            .build());

        final var test = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
            .statements(GetPolicyDocumentStatementArgs.builder()
                .effect("Allow")
                .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                    .type("*")
                    .identifiers("*")
                    .build())
                .actions("codeartifact:CreateRepository")
                .resources(exampleDomain.arn())
                .build())
            .build());

        var testDomainPermissions = new DomainPermissions("testDomainPermissions", DomainPermissionsArgs.builder()
            .domain(exampleDomain.domain())
            .policyDocument(test.applyValue(_test -> _test.json()))
            .build());

    }
}
Copy
resources:
  example:
    type: aws:kms:Key
    properties:
      description: domain key
  exampleDomain:
    type: aws:codeartifact:Domain
    name: example
    properties:
      domain: example
      encryptionKey: ${example.arn}
  testDomainPermissions:
    type: aws:codeartifact:DomainPermissions
    name: test
    properties:
      domain: ${exampleDomain.domain}
      policyDocument: ${test.json}
variables:
  test:
    fn::invoke:
      function: aws:iam:getPolicyDocument
      arguments:
        statements:
          - effect: Allow
            principals:
              - type: '*'
                identifiers:
                  - '*'
            actions:
              - codeartifact:CreateRepository
            resources:
              - ${exampleDomain.arn}
Copy

Create DomainPermissions Resource

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

Constructor syntax

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

@overload
def DomainPermissions(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      domain: Optional[str] = None,
                      policy_document: Optional[str] = None,
                      domain_owner: Optional[str] = None,
                      policy_revision: Optional[str] = None)
func NewDomainPermissions(ctx *Context, name string, args DomainPermissionsArgs, opts ...ResourceOption) (*DomainPermissions, error)
public DomainPermissions(string name, DomainPermissionsArgs args, CustomResourceOptions? opts = null)
public DomainPermissions(String name, DomainPermissionsArgs args)
public DomainPermissions(String name, DomainPermissionsArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DomainPermissionsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DomainPermissionsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DomainPermissionsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DomainPermissionsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DomainPermissionsArgs
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 domainPermissionsResource = new Aws.CodeArtifact.DomainPermissions("domainPermissionsResource", new()
{
    Domain = "string",
    PolicyDocument = "string",
    DomainOwner = "string",
    PolicyRevision = "string",
});
Copy
example, err := codeartifact.NewDomainPermissions(ctx, "domainPermissionsResource", &codeartifact.DomainPermissionsArgs{
	Domain:         pulumi.String("string"),
	PolicyDocument: pulumi.String("string"),
	DomainOwner:    pulumi.String("string"),
	PolicyRevision: pulumi.String("string"),
})
Copy
var domainPermissionsResource = new DomainPermissions("domainPermissionsResource", DomainPermissionsArgs.builder()
    .domain("string")
    .policyDocument("string")
    .domainOwner("string")
    .policyRevision("string")
    .build());
Copy
domain_permissions_resource = aws.codeartifact.DomainPermissions("domainPermissionsResource",
    domain="string",
    policy_document="string",
    domain_owner="string",
    policy_revision="string")
Copy
const domainPermissionsResource = new aws.codeartifact.DomainPermissions("domainPermissionsResource", {
    domain: "string",
    policyDocument: "string",
    domainOwner: "string",
    policyRevision: "string",
});
Copy
type: aws:codeartifact:DomainPermissions
properties:
    domain: string
    domainOwner: string
    policyDocument: string
    policyRevision: string
Copy

DomainPermissions 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 DomainPermissions resource accepts the following input properties:

Domain
This property is required.
Changes to this property will trigger replacement.
string
The name of the domain on which to set the resource policy.
PolicyDocument This property is required. string
A JSON policy string to be set as the access control resource policy on the provided domain.
DomainOwner Changes to this property will trigger replacement. string
The account number of the AWS account that owns the domain.
PolicyRevision string
The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.
Domain
This property is required.
Changes to this property will trigger replacement.
string
The name of the domain on which to set the resource policy.
PolicyDocument This property is required. string
A JSON policy string to be set as the access control resource policy on the provided domain.
DomainOwner Changes to this property will trigger replacement. string
The account number of the AWS account that owns the domain.
PolicyRevision string
The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.
domain
This property is required.
Changes to this property will trigger replacement.
String
The name of the domain on which to set the resource policy.
policyDocument This property is required. String
A JSON policy string to be set as the access control resource policy on the provided domain.
domainOwner Changes to this property will trigger replacement. String
The account number of the AWS account that owns the domain.
policyRevision String
The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.
domain
This property is required.
Changes to this property will trigger replacement.
string
The name of the domain on which to set the resource policy.
policyDocument This property is required. string
A JSON policy string to be set as the access control resource policy on the provided domain.
domainOwner Changes to this property will trigger replacement. string
The account number of the AWS account that owns the domain.
policyRevision string
The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.
domain
This property is required.
Changes to this property will trigger replacement.
str
The name of the domain on which to set the resource policy.
policy_document This property is required. str
A JSON policy string to be set as the access control resource policy on the provided domain.
domain_owner Changes to this property will trigger replacement. str
The account number of the AWS account that owns the domain.
policy_revision str
The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.
domain
This property is required.
Changes to this property will trigger replacement.
String
The name of the domain on which to set the resource policy.
policyDocument This property is required. String
A JSON policy string to be set as the access control resource policy on the provided domain.
domainOwner Changes to this property will trigger replacement. String
The account number of the AWS account that owns the domain.
policyRevision String
The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
ResourceArn string
The ARN of the resource associated with the resource policy.
Id string
The provider-assigned unique ID for this managed resource.
ResourceArn string
The ARN of the resource associated with the resource policy.
id String
The provider-assigned unique ID for this managed resource.
resourceArn String
The ARN of the resource associated with the resource policy.
id string
The provider-assigned unique ID for this managed resource.
resourceArn string
The ARN of the resource associated with the resource policy.
id str
The provider-assigned unique ID for this managed resource.
resource_arn str
The ARN of the resource associated with the resource policy.
id String
The provider-assigned unique ID for this managed resource.
resourceArn String
The ARN of the resource associated with the resource policy.

Look up Existing DomainPermissions Resource

Get an existing DomainPermissions 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?: DomainPermissionsState, opts?: CustomResourceOptions): DomainPermissions
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        domain: Optional[str] = None,
        domain_owner: Optional[str] = None,
        policy_document: Optional[str] = None,
        policy_revision: Optional[str] = None,
        resource_arn: Optional[str] = None) -> DomainPermissions
func GetDomainPermissions(ctx *Context, name string, id IDInput, state *DomainPermissionsState, opts ...ResourceOption) (*DomainPermissions, error)
public static DomainPermissions Get(string name, Input<string> id, DomainPermissionsState? state, CustomResourceOptions? opts = null)
public static DomainPermissions get(String name, Output<String> id, DomainPermissionsState state, CustomResourceOptions options)
resources:  _:    type: aws:codeartifact:DomainPermissions    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Domain Changes to this property will trigger replacement. string
The name of the domain on which to set the resource policy.
DomainOwner Changes to this property will trigger replacement. string
The account number of the AWS account that owns the domain.
PolicyDocument string
A JSON policy string to be set as the access control resource policy on the provided domain.
PolicyRevision string
The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.
ResourceArn string
The ARN of the resource associated with the resource policy.
Domain Changes to this property will trigger replacement. string
The name of the domain on which to set the resource policy.
DomainOwner Changes to this property will trigger replacement. string
The account number of the AWS account that owns the domain.
PolicyDocument string
A JSON policy string to be set as the access control resource policy on the provided domain.
PolicyRevision string
The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.
ResourceArn string
The ARN of the resource associated with the resource policy.
domain Changes to this property will trigger replacement. String
The name of the domain on which to set the resource policy.
domainOwner Changes to this property will trigger replacement. String
The account number of the AWS account that owns the domain.
policyDocument String
A JSON policy string to be set as the access control resource policy on the provided domain.
policyRevision String
The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.
resourceArn String
The ARN of the resource associated with the resource policy.
domain Changes to this property will trigger replacement. string
The name of the domain on which to set the resource policy.
domainOwner Changes to this property will trigger replacement. string
The account number of the AWS account that owns the domain.
policyDocument string
A JSON policy string to be set as the access control resource policy on the provided domain.
policyRevision string
The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.
resourceArn string
The ARN of the resource associated with the resource policy.
domain Changes to this property will trigger replacement. str
The name of the domain on which to set the resource policy.
domain_owner Changes to this property will trigger replacement. str
The account number of the AWS account that owns the domain.
policy_document str
A JSON policy string to be set as the access control resource policy on the provided domain.
policy_revision str
The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.
resource_arn str
The ARN of the resource associated with the resource policy.
domain Changes to this property will trigger replacement. String
The name of the domain on which to set the resource policy.
domainOwner Changes to this property will trigger replacement. String
The account number of the AWS account that owns the domain.
policyDocument String
A JSON policy string to be set as the access control resource policy on the provided domain.
policyRevision String
The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.
resourceArn String
The ARN of the resource associated with the resource policy.

Import

Using pulumi import, import CodeArtifact Domain Permissions Policies using the CodeArtifact Domain ARN. For example:

$ pulumi import aws:codeartifact/domainPermissions:DomainPermissions example arn:aws:codeartifact:us-west-2:012345678912:domain/tf-acc-test-1928056699409417367
Copy

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.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws