1. Packages
  2. Artifactory
  3. API Docs
  4. FederatedDockerV1Repository
artifactory v5.5.2 published on Wednesday, Dec 6, 2023 by Pulumi

artifactory.FederatedDockerV1Repository

Explore with Pulumi AI

artifactory logo
artifactory v5.5.2 published on Wednesday, Dec 6, 2023 by Pulumi

    Creates a federated Docker repository.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Artifactory = Pulumi.Artifactory;
    
    return await Deployment.RunAsync(() => 
    {
        var terraform_federated_test_docker_repo = new Artifactory.FederatedDockerV1Repository("terraform-federated-test-docker-repo", new()
        {
            Key = "terraform-federated-test-docker-repo",
            Members = new[]
            {
                new Artifactory.Inputs.FederatedDockerV1RepositoryMemberArgs
                {
                    Enabled = true,
                    Url = "http://tempurl.org/artifactory/terraform-federated-test-docker-repo",
                },
                new Artifactory.Inputs.FederatedDockerV1RepositoryMemberArgs
                {
                    Enabled = true,
                    Url = "http://tempurl2.org/artifactory/terraform-federated-test-docker-repo-2",
                },
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-artifactory/sdk/v5/go/artifactory"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := artifactory.NewFederatedDockerV1Repository(ctx, "terraform-federated-test-docker-repo", &artifactory.FederatedDockerV1RepositoryArgs{
    			Key: pulumi.String("terraform-federated-test-docker-repo"),
    			Members: artifactory.FederatedDockerV1RepositoryMemberArray{
    				&artifactory.FederatedDockerV1RepositoryMemberArgs{
    					Enabled: pulumi.Bool(true),
    					Url:     pulumi.String("http://tempurl.org/artifactory/terraform-federated-test-docker-repo"),
    				},
    				&artifactory.FederatedDockerV1RepositoryMemberArgs{
    					Enabled: pulumi.Bool(true),
    					Url:     pulumi.String("http://tempurl2.org/artifactory/terraform-federated-test-docker-repo-2"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.artifactory.FederatedDockerV1Repository;
    import com.pulumi.artifactory.FederatedDockerV1RepositoryArgs;
    import com.pulumi.artifactory.inputs.FederatedDockerV1RepositoryMemberArgs;
    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 terraform_federated_test_docker_repo = new FederatedDockerV1Repository("terraform-federated-test-docker-repo", FederatedDockerV1RepositoryArgs.builder()        
                .key("terraform-federated-test-docker-repo")
                .members(            
                    FederatedDockerV1RepositoryMemberArgs.builder()
                        .enabled(true)
                        .url("http://tempurl.org/artifactory/terraform-federated-test-docker-repo")
                        .build(),
                    FederatedDockerV1RepositoryMemberArgs.builder()
                        .enabled(true)
                        .url("http://tempurl2.org/artifactory/terraform-federated-test-docker-repo-2")
                        .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_artifactory as artifactory
    
    terraform_federated_test_docker_repo = artifactory.FederatedDockerV1Repository("terraform-federated-test-docker-repo",
        key="terraform-federated-test-docker-repo",
        members=[
            artifactory.FederatedDockerV1RepositoryMemberArgs(
                enabled=True,
                url="http://tempurl.org/artifactory/terraform-federated-test-docker-repo",
            ),
            artifactory.FederatedDockerV1RepositoryMemberArgs(
                enabled=True,
                url="http://tempurl2.org/artifactory/terraform-federated-test-docker-repo-2",
            ),
        ])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as artifactory from "@pulumi/artifactory";
    
    const terraform_federated_test_docker_repo = new artifactory.FederatedDockerV1Repository("terraform-federated-test-docker-repo", {
        key: "terraform-federated-test-docker-repo",
        members: [
            {
                enabled: true,
                url: "http://tempurl.org/artifactory/terraform-federated-test-docker-repo",
            },
            {
                enabled: true,
                url: "http://tempurl2.org/artifactory/terraform-federated-test-docker-repo-2",
            },
        ],
    });
    
    resources:
      terraform-federated-test-docker-repo:
        type: artifactory:FederatedDockerV1Repository
        properties:
          key: terraform-federated-test-docker-repo
          members:
            - enabled: true
              url: http://tempurl.org/artifactory/terraform-federated-test-docker-repo
            - enabled: true
              url: http://tempurl2.org/artifactory/terraform-federated-test-docker-repo-2
    

    Create FederatedDockerV1Repository Resource

    new FederatedDockerV1Repository(name: string, args: FederatedDockerV1RepositoryArgs, opts?: CustomResourceOptions);
    @overload
    def FederatedDockerV1Repository(resource_name: 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[FederatedDockerV1RepositoryMemberArgs]] = 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,
                                    xray_index: Optional[bool] = None)
    @overload
    def FederatedDockerV1Repository(resource_name: str,
                                    args: FederatedDockerV1RepositoryArgs,
                                    opts: Optional[ResourceOptions] = None)
    func NewFederatedDockerV1Repository(ctx *Context, name string, args FederatedDockerV1RepositoryArgs, opts ...ResourceOption) (*FederatedDockerV1Repository, error)
    public FederatedDockerV1Repository(string name, FederatedDockerV1RepositoryArgs args, CustomResourceOptions? opts = null)
    public FederatedDockerV1Repository(String name, FederatedDockerV1RepositoryArgs args)
    public FederatedDockerV1Repository(String name, FederatedDockerV1RepositoryArgs args, CustomResourceOptions options)
    
    type: artifactory:FederatedDockerV1Repository
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args FederatedDockerV1RepositoryArgs
    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 FederatedDockerV1RepositoryArgs
    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 FederatedDockerV1RepositoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FederatedDockerV1RepositoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FederatedDockerV1RepositoryArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Key string

    the identity key of the repo.

    Members List<FederatedDockerV1RepositoryMember>

    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

    Delete all federated members on terraform destroy if set to true. Caution: it will delete all the repositories in the federation on other Artifactory instances.

    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
    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>

    Project environment for assigning this repository to. Allow values: "DEV", "PROD", or one of custom environment. Before Artifactory 7.53.1, up to 2 values ("DEV" and "PROD") are allowed. From 7.53.1 onward, only one value is allowed. The attribute should only be used if the repository is already assigned to the existing project. If not, the attribute will be ignored by Artifactory, but will remain in the Terraform state, which will create state drift during the update.

    ProjectKey string

    Project key for assigning this repository to. Must be 2 - 20 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

    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 []FederatedDockerV1RepositoryMemberArgs

    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

    Delete all federated members on terraform destroy if set to true. Caution: it will delete all the repositories in the federation on other Artifactory instances.

    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
    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

    Project environment for assigning this repository to. Allow values: "DEV", "PROD", or one of custom environment. Before Artifactory 7.53.1, up to 2 values ("DEV" and "PROD") are allowed. From 7.53.1 onward, only one value is allowed. The attribute should only be used if the repository is already assigned to the existing project. If not, the attribute will be ignored by Artifactory, but will remain in the Terraform state, which will create state drift during the update.

    ProjectKey string

    Project key for assigning this repository to. Must be 2 - 20 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

    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<FederatedDockerV1RepositoryMember>

    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

    Delete all federated members on terraform destroy if set to true. Caution: it will delete all the repositories in the federation on other Artifactory instances.

    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
    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>

    Project environment for assigning this repository to. Allow values: "DEV", "PROD", or one of custom environment. Before Artifactory 7.53.1, up to 2 values ("DEV" and "PROD") are allowed. From 7.53.1 onward, only one value is allowed. The attribute should only be used if the repository is already assigned to the existing project. If not, the attribute will be ignored by Artifactory, but will remain in the Terraform state, which will create state drift during the update.

    projectKey String

    Project key for assigning this repository to. Must be 2 - 20 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

    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 FederatedDockerV1RepositoryMember[]

    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

    Delete all federated members on terraform destroy if set to true. Caution: it will delete all the repositories in the federation on other Artifactory instances.

    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
    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[]

    Project environment for assigning this repository to. Allow values: "DEV", "PROD", or one of custom environment. Before Artifactory 7.53.1, up to 2 values ("DEV" and "PROD") are allowed. From 7.53.1 onward, only one value is allowed. The attribute should only be used if the repository is already assigned to the existing project. If not, the attribute will be ignored by Artifactory, but will remain in the Terraform state, which will create state drift during the update.

    projectKey string

    Project key for assigning this repository to. Must be 2 - 20 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

    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[FederatedDockerV1RepositoryMemberArgs]

    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

    Delete all federated members on terraform destroy if set to true. Caution: it will delete all the repositories in the federation on other Artifactory instances.

    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
    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 environment for assigning this repository to. Allow values: "DEV", "PROD", or one of custom environment. Before Artifactory 7.53.1, up to 2 values ("DEV" and "PROD") are allowed. From 7.53.1 onward, only one value is allowed. The attribute should only be used if the repository is already assigned to the existing project. If not, the attribute will be ignored by Artifactory, but will remain in the Terraform state, which will create state drift during the update.

    project_key str

    Project key for assigning this repository to. Must be 2 - 20 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

    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

    Delete all federated members on terraform destroy if set to true. Caution: it will delete all the repositories in the federation on other Artifactory instances.

    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
    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>

    Project environment for assigning this repository to. Allow values: "DEV", "PROD", or one of custom environment. Before Artifactory 7.53.1, up to 2 values ("DEV" and "PROD") are allowed. From 7.53.1 onward, only one value is allowed. The attribute should only be used if the repository is already assigned to the existing project. If not, the attribute will be ignored by Artifactory, but will remain in the Terraform state, which will create state drift during the update.

    projectKey String

    Project key for assigning this repository to. Must be 2 - 20 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

    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 FederatedDockerV1Repository resource produces the following output properties:

    ApiVersion string
    BlockPushingSchema1 bool
    Id string

    The provider-assigned unique ID for this managed resource.

    PackageType string
    TagRetention int
    ApiVersion string
    BlockPushingSchema1 bool
    Id string

    The provider-assigned unique ID for this managed resource.

    PackageType string
    TagRetention int
    apiVersion String
    blockPushingSchema1 Boolean
    id String

    The provider-assigned unique ID for this managed resource.

    packageType String
    tagRetention Integer
    apiVersion string
    blockPushingSchema1 boolean
    id string

    The provider-assigned unique ID for this managed resource.

    packageType string
    tagRetention number
    api_version str
    block_pushing_schema1 bool
    id str

    The provider-assigned unique ID for this managed resource.

    package_type str
    tag_retention int
    apiVersion String
    blockPushingSchema1 Boolean
    id String

    The provider-assigned unique ID for this managed resource.

    packageType String
    tagRetention Number

    Look up Existing FederatedDockerV1Repository Resource

    Get an existing FederatedDockerV1Repository 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?: FederatedDockerV1RepositoryState, opts?: CustomResourceOptions): FederatedDockerV1Repository
    @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,
            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[FederatedDockerV1RepositoryMemberArgs]] = 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) -> FederatedDockerV1Repository
    func GetFederatedDockerV1Repository(ctx *Context, name string, id IDInput, state *FederatedDockerV1RepositoryState, opts ...ResourceOption) (*FederatedDockerV1Repository, error)
    public static FederatedDockerV1Repository Get(string name, Input<string> id, FederatedDockerV1RepositoryState? state, CustomResourceOptions? opts = null)
    public static FederatedDockerV1Repository get(String name, Output<String> id, FederatedDockerV1RepositoryState 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:
    ApiVersion string
    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
    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

    Delete all federated members on terraform destroy if set to true. Caution: it will delete all the repositories in the federation on other Artifactory instances.

    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
    Members List<FederatedDockerV1RepositoryMember>

    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>

    Project environment for assigning this repository to. Allow values: "DEV", "PROD", or one of custom environment. Before Artifactory 7.53.1, up to 2 values ("DEV" and "PROD") are allowed. From 7.53.1 onward, only one value is allowed. The attribute should only be used if the repository is already assigned to the existing project. If not, the attribute will be ignored by Artifactory, but will remain in the Terraform state, which will create state drift during the update.

    ProjectKey string

    Project key for assigning this repository to. Must be 2 - 20 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
    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
    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
    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

    Delete all federated members on terraform destroy if set to true. Caution: it will delete all the repositories in the federation on other Artifactory instances.

    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
    Members []FederatedDockerV1RepositoryMemberArgs

    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

    Project environment for assigning this repository to. Allow values: "DEV", "PROD", or one of custom environment. Before Artifactory 7.53.1, up to 2 values ("DEV" and "PROD") are allowed. From 7.53.1 onward, only one value is allowed. The attribute should only be used if the repository is already assigned to the existing project. If not, the attribute will be ignored by Artifactory, but will remain in the Terraform state, which will create state drift during the update.

    ProjectKey string

    Project key for assigning this repository to. Must be 2 - 20 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
    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
    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
    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

    Delete all federated members on terraform destroy if set to true. Caution: it will delete all the repositories in the federation on other Artifactory instances.

    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
    members List<FederatedDockerV1RepositoryMember>

    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>

    Project environment for assigning this repository to. Allow values: "DEV", "PROD", or one of custom environment. Before Artifactory 7.53.1, up to 2 values ("DEV" and "PROD") are allowed. From 7.53.1 onward, only one value is allowed. The attribute should only be used if the repository is already assigned to the existing project. If not, the attribute will be ignored by Artifactory, but will remain in the Terraform state, which will create state drift during the update.

    projectKey String

    Project key for assigning this repository to. Must be 2 - 20 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
    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
    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
    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

    Delete all federated members on terraform destroy if set to true. Caution: it will delete all the repositories in the federation on other Artifactory instances.

    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
    members FederatedDockerV1RepositoryMember[]

    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[]

    Project environment for assigning this repository to. Allow values: "DEV", "PROD", or one of custom environment. Before Artifactory 7.53.1, up to 2 values ("DEV" and "PROD") are allowed. From 7.53.1 onward, only one value is allowed. The attribute should only be used if the repository is already assigned to the existing project. If not, the attribute will be ignored by Artifactory, but will remain in the Terraform state, which will create state drift during the update.

    projectKey string

    Project key for assigning this repository to. Must be 2 - 20 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
    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
    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
    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

    Delete all federated members on terraform destroy if set to true. Caution: it will delete all the repositories in the federation on other Artifactory instances.

    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
    members Sequence[FederatedDockerV1RepositoryMemberArgs]

    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 environment for assigning this repository to. Allow values: "DEV", "PROD", or one of custom environment. Before Artifactory 7.53.1, up to 2 values ("DEV" and "PROD") are allowed. From 7.53.1 onward, only one value is allowed. The attribute should only be used if the repository is already assigned to the existing project. If not, the attribute will be ignored by Artifactory, but will remain in the Terraform state, which will create state drift during the update.

    project_key str

    Project key for assigning this repository to. Must be 2 - 20 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
    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
    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
    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

    Delete all federated members on terraform destroy if set to true. Caution: it will delete all the repositories in the federation on other Artifactory instances.

    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
    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>

    Project environment for assigning this repository to. Allow values: "DEV", "PROD", or one of custom environment. Before Artifactory 7.53.1, up to 2 values ("DEV" and "PROD") are allowed. From 7.53.1 onward, only one value is allowed. The attribute should only be used if the repository is already assigned to the existing project. If not, the attribute will be ignored by Artifactory, but will remain in the Terraform state, which will create state drift during the update.

    projectKey String

    Project key for assigning this repository to. Must be 2 - 20 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
    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

    FederatedDockerV1RepositoryMember, FederatedDockerV1RepositoryMemberArgs

    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.

    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.

    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.

    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.

    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.

    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.

    Import

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

     $ pulumi import artifactory:index/federatedDockerV1Repository:FederatedDockerV1Repository terraform-federated-test-docker-repo terraform-federated-test-docker-repo
    

    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 v5.5.2 published on Wednesday, Dec 6, 2023 by Pulumi