Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Artifactory Provider
  3. API Docs
  4. DockerV2Repository
artifactory v8.8.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-artifactory

artifactory.DockerV2Repository

Explore with Pulumi AI

artifactory logo
artifactory v8.8.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-artifactory

    Creates a local Docker v2 repository.

    Example Usage

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

const foo = new artifactory.DockerV2Repository("foo", {
    key: "foo",
    tagRetention: 3,
    maxUniqueTags: 5,
});

    import pulumi
import pulumi_artifactory as artifactory

foo = artifactory.DockerV2Repository("foo",
    key="foo",
    tag_retention=3,
    max_unique_tags=5)

    package main

import (
	"github.com/pulumi/pulumi-artifactory/sdk/v8/go/artifactory"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := artifactory.NewDockerV2Repository(ctx, "foo", &artifactory.DockerV2RepositoryArgs{
			Key:           pulumi.String("foo"),
			TagRetention:  pulumi.Int(3),
			MaxUniqueTags: pulumi.Int(5),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = new Artifactory.DockerV2Repository("foo", new()
    {
        Key = "foo",
        TagRetention = 3,
        MaxUniqueTags = 5,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.artifactory.DockerV2Repository;
import com.pulumi.artifactory.DockerV2RepositoryArgs;
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 foo = new DockerV2Repository("foo", DockerV2RepositoryArgs.builder()
            .key("foo")
            .tagRetention(3)
            .maxUniqueTags(5)
            .build());

    }
}

    resources:
  foo:
    type: artifactory:DockerV2Repository
    properties:
      key: foo
      tagRetention: 3
      maxUniqueTags: 5

    Create DockerV2Repository Resource

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

    Constructor syntax

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

@overload
def DockerV2Repository(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       key: Optional[str] = None,
                       description: Optional[str] = None,
                       notes: Optional[str] = None,
                       cdn_redirect: Optional[bool] = None,
                       archive_browsing_enabled: Optional[bool] = None,
                       download_direct: Optional[bool] = None,
                       excludes_pattern: Optional[str] = None,
                       includes_pattern: Optional[str] = None,
                       blacked_out: Optional[bool] = None,
                       block_pushing_schema1: Optional[bool] = None,
                       priority_resolution: Optional[bool] = None,
                       max_unique_tags: Optional[int] = None,
                       project_environments: Optional[Sequence[str]] = None,
                       project_key: Optional[str] = None,
                       property_sets: Optional[Sequence[str]] = None,
                       repo_layout_ref: Optional[str] = None,
                       tag_retention: Optional[int] = None,
                       xray_index: Optional[bool] = None)
    func NewDockerV2Repository(ctx *Context, name string, args DockerV2RepositoryArgs, opts ...ResourceOption) (*DockerV2Repository, error)
    public DockerV2Repository(string name, DockerV2RepositoryArgs args, CustomResourceOptions? opts = null)
    public DockerV2Repository(String name, DockerV2RepositoryArgs args)
public DockerV2Repository(String name, DockerV2RepositoryArgs args, CustomResourceOptions options)

    type: artifactory:DockerV2Repository
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 DockerV2RepositoryArgs
    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 DockerV2RepositoryArgs
    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 DockerV2RepositoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DockerV2RepositoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DockerV2RepositoryArgs
    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 dockerV2RepositoryResource = new Artifactory.DockerV2Repository("dockerV2RepositoryResource", new()
{
    Key = "string",
    Description = "string",
    Notes = "string",
    CdnRedirect = false,
    ArchiveBrowsingEnabled = false,
    DownloadDirect = false,
    ExcludesPattern = "string",
    IncludesPattern = "string",
    BlackedOut = false,
    BlockPushingSchema1 = false,
    PriorityResolution = false,
    MaxUniqueTags = 0,
    ProjectEnvironments = new[]
    {
        "string",
    },
    ProjectKey = "string",
    PropertySets = new[]
    {
        "string",
    },
    RepoLayoutRef = "string",
    TagRetention = 0,
    XrayIndex = false,
});

    example, err := artifactory.NewDockerV2Repository(ctx, "dockerV2RepositoryResource", &artifactory.DockerV2RepositoryArgs{
	Key:                    pulumi.String("string"),
	Description:            pulumi.String("string"),
	Notes:                  pulumi.String("string"),
	CdnRedirect:            pulumi.Bool(false),
	ArchiveBrowsingEnabled: pulumi.Bool(false),
	DownloadDirect:         pulumi.Bool(false),
	ExcludesPattern:        pulumi.String("string"),
	IncludesPattern:        pulumi.String("string"),
	BlackedOut:             pulumi.Bool(false),
	BlockPushingSchema1:    pulumi.Bool(false),
	PriorityResolution:     pulumi.Bool(false),
	MaxUniqueTags:          pulumi.Int(0),
	ProjectEnvironments: pulumi.StringArray{
		pulumi.String("string"),
	},
	ProjectKey: pulumi.String("string"),
	PropertySets: pulumi.StringArray{
		pulumi.String("string"),
	},
	RepoLayoutRef: pulumi.String("string"),
	TagRetention:  pulumi.Int(0),
	XrayIndex:     pulumi.Bool(false),
})

    var dockerV2RepositoryResource = new DockerV2Repository("dockerV2RepositoryResource", DockerV2RepositoryArgs.builder()
    .key("string")
    .description("string")
    .notes("string")
    .cdnRedirect(false)
    .archiveBrowsingEnabled(false)
    .downloadDirect(false)
    .excludesPattern("string")
    .includesPattern("string")
    .blackedOut(false)
    .blockPushingSchema1(false)
    .priorityResolution(false)
    .maxUniqueTags(0)
    .projectEnvironments("string")
    .projectKey("string")
    .propertySets("string")
    .repoLayoutRef("string")
    .tagRetention(0)
    .xrayIndex(false)
    .build());

    docker_v2_repository_resource = artifactory.DockerV2Repository("dockerV2RepositoryResource",
    key="string",
    description="string",
    notes="string",
    cdn_redirect=False,
    archive_browsing_enabled=False,
    download_direct=False,
    excludes_pattern="string",
    includes_pattern="string",
    blacked_out=False,
    block_pushing_schema1=False,
    priority_resolution=False,
    max_unique_tags=0,
    project_environments=["string"],
    project_key="string",
    property_sets=["string"],
    repo_layout_ref="string",
    tag_retention=0,
    xray_index=False)

    const dockerV2RepositoryResource = new artifactory.DockerV2Repository("dockerV2RepositoryResource", {
    key: "string",
    description: "string",
    notes: "string",
    cdnRedirect: false,
    archiveBrowsingEnabled: false,
    downloadDirect: false,
    excludesPattern: "string",
    includesPattern: "string",
    blackedOut: false,
    blockPushingSchema1: false,
    priorityResolution: false,
    maxUniqueTags: 0,
    projectEnvironments: ["string"],
    projectKey: "string",
    propertySets: ["string"],
    repoLayoutRef: "string",
    tagRetention: 0,
    xrayIndex: false,
});

    type: artifactory:DockerV2Repository
properties:
    archiveBrowsingEnabled: false
    blackedOut: false
    blockPushingSchema1: false
    cdnRedirect: false
    description: string
    downloadDirect: false
    excludesPattern: string
    includesPattern: string
    key: string
    maxUniqueTags: 0
    notes: string
    priorityResolution: false
    projectEnvironments:
        - string
    projectKey: string
    propertySets:
        - string
    repoLayoutRef: string
    tagRetention: 0
    xrayIndex: false

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

    Key string
    the identity key of the repo.
    ArchiveBrowsingEnabled bool
    When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
    BlackedOut bool
    When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
    BlockPushingSchema1 bool
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    CdnRedirect bool
    When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
    Description string
    Public description.
    DownloadDirect bool
    When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
    ExcludesPattern string
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    IncludesPattern string
    List of comma-separated artifact patterns to include when evaluating artifact requests in the form of x/y/**/z/*. When used, only artifacts matching one of the include patterns are served. By default, all artifacts are included (**/*).
    MaxUniqueTags int
    The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2.
    Notes string
    Internal description.
    PriorityResolution bool
    Setting repositories with priority will cause metadata to be merged only from repositories set with this field
    ProjectEnvironments List<string>
    ProjectKey string
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    PropertySets List<string>
    List of property set name
    RepoLayoutRef string
    Sets the layout that the repository should use for storing and identifying modules. A recommended layout that corresponds to the package type defined is suggested, and index packages uploaded and calculate metadata accordingly.
    TagRetention int
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    XrayIndex bool
    Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
    Key string
    the identity key of the repo.
    ArchiveBrowsingEnabled bool
    When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
    BlackedOut bool
    When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
    BlockPushingSchema1 bool
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    CdnRedirect bool
    When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
    Description string
    Public description.
    DownloadDirect bool
    When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
    ExcludesPattern string
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    IncludesPattern string
    List of comma-separated artifact patterns to include when evaluating artifact requests in the form of x/y/**/z/*. When used, only artifacts matching one of the include patterns are served. By default, all artifacts are included (**/*).
    MaxUniqueTags int
    The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2.
    Notes string
    Internal description.
    PriorityResolution bool
    Setting repositories with priority will cause metadata to be merged only from repositories set with this field
    ProjectEnvironments []string
    ProjectKey string
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    PropertySets []string
    List of property set name
    RepoLayoutRef string
    Sets the layout that the repository should use for storing and identifying modules. A recommended layout that corresponds to the package type defined is suggested, and index packages uploaded and calculate metadata accordingly.
    TagRetention int
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    XrayIndex bool
    Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
    key String
    the identity key of the repo.
    archiveBrowsingEnabled Boolean
    When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
    blackedOut Boolean
    When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
    blockPushingSchema1 Boolean
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    cdnRedirect Boolean
    When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
    description String
    Public description.
    downloadDirect Boolean
    When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
    excludesPattern String
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    includesPattern String
    List of comma-separated artifact patterns to include when evaluating artifact requests in the form of x/y/**/z/*. When used, only artifacts matching one of the include patterns are served. By default, all artifacts are included (**/*).
    maxUniqueTags Integer
    The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2.
    notes String
    Internal description.
    priorityResolution Boolean
    Setting repositories with priority will cause metadata to be merged only from repositories set with this field
    projectEnvironments List<String>
    projectKey String
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    propertySets List<String>
    List of property set name
    repoLayoutRef String
    Sets the layout that the repository should use for storing and identifying modules. A recommended layout that corresponds to the package type defined is suggested, and index packages uploaded and calculate metadata accordingly.
    tagRetention Integer
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    xrayIndex Boolean
    Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
    key string
    the identity key of the repo.
    archiveBrowsingEnabled boolean
    When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
    blackedOut boolean
    When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
    blockPushingSchema1 boolean
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    cdnRedirect boolean
    When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
    description string
    Public description.
    downloadDirect boolean
    When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
    excludesPattern string
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    includesPattern string
    List of comma-separated artifact patterns to include when evaluating artifact requests in the form of x/y/**/z/*. When used, only artifacts matching one of the include patterns are served. By default, all artifacts are included (**/*).
    maxUniqueTags number
    The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2.
    notes string
    Internal description.
    priorityResolution boolean
    Setting repositories with priority will cause metadata to be merged only from repositories set with this field
    projectEnvironments string[]
    projectKey string
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    propertySets string[]
    List of property set name
    repoLayoutRef string
    Sets the layout that the repository should use for storing and identifying modules. A recommended layout that corresponds to the package type defined is suggested, and index packages uploaded and calculate metadata accordingly.
    tagRetention number
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    xrayIndex boolean
    Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
    key str
    the identity key of the repo.
    archive_browsing_enabled bool
    When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
    blacked_out bool
    When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
    block_pushing_schema1 bool
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    cdn_redirect bool
    When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
    description str
    Public description.
    download_direct bool
    When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
    excludes_pattern str
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    includes_pattern str
    List of comma-separated artifact patterns to include when evaluating artifact requests in the form of x/y/**/z/*. When used, only artifacts matching one of the include patterns are served. By default, all artifacts are included (**/*).
    max_unique_tags int
    The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2.
    notes str
    Internal description.
    priority_resolution bool
    Setting repositories with priority will cause metadata to be merged only from repositories set with this field
    project_environments Sequence[str]
    project_key str
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    property_sets Sequence[str]
    List of property set name
    repo_layout_ref str
    Sets the layout that the repository should use for storing and identifying modules. A recommended layout that corresponds to the package type defined is suggested, and index packages uploaded and calculate metadata accordingly.
    tag_retention int
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    xray_index bool
    Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
    key String
    the identity key of the repo.
    archiveBrowsingEnabled Boolean
    When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
    blackedOut Boolean
    When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
    blockPushingSchema1 Boolean
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    cdnRedirect Boolean
    When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
    description String
    Public description.
    downloadDirect Boolean
    When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
    excludesPattern String
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    includesPattern String
    List of comma-separated artifact patterns to include when evaluating artifact requests in the form of x/y/**/z/*. When used, only artifacts matching one of the include patterns are served. By default, all artifacts are included (**/*).
    maxUniqueTags Number
    The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2.
    notes String
    Internal description.
    priorityResolution Boolean
    Setting repositories with priority will cause metadata to be merged only from repositories set with this field
    projectEnvironments List<String>
    projectKey String
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    propertySets List<String>
    List of property set name
    repoLayoutRef String
    Sets the layout that the repository should use for storing and identifying modules. A recommended layout that corresponds to the package type defined is suggested, and index packages uploaded and calculate metadata accordingly.
    tagRetention Number
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    xrayIndex Boolean
    Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.

    Outputs

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

    ApiVersion string
    The Docker API version to use.
    Id string
    The provider-assigned unique ID for this managed resource.
    ApiVersion string
    The Docker API version to use.
    Id string
    The provider-assigned unique ID for this managed resource.
    apiVersion String
    The Docker API version to use.
    id String
    The provider-assigned unique ID for this managed resource.
    apiVersion string
    The Docker API version to use.
    id string
    The provider-assigned unique ID for this managed resource.
    api_version str
    The Docker API version to use.
    id str
    The provider-assigned unique ID for this managed resource.
    apiVersion String
    The Docker API version to use.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DockerV2Repository Resource

    Get an existing DockerV2Repository 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?: DockerV2RepositoryState, opts?: CustomResourceOptions): DockerV2Repository
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_version: Optional[str] = None,
        archive_browsing_enabled: Optional[bool] = None,
        blacked_out: Optional[bool] = None,
        block_pushing_schema1: Optional[bool] = None,
        cdn_redirect: Optional[bool] = None,
        description: Optional[str] = None,
        download_direct: Optional[bool] = None,
        excludes_pattern: Optional[str] = None,
        includes_pattern: Optional[str] = None,
        key: Optional[str] = None,
        max_unique_tags: Optional[int] = None,
        notes: Optional[str] = None,
        priority_resolution: Optional[bool] = None,
        project_environments: Optional[Sequence[str]] = None,
        project_key: Optional[str] = None,
        property_sets: Optional[Sequence[str]] = None,
        repo_layout_ref: Optional[str] = None,
        tag_retention: Optional[int] = None,
        xray_index: Optional[bool] = None) -> DockerV2Repository
    func GetDockerV2Repository(ctx *Context, name string, id IDInput, state *DockerV2RepositoryState, opts ...ResourceOption) (*DockerV2Repository, error)
    public static DockerV2Repository Get(string name, Input<string> id, DockerV2RepositoryState? state, CustomResourceOptions? opts = null)
    public static DockerV2Repository get(String name, Output<String> id, DockerV2RepositoryState state, CustomResourceOptions options)
    resources:  _:    type: artifactory:DockerV2Repository    get:      id: ${id}
    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:
    ApiVersion string
    The Docker API version to use.
    ArchiveBrowsingEnabled bool
    When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
    BlackedOut bool
    When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
    BlockPushingSchema1 bool
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    CdnRedirect bool
    When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
    Description string
    Public description.
    DownloadDirect bool
    When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
    ExcludesPattern string
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    IncludesPattern string
    List of comma-separated artifact patterns to include when evaluating artifact requests in the form of x/y/**/z/*. When used, only artifacts matching one of the include patterns are served. By default, all artifacts are included (**/*).
    Key string
    the identity key of the repo.
    MaxUniqueTags int
    The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2.
    Notes string
    Internal description.
    PriorityResolution bool
    Setting repositories with priority will cause metadata to be merged only from repositories set with this field
    ProjectEnvironments List<string>
    ProjectKey string
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    PropertySets List<string>
    List of property set name
    RepoLayoutRef string
    Sets the layout that the repository should use for storing and identifying modules. A recommended layout that corresponds to the package type defined is suggested, and index packages uploaded and calculate metadata accordingly.
    TagRetention int
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    XrayIndex bool
    Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
    ApiVersion string
    The Docker API version to use.
    ArchiveBrowsingEnabled bool
    When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
    BlackedOut bool
    When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
    BlockPushingSchema1 bool
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    CdnRedirect bool
    When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
    Description string
    Public description.
    DownloadDirect bool
    When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
    ExcludesPattern string
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    IncludesPattern string
    List of comma-separated artifact patterns to include when evaluating artifact requests in the form of x/y/**/z/*. When used, only artifacts matching one of the include patterns are served. By default, all artifacts are included (**/*).
    Key string
    the identity key of the repo.
    MaxUniqueTags int
    The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2.
    Notes string
    Internal description.
    PriorityResolution bool
    Setting repositories with priority will cause metadata to be merged only from repositories set with this field
    ProjectEnvironments []string
    ProjectKey string
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    PropertySets []string
    List of property set name
    RepoLayoutRef string
    Sets the layout that the repository should use for storing and identifying modules. A recommended layout that corresponds to the package type defined is suggested, and index packages uploaded and calculate metadata accordingly.
    TagRetention int
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    XrayIndex bool
    Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
    apiVersion String
    The Docker API version to use.
    archiveBrowsingEnabled Boolean
    When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
    blackedOut Boolean
    When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
    blockPushingSchema1 Boolean
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    cdnRedirect Boolean
    When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
    description String
    Public description.
    downloadDirect Boolean
    When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
    excludesPattern String
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    includesPattern String
    List of comma-separated artifact patterns to include when evaluating artifact requests in the form of x/y/**/z/*. When used, only artifacts matching one of the include patterns are served. By default, all artifacts are included (**/*).
    key String
    the identity key of the repo.
    maxUniqueTags Integer
    The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2.
    notes String
    Internal description.
    priorityResolution Boolean
    Setting repositories with priority will cause metadata to be merged only from repositories set with this field
    projectEnvironments List<String>
    projectKey String
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    propertySets List<String>
    List of property set name
    repoLayoutRef String
    Sets the layout that the repository should use for storing and identifying modules. A recommended layout that corresponds to the package type defined is suggested, and index packages uploaded and calculate metadata accordingly.
    tagRetention Integer
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    xrayIndex Boolean
    Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
    apiVersion string
    The Docker API version to use.
    archiveBrowsingEnabled boolean
    When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
    blackedOut boolean
    When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
    blockPushingSchema1 boolean
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    cdnRedirect boolean
    When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
    description string
    Public description.
    downloadDirect boolean
    When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
    excludesPattern string
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    includesPattern string
    List of comma-separated artifact patterns to include when evaluating artifact requests in the form of x/y/**/z/*. When used, only artifacts matching one of the include patterns are served. By default, all artifacts are included (**/*).
    key string
    the identity key of the repo.
    maxUniqueTags number
    The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2.
    notes string
    Internal description.
    priorityResolution boolean
    Setting repositories with priority will cause metadata to be merged only from repositories set with this field
    projectEnvironments string[]
    projectKey string
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    propertySets string[]
    List of property set name
    repoLayoutRef string
    Sets the layout that the repository should use for storing and identifying modules. A recommended layout that corresponds to the package type defined is suggested, and index packages uploaded and calculate metadata accordingly.
    tagRetention number
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    xrayIndex boolean
    Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
    api_version str
    The Docker API version to use.
    archive_browsing_enabled bool
    When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
    blacked_out bool
    When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
    block_pushing_schema1 bool
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    cdn_redirect bool
    When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
    description str
    Public description.
    download_direct bool
    When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
    excludes_pattern str
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    includes_pattern str
    List of comma-separated artifact patterns to include when evaluating artifact requests in the form of x/y/**/z/*. When used, only artifacts matching one of the include patterns are served. By default, all artifacts are included (**/*).
    key str
    the identity key of the repo.
    max_unique_tags int
    The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2.
    notes str
    Internal description.
    priority_resolution bool
    Setting repositories with priority will cause metadata to be merged only from repositories set with this field
    project_environments Sequence[str]
    project_key str
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    property_sets Sequence[str]
    List of property set name
    repo_layout_ref str
    Sets the layout that the repository should use for storing and identifying modules. A recommended layout that corresponds to the package type defined is suggested, and index packages uploaded and calculate metadata accordingly.
    tag_retention int
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    xray_index bool
    Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
    apiVersion String
    The Docker API version to use.
    archiveBrowsingEnabled Boolean
    When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
    blackedOut Boolean
    When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
    blockPushingSchema1 Boolean
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    cdnRedirect Boolean
    When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
    description String
    Public description.
    downloadDirect Boolean
    When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
    excludesPattern String
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    includesPattern String
    List of comma-separated artifact patterns to include when evaluating artifact requests in the form of x/y/**/z/*. When used, only artifacts matching one of the include patterns are served. By default, all artifacts are included (**/*).
    key String
    the identity key of the repo.
    maxUniqueTags Number
    The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2.
    notes String
    Internal description.
    priorityResolution Boolean
    Setting repositories with priority will cause metadata to be merged only from repositories set with this field
    projectEnvironments List<String>
    projectKey String
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    propertySets List<String>
    List of property set name
    repoLayoutRef String
    Sets the layout that the repository should use for storing and identifying modules. A recommended layout that corresponds to the package type defined is suggested, and index packages uploaded and calculate metadata accordingly.
    tagRetention Number
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    xrayIndex Boolean
    Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.

    Import

    Local repositories can be imported using their name, e.g.

    $ pulumi import artifactory:index/dockerV2Repository:DockerV2Repository foo foo

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

    Package Details

    Repository
    artifactory pulumi/pulumi-artifactory
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the artifactory Terraform Provider.
    artifactory logo
    artifactory v8.8.1 published on Wednesday, Apr 9, 2025 by Pulumi
    pulumi/pulumi-artifactory