Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Artifactory Provider
  3. API Docs
  4. FederatedOciRepository
artifactory v8.1.0 published on Saturday, Sep 28, 2024 by Pulumi
pulumi/pulumi-artifactory

artifactory.FederatedOciRepository

Explore with Pulumi AI

artifactory logo
artifactory v8.1.0 published on Saturday, Sep 28, 2024 by Pulumi
pulumi/pulumi-artifactory

    Creates a federated OCI repository.

    Example Usage

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

const my_oci_federated = new artifactory.FederatedOciRepository("my-oci-federated", {
    key: "my-oci-federated",
    members: [
        {
            url: "http://tempurl.org/artifactory/my-oci-federated",
            enabled: true,
        },
        {
            url: "http://tempurl2.org/artifactory/my-oci-federated-2",
            enabled: true,
        },
    ],
});

    import pulumi
import pulumi_artifactory as artifactory

my_oci_federated = artifactory.FederatedOciRepository("my-oci-federated",
    key="my-oci-federated",
    members=[
        {
            "url": "http://tempurl.org/artifactory/my-oci-federated",
            "enabled": True,
        },
        {
            "url": "http://tempurl2.org/artifactory/my-oci-federated-2",
            "enabled": True,
        },
    ])

    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.NewFederatedOciRepository(ctx, "my-oci-federated", &artifactory.FederatedOciRepositoryArgs{
			Key: pulumi.String("my-oci-federated"),
			Members: artifactory.FederatedOciRepositoryMemberArray{
				&artifactory.FederatedOciRepositoryMemberArgs{
					Url:     pulumi.String("http://tempurl.org/artifactory/my-oci-federated"),
					Enabled: pulumi.Bool(true),
				},
				&artifactory.FederatedOciRepositoryMemberArgs{
					Url:     pulumi.String("http://tempurl2.org/artifactory/my-oci-federated-2"),
					Enabled: pulumi.Bool(true),
				},
			},
		})
		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 my_oci_federated = new Artifactory.FederatedOciRepository("my-oci-federated", new()
    {
        Key = "my-oci-federated",
        Members = new[]
        {
            new Artifactory.Inputs.FederatedOciRepositoryMemberArgs
            {
                Url = "http://tempurl.org/artifactory/my-oci-federated",
                Enabled = true,
            },
            new Artifactory.Inputs.FederatedOciRepositoryMemberArgs
            {
                Url = "http://tempurl2.org/artifactory/my-oci-federated-2",
                Enabled = true,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.artifactory.FederatedOciRepository;
import com.pulumi.artifactory.FederatedOciRepositoryArgs;
import com.pulumi.artifactory.inputs.FederatedOciRepositoryMemberArgs;
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 my_oci_federated = new FederatedOciRepository("my-oci-federated", FederatedOciRepositoryArgs.builder()
            .key("my-oci-federated")
            .members(            
                FederatedOciRepositoryMemberArgs.builder()
                    .url("http://tempurl.org/artifactory/my-oci-federated")
                    .enabled(true)
                    .build(),
                FederatedOciRepositoryMemberArgs.builder()
                    .url("http://tempurl2.org/artifactory/my-oci-federated-2")
                    .enabled(true)
                    .build())
            .build());

    }
}

    resources:
  my-oci-federated:
    type: artifactory:FederatedOciRepository
    properties:
      key: my-oci-federated
      members:
        - url: http://tempurl.org/artifactory/my-oci-federated
          enabled: true
        - url: http://tempurl2.org/artifactory/my-oci-federated-2
          enabled: true

    Create FederatedOciRepository Resource

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

    Constructor syntax

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

@overload
def FederatedOciRepository(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           key: Optional[str] = None,
                           members: Optional[Sequence[FederatedOciRepositoryMemberArgs]] = None,
                           max_unique_tags: Optional[int] = None,
                           blacked_out: Optional[bool] = None,
                           description: Optional[str] = None,
                           disable_proxy: Optional[bool] = None,
                           download_direct: Optional[bool] = None,
                           excludes_pattern: Optional[str] = None,
                           includes_pattern: Optional[str] = None,
                           cdn_redirect: Optional[bool] = None,
                           archive_browsing_enabled: Optional[bool] = None,
                           cleanup_on_delete: Optional[bool] = 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,
                           proxy: Optional[str] = None,
                           repo_layout_ref: Optional[str] = None,
                           tag_retention: Optional[int] = None,
                           xray_index: Optional[bool] = None)
    func NewFederatedOciRepository(ctx *Context, name string, args FederatedOciRepositoryArgs, opts ...ResourceOption) (*FederatedOciRepository, error)
    public FederatedOciRepository(string name, FederatedOciRepositoryArgs args, CustomResourceOptions? opts = null)
    public FederatedOciRepository(String name, FederatedOciRepositoryArgs args)
public FederatedOciRepository(String name, FederatedOciRepositoryArgs args, CustomResourceOptions options)

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

    example, err := artifactory.NewFederatedOciRepository(ctx, "federatedOciRepositoryResource", &artifactory.FederatedOciRepositoryArgs{
	Key: pulumi.String("string"),
	Members: artifactory.FederatedOciRepositoryMemberArray{
		&artifactory.FederatedOciRepositoryMemberArgs{
			Enabled:     pulumi.Bool(false),
			Url:         pulumi.String("string"),
			AccessToken: pulumi.String("string"),
		},
	},
	MaxUniqueTags:          pulumi.Int(0),
	BlackedOut:             pulumi.Bool(false),
	Description:            pulumi.String("string"),
	DisableProxy:           pulumi.Bool(false),
	DownloadDirect:         pulumi.Bool(false),
	ExcludesPattern:        pulumi.String("string"),
	IncludesPattern:        pulumi.String("string"),
	CdnRedirect:            pulumi.Bool(false),
	ArchiveBrowsingEnabled: pulumi.Bool(false),
	CleanupOnDelete:        pulumi.Bool(false),
	Notes:                  pulumi.String("string"),
	PriorityResolution:     pulumi.Bool(false),
	ProjectEnvironments: pulumi.StringArray{
		pulumi.String("string"),
	},
	ProjectKey: pulumi.String("string"),
	PropertySets: pulumi.StringArray{
		pulumi.String("string"),
	},
	Proxy:         pulumi.String("string"),
	RepoLayoutRef: pulumi.String("string"),
	TagRetention:  pulumi.Int(0),
	XrayIndex:     pulumi.Bool(false),
})

    var federatedOciRepositoryResource = new FederatedOciRepository("federatedOciRepositoryResource", FederatedOciRepositoryArgs.builder()
    .key("string")
    .members(FederatedOciRepositoryMemberArgs.builder()
        .enabled(false)
        .url("string")
        .accessToken("string")
        .build())
    .maxUniqueTags(0)
    .blackedOut(false)
    .description("string")
    .disableProxy(false)
    .downloadDirect(false)
    .excludesPattern("string")
    .includesPattern("string")
    .cdnRedirect(false)
    .archiveBrowsingEnabled(false)
    .cleanupOnDelete(false)
    .notes("string")
    .priorityResolution(false)
    .projectEnvironments("string")
    .projectKey("string")
    .propertySets("string")
    .proxy("string")
    .repoLayoutRef("string")
    .tagRetention(0)
    .xrayIndex(false)
    .build());

    federated_oci_repository_resource = artifactory.FederatedOciRepository("federatedOciRepositoryResource",
    key="string",
    members=[artifactory.FederatedOciRepositoryMemberArgs(
        enabled=False,
        url="string",
        access_token="string",
    )],
    max_unique_tags=0,
    blacked_out=False,
    description="string",
    disable_proxy=False,
    download_direct=False,
    excludes_pattern="string",
    includes_pattern="string",
    cdn_redirect=False,
    archive_browsing_enabled=False,
    cleanup_on_delete=False,
    notes="string",
    priority_resolution=False,
    project_environments=["string"],
    project_key="string",
    property_sets=["string"],
    proxy="string",
    repo_layout_ref="string",
    tag_retention=0,
    xray_index=False)

    const federatedOciRepositoryResource = new artifactory.FederatedOciRepository("federatedOciRepositoryResource", {
    key: "string",
    members: [{
        enabled: false,
        url: "string",
        accessToken: "string",
    }],
    maxUniqueTags: 0,
    blackedOut: false,
    description: "string",
    disableProxy: false,
    downloadDirect: false,
    excludesPattern: "string",
    includesPattern: "string",
    cdnRedirect: false,
    archiveBrowsingEnabled: false,
    cleanupOnDelete: false,
    notes: "string",
    priorityResolution: false,
    projectEnvironments: ["string"],
    projectKey: "string",
    propertySets: ["string"],
    proxy: "string",
    repoLayoutRef: "string",
    tagRetention: 0,
    xrayIndex: false,
});

    type: artifactory:FederatedOciRepository
properties:
    archiveBrowsingEnabled: false
    blackedOut: false
    cdnRedirect: false
    cleanupOnDelete: false
    description: string
    disableProxy: false
    downloadDirect: false
    excludesPattern: string
    includesPattern: string
    key: string
    maxUniqueTags: 0
    members:
        - accessToken: string
          enabled: false
          url: string
    notes: string
    priorityResolution: false
    projectEnvironments:
        - string
    projectKey: string
    propertySets:
        - string
    proxy: string
    repoLayoutRef: string
    tagRetention: 0
    xrayIndex: false

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

    Key string
    the identity key of the repo.
    Members List<FederatedOciRepositoryMember>
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    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.
    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'
    CleanupOnDelete bool
    Description string
    Public description.
    DisableProxy bool
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    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 OCI 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.
    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
    Proxy string
    Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if disable_proxy = true.
    RepoLayoutRef string
    Repository layout key for the federated repository
    TagRetention int
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
    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.
    Members []FederatedOciRepositoryMemberArgs
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    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.
    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'
    CleanupOnDelete bool
    Description string
    Public description.
    DisableProxy bool
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    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 OCI 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.
    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
    Proxy string
    Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if disable_proxy = true.
    RepoLayoutRef string
    Repository layout key for the federated repository
    TagRetention int
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
    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.
    members List<FederatedOciRepositoryMember>
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    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.
    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'
    cleanupOnDelete Boolean
    description String
    Public description.
    disableProxy Boolean
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    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 OCI 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.
    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
    proxy String
    Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if disable_proxy = true.
    repoLayoutRef String
    Repository layout key for the federated repository
    tagRetention Integer
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
    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.
    members FederatedOciRepositoryMember[]
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    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.
    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'
    cleanupOnDelete boolean
    description string
    Public description.
    disableProxy boolean
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    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 OCI 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.
    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
    proxy string
    Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if disable_proxy = true.
    repoLayoutRef string
    Repository layout key for the federated repository
    tagRetention number
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
    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.
    members Sequence[FederatedOciRepositoryMemberArgs]
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    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.
    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'
    cleanup_on_delete bool
    description str
    Public description.
    disable_proxy bool
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    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 OCI 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.
    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
    proxy str
    Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if disable_proxy = true.
    repo_layout_ref str
    Repository layout key for the federated repository
    tag_retention int
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
    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.
    members List<Property Map>
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    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.
    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'
    cleanupOnDelete Boolean
    description String
    Public description.
    disableProxy Boolean
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    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 OCI 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.
    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
    proxy String
    Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if disable_proxy = true.
    repoLayoutRef String
    Repository layout key for the federated repository
    tagRetention Number
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
    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 FederatedOciRepository resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    PackageType string
    Id string
    The provider-assigned unique ID for this managed resource.
    PackageType string
    id String
    The provider-assigned unique ID for this managed resource.
    packageType String
    id string
    The provider-assigned unique ID for this managed resource.
    packageType string
    id str
    The provider-assigned unique ID for this managed resource.
    package_type str
    id String
    The provider-assigned unique ID for this managed resource.
    packageType String

    Look up Existing FederatedOciRepository Resource

    Get an existing FederatedOciRepository 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?: FederatedOciRepositoryState, opts?: CustomResourceOptions): FederatedOciRepository
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        archive_browsing_enabled: Optional[bool] = None,
        blacked_out: Optional[bool] = None,
        cdn_redirect: Optional[bool] = None,
        cleanup_on_delete: Optional[bool] = None,
        description: Optional[str] = None,
        disable_proxy: Optional[bool] = 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,
        members: Optional[Sequence[FederatedOciRepositoryMemberArgs]] = None,
        notes: Optional[str] = None,
        package_type: 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,
        proxy: Optional[str] = None,
        repo_layout_ref: Optional[str] = None,
        tag_retention: Optional[int] = None,
        xray_index: Optional[bool] = None) -> FederatedOciRepository
    func GetFederatedOciRepository(ctx *Context, name string, id IDInput, state *FederatedOciRepositoryState, opts ...ResourceOption) (*FederatedOciRepository, error)
    public static FederatedOciRepository Get(string name, Input<string> id, FederatedOciRepositoryState? state, CustomResourceOptions? opts = null)
    public static FederatedOciRepository get(String name, Output<String> id, FederatedOciRepositoryState 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:
    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.
    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'
    CleanupOnDelete bool
    Description string
    Public description.
    DisableProxy bool
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    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 OCI 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.
    Members List<FederatedOciRepositoryMember>
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    Notes string
    Internal description.
    PackageType string
    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
    Proxy string
    Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if disable_proxy = true.
    RepoLayoutRef string
    Repository layout key for the federated repository
    TagRetention int
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
    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.
    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.
    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'
    CleanupOnDelete bool
    Description string
    Public description.
    DisableProxy bool
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    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 OCI 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.
    Members []FederatedOciRepositoryMemberArgs
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    Notes string
    Internal description.
    PackageType string
    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
    Proxy string
    Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if disable_proxy = true.
    RepoLayoutRef string
    Repository layout key for the federated repository
    TagRetention int
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
    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.
    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.
    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'
    cleanupOnDelete Boolean
    description String
    Public description.
    disableProxy Boolean
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    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 OCI 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.
    members List<FederatedOciRepositoryMember>
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    notes String
    Internal description.
    packageType String
    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
    proxy String
    Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if disable_proxy = true.
    repoLayoutRef String
    Repository layout key for the federated repository
    tagRetention Integer
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
    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.
    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.
    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'
    cleanupOnDelete boolean
    description string
    Public description.
    disableProxy boolean
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    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 OCI 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.
    members FederatedOciRepositoryMember[]
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    notes string
    Internal description.
    packageType string
    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
    proxy string
    Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if disable_proxy = true.
    repoLayoutRef string
    Repository layout key for the federated repository
    tagRetention number
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
    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.
    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.
    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'
    cleanup_on_delete bool
    description str
    Public description.
    disable_proxy bool
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    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 OCI 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.
    members Sequence[FederatedOciRepositoryMemberArgs]
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    notes str
    Internal description.
    package_type str
    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
    proxy str
    Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if disable_proxy = true.
    repo_layout_ref str
    Repository layout key for the federated repository
    tag_retention int
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
    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.
    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.
    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'
    cleanupOnDelete Boolean
    description String
    Public description.
    disableProxy Boolean
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    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 OCI 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.
    members List<Property Map>
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    notes String
    Internal description.
    packageType String
    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
    proxy String
    Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if disable_proxy = true.
    repoLayoutRef String
    Repository layout key for the federated repository
    tagRetention Number
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
    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.

    Supporting Types

    FederatedOciRepositoryMember, FederatedOciRepositoryMemberArgs

    Enabled bool
    Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
    Url string
    Full URL to ending with the repository name.
    AccessToken string
    Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.
    Enabled bool
    Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
    Url string
    Full URL to ending with the repository name.
    AccessToken string
    Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.
    enabled Boolean
    Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
    url String
    Full URL to ending with the repository name.
    accessToken String
    Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.
    enabled boolean
    Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
    url string
    Full URL to ending with the repository name.
    accessToken string
    Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.
    enabled bool
    Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
    url str
    Full URL to ending with the repository name.
    access_token str
    Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.
    enabled Boolean
    Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
    url String
    Full URL to ending with the repository name.
    accessToken String
    Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.

    Import

    Federated OCI repositories can be imported using their name, e.g.

    $ pulumi import artifactory:index/federatedOciRepository:FederatedOciRepository my-oci-federated my-oci-federated

    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.1.0 published on Saturday, Sep 28, 2024 by Pulumi
    pulumi/pulumi-artifactory