1. Packages
  2. AWS Classic
  3. API Docs
  4. codeartifact
  5. Domain

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.30.0 published on Thursday, Apr 11, 2024 by Pulumi

aws.codeartifact.Domain

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.30.0 published on Thursday, Apr 11, 2024 by Pulumi

    Provides a CodeArtifact Domain Resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.codeartifact.Domain("example", {domain: "example"});
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.codeartifact.Domain("example", domain="example")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/codeartifact"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := codeartifact.NewDomain(ctx, "example", &codeartifact.DomainArgs{
    			Domain: pulumi.String("example"),
    		})
    		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 example = new Aws.CodeArtifact.Domain("example", new()
        {
            DomainName = "example",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.codeartifact.Domain;
    import com.pulumi.aws.codeartifact.DomainArgs;
    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 Domain("example", DomainArgs.builder()        
                .domain("example")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:codeartifact:Domain
        properties:
          domain: example
    

    Create Domain Resource

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

    Constructor syntax

    new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);
    @overload
    def Domain(resource_name: str,
               args: DomainArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Domain(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               domain: Optional[str] = None,
               encryption_key: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None)
    func NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)
    public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)
    public Domain(String name, DomainArgs args)
    public Domain(String name, DomainArgs args, CustomResourceOptions options)
    
    type: aws:codeartifact:Domain
    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 DomainArgs
    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 DomainArgs
    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 DomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var awsDomainResource = new Aws.CodeArtifact.Domain("awsDomainResource", new()
    {
        DomainName = "string",
        EncryptionKey = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := codeartifact.NewDomain(ctx, "awsDomainResource", &codeartifact.DomainArgs{
    	Domain:        pulumi.String("string"),
    	EncryptionKey: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var awsDomainResource = new Domain("awsDomainResource", DomainArgs.builder()        
        .domain("string")
        .encryptionKey("string")
        .tags(Map.of("string", "string"))
        .build());
    
    aws_domain_resource = aws.codeartifact.Domain("awsDomainResource",
        domain="string",
        encryption_key="string",
        tags={
            "string": "string",
        })
    
    const awsDomainResource = new aws.codeartifact.Domain("awsDomainResource", {
        domain: "string",
        encryptionKey: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:codeartifact:Domain
    properties:
        domain: string
        encryptionKey: string
        tags:
            string: string
    

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

    DomainName string
    The name of the domain to create. All domain names in an AWS Region that are in the same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.
    EncryptionKey string
    The encryption key for the domain. This is used to encrypt content stored in a domain. The KMS Key Amazon Resource Name (ARN). The default aws/codeartifact AWS KMS master key is used if this element is absent.
    Tags Dictionary<string, string>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Domain string
    The name of the domain to create. All domain names in an AWS Region that are in the same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.
    EncryptionKey string
    The encryption key for the domain. This is used to encrypt content stored in a domain. The KMS Key Amazon Resource Name (ARN). The default aws/codeartifact AWS KMS master key is used if this element is absent.
    Tags map[string]string
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    domain String
    The name of the domain to create. All domain names in an AWS Region that are in the same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.
    encryptionKey String
    The encryption key for the domain. This is used to encrypt content stored in a domain. The KMS Key Amazon Resource Name (ARN). The default aws/codeartifact AWS KMS master key is used if this element is absent.
    tags Map<String,String>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    domain string
    The name of the domain to create. All domain names in an AWS Region that are in the same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.
    encryptionKey string
    The encryption key for the domain. This is used to encrypt content stored in a domain. The KMS Key Amazon Resource Name (ARN). The default aws/codeartifact AWS KMS master key is used if this element is absent.
    tags {[key: string]: string}
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    domain str
    The name of the domain to create. All domain names in an AWS Region that are in the same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.
    encryption_key str
    The encryption key for the domain. This is used to encrypt content stored in a domain. The KMS Key Amazon Resource Name (ARN). The default aws/codeartifact AWS KMS master key is used if this element is absent.
    tags Mapping[str, str]
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    domain String
    The name of the domain to create. All domain names in an AWS Region that are in the same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.
    encryptionKey String
    The encryption key for the domain. This is used to encrypt content stored in a domain. The KMS Key Amazon Resource Name (ARN). The default aws/codeartifact AWS KMS master key is used if this element is absent.
    tags Map<String>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    The ARN of the Domain.
    AssetSizeBytes string
    The total size of all assets in the domain.
    CreatedTime string
    A timestamp that represents the date and time the domain was created in RFC3339 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    Owner string
    The AWS account ID that owns the domain.
    RepositoryCount int
    The number of repositories in the domain.
    S3BucketArn string
    The ARN of the Amazon S3 bucket that is used to store package assets in the domain.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the Domain.
    AssetSizeBytes string
    The total size of all assets in the domain.
    CreatedTime string
    A timestamp that represents the date and time the domain was created in RFC3339 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    Owner string
    The AWS account ID that owns the domain.
    RepositoryCount int
    The number of repositories in the domain.
    S3BucketArn string
    The ARN of the Amazon S3 bucket that is used to store package assets in the domain.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the Domain.
    assetSizeBytes String
    The total size of all assets in the domain.
    createdTime String
    A timestamp that represents the date and time the domain was created in RFC3339 format.
    id String
    The provider-assigned unique ID for this managed resource.
    owner String
    The AWS account ID that owns the domain.
    repositoryCount Integer
    The number of repositories in the domain.
    s3BucketArn String
    The ARN of the Amazon S3 bucket that is used to store package assets in the domain.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the Domain.
    assetSizeBytes string
    The total size of all assets in the domain.
    createdTime string
    A timestamp that represents the date and time the domain was created in RFC3339 format.
    id string
    The provider-assigned unique ID for this managed resource.
    owner string
    The AWS account ID that owns the domain.
    repositoryCount number
    The number of repositories in the domain.
    s3BucketArn string
    The ARN of the Amazon S3 bucket that is used to store package assets in the domain.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the Domain.
    asset_size_bytes str
    The total size of all assets in the domain.
    created_time str
    A timestamp that represents the date and time the domain was created in RFC3339 format.
    id str
    The provider-assigned unique ID for this managed resource.
    owner str
    The AWS account ID that owns the domain.
    repository_count int
    The number of repositories in the domain.
    s3_bucket_arn str
    The ARN of the Amazon S3 bucket that is used to store package assets in the domain.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the Domain.
    assetSizeBytes String
    The total size of all assets in the domain.
    createdTime String
    A timestamp that represents the date and time the domain was created in RFC3339 format.
    id String
    The provider-assigned unique ID for this managed resource.
    owner String
    The AWS account ID that owns the domain.
    repositoryCount Number
    The number of repositories in the domain.
    s3BucketArn String
    The ARN of the Amazon S3 bucket that is used to store package assets in the domain.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Domain Resource

    Get an existing Domain 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?: DomainState, opts?: CustomResourceOptions): Domain
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            asset_size_bytes: Optional[str] = None,
            created_time: Optional[str] = None,
            domain: Optional[str] = None,
            encryption_key: Optional[str] = None,
            owner: Optional[str] = None,
            repository_count: Optional[int] = None,
            s3_bucket_arn: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> Domain
    func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)
    public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)
    public static Domain get(String name, Output<String> id, DomainState 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:
    Arn string
    The ARN of the Domain.
    AssetSizeBytes string
    The total size of all assets in the domain.
    CreatedTime string
    A timestamp that represents the date and time the domain was created in RFC3339 format.
    DomainName string
    The name of the domain to create. All domain names in an AWS Region that are in the same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.
    EncryptionKey string
    The encryption key for the domain. This is used to encrypt content stored in a domain. The KMS Key Amazon Resource Name (ARN). The default aws/codeartifact AWS KMS master key is used if this element is absent.
    Owner string
    The AWS account ID that owns the domain.
    RepositoryCount int
    The number of repositories in the domain.
    S3BucketArn string
    The ARN of the Amazon S3 bucket that is used to store package assets in the domain.
    Tags Dictionary<string, string>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the Domain.
    AssetSizeBytes string
    The total size of all assets in the domain.
    CreatedTime string
    A timestamp that represents the date and time the domain was created in RFC3339 format.
    Domain string
    The name of the domain to create. All domain names in an AWS Region that are in the same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.
    EncryptionKey string
    The encryption key for the domain. This is used to encrypt content stored in a domain. The KMS Key Amazon Resource Name (ARN). The default aws/codeartifact AWS KMS master key is used if this element is absent.
    Owner string
    The AWS account ID that owns the domain.
    RepositoryCount int
    The number of repositories in the domain.
    S3BucketArn string
    The ARN of the Amazon S3 bucket that is used to store package assets in the domain.
    Tags map[string]string
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the Domain.
    assetSizeBytes String
    The total size of all assets in the domain.
    createdTime String
    A timestamp that represents the date and time the domain was created in RFC3339 format.
    domain String
    The name of the domain to create. All domain names in an AWS Region that are in the same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.
    encryptionKey String
    The encryption key for the domain. This is used to encrypt content stored in a domain. The KMS Key Amazon Resource Name (ARN). The default aws/codeartifact AWS KMS master key is used if this element is absent.
    owner String
    The AWS account ID that owns the domain.
    repositoryCount Integer
    The number of repositories in the domain.
    s3BucketArn String
    The ARN of the Amazon S3 bucket that is used to store package assets in the domain.
    tags Map<String,String>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the Domain.
    assetSizeBytes string
    The total size of all assets in the domain.
    createdTime string
    A timestamp that represents the date and time the domain was created in RFC3339 format.
    domain string
    The name of the domain to create. All domain names in an AWS Region that are in the same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.
    encryptionKey string
    The encryption key for the domain. This is used to encrypt content stored in a domain. The KMS Key Amazon Resource Name (ARN). The default aws/codeartifact AWS KMS master key is used if this element is absent.
    owner string
    The AWS account ID that owns the domain.
    repositoryCount number
    The number of repositories in the domain.
    s3BucketArn string
    The ARN of the Amazon S3 bucket that is used to store package assets in the domain.
    tags {[key: string]: string}
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the Domain.
    asset_size_bytes str
    The total size of all assets in the domain.
    created_time str
    A timestamp that represents the date and time the domain was created in RFC3339 format.
    domain str
    The name of the domain to create. All domain names in an AWS Region that are in the same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.
    encryption_key str
    The encryption key for the domain. This is used to encrypt content stored in a domain. The KMS Key Amazon Resource Name (ARN). The default aws/codeartifact AWS KMS master key is used if this element is absent.
    owner str
    The AWS account ID that owns the domain.
    repository_count int
    The number of repositories in the domain.
    s3_bucket_arn str
    The ARN of the Amazon S3 bucket that is used to store package assets in the domain.
    tags Mapping[str, str]
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the Domain.
    assetSizeBytes String
    The total size of all assets in the domain.
    createdTime String
    A timestamp that represents the date and time the domain was created in RFC3339 format.
    domain String
    The name of the domain to create. All domain names in an AWS Region that are in the same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.
    encryptionKey String
    The encryption key for the domain. This is used to encrypt content stored in a domain. The KMS Key Amazon Resource Name (ARN). The default aws/codeartifact AWS KMS master key is used if this element is absent.
    owner String
    The AWS account ID that owns the domain.
    repositoryCount Number
    The number of repositories in the domain.
    s3BucketArn String
    The ARN of the Amazon S3 bucket that is used to store package assets in the domain.
    tags Map<String>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import CodeArtifact Domain using the CodeArtifact Domain arn. For example:

    $ pulumi import aws:codeartifact/domain:Domain example arn:aws:codeartifact:us-west-2:012345678912:domain/tf-acc-test-8593714120730241305
    

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.30.0 published on Thursday, Apr 11, 2024 by Pulumi