artifactory v3.5.3, Jun 1 23

artifactory.getFederatedMavenRepository

Explore with Pulumi AI

Retrieves a federated Maven repository.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var federated_test_maven_repo = Artifactory.GetFederatedMavenRepository.Invoke(new()
    {
        Key = "federated-test-maven-repo",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := artifactory.LookupFederatedMavenRepository(ctx, &artifactory.LookupFederatedMavenRepositoryArgs{
			Key: "federated-test-maven-repo",
		}, nil)
		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.ArtifactoryFunctions;
import com.pulumi.artifactory.inputs.GetFederatedMavenRepositoryArgs;
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) {
        final var federated-test-maven-repo = ArtifactoryFunctions.getFederatedMavenRepository(GetFederatedMavenRepositoryArgs.builder()
            .key("federated-test-maven-repo")
            .build());

    }
}

import pulumi
import pulumi_artifactory as artifactory

federated_test_maven_repo = artifactory.get_federated_maven_repository(key="federated-test-maven-repo")

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

const federated-test-maven-repo = artifactory.getFederatedMavenRepository({
    key: "federated-test-maven-repo",
});

variables:
  federated-test-maven-repo:
    fn::invoke:
      Function: artifactory:getFederatedMavenRepository
      Arguments:
        key: federated-test-maven-repo

Using getFederatedMavenRepository

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFederatedMavenRepository(args: GetFederatedMavenRepositoryArgs, opts?: InvokeOptions): Promise<GetFederatedMavenRepositoryResult>
function getFederatedMavenRepositoryOutput(args: GetFederatedMavenRepositoryOutputArgs, opts?: InvokeOptions): Output<GetFederatedMavenRepositoryResult>

def get_federated_maven_repository(archive_browsing_enabled: Optional[bool] = None,
                                   blacked_out: Optional[bool] = None,
                                   cdn_redirect: Optional[bool] = None,
                                   checksum_policy_type: Optional[str] = None,
                                   cleanup_on_delete: Optional[bool] = None,
                                   description: Optional[str] = None,
                                   download_direct: Optional[bool] = None,
                                   excludes_pattern: Optional[str] = None,
                                   handle_releases: Optional[bool] = None,
                                   handle_snapshots: Optional[bool] = None,
                                   includes_pattern: Optional[str] = None,
                                   key: Optional[str] = None,
                                   max_unique_snapshots: Optional[int] = None,
                                   members: Optional[Sequence[GetFederatedMavenRepositoryMember]] = None,
                                   notes: Optional[str] = None,
                                   priority_resolution: Optional[bool] = None,
                                   project_environments: Optional[Sequence[str]] = None,
                                   project_key: Optional[str] = None,
                                   property_sets: Optional[Sequence[str]] = None,
                                   repo_layout_ref: Optional[str] = None,
                                   snapshot_version_behavior: Optional[str] = None,
                                   suppress_pom_consistency_checks: Optional[bool] = None,
                                   xray_index: Optional[bool] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetFederatedMavenRepositoryResult
def get_federated_maven_repository_output(archive_browsing_enabled: Optional[pulumi.Input[bool]] = None,
                                   blacked_out: Optional[pulumi.Input[bool]] = None,
                                   cdn_redirect: Optional[pulumi.Input[bool]] = None,
                                   checksum_policy_type: Optional[pulumi.Input[str]] = None,
                                   cleanup_on_delete: Optional[pulumi.Input[bool]] = None,
                                   description: Optional[pulumi.Input[str]] = None,
                                   download_direct: Optional[pulumi.Input[bool]] = None,
                                   excludes_pattern: Optional[pulumi.Input[str]] = None,
                                   handle_releases: Optional[pulumi.Input[bool]] = None,
                                   handle_snapshots: Optional[pulumi.Input[bool]] = None,
                                   includes_pattern: Optional[pulumi.Input[str]] = None,
                                   key: Optional[pulumi.Input[str]] = None,
                                   max_unique_snapshots: Optional[pulumi.Input[int]] = None,
                                   members: Optional[pulumi.Input[Sequence[pulumi.Input[GetFederatedMavenRepositoryMemberArgs]]]] = None,
                                   notes: Optional[pulumi.Input[str]] = None,
                                   priority_resolution: Optional[pulumi.Input[bool]] = None,
                                   project_environments: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                   project_key: Optional[pulumi.Input[str]] = None,
                                   property_sets: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                   repo_layout_ref: Optional[pulumi.Input[str]] = None,
                                   snapshot_version_behavior: Optional[pulumi.Input[str]] = None,
                                   suppress_pom_consistency_checks: Optional[pulumi.Input[bool]] = None,
                                   xray_index: Optional[pulumi.Input[bool]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetFederatedMavenRepositoryResult]

func LookupFederatedMavenRepository(ctx *Context, args *LookupFederatedMavenRepositoryArgs, opts ...InvokeOption) (*LookupFederatedMavenRepositoryResult, error)
func LookupFederatedMavenRepositoryOutput(ctx *Context, args *LookupFederatedMavenRepositoryOutputArgs, opts ...InvokeOption) LookupFederatedMavenRepositoryResultOutput

> Note: This function is named LookupFederatedMavenRepository in the Go SDK.

public static class GetFederatedMavenRepository 
{
    public static Task<GetFederatedMavenRepositoryResult> InvokeAsync(GetFederatedMavenRepositoryArgs args, InvokeOptions? opts = null)
    public static Output<GetFederatedMavenRepositoryResult> Invoke(GetFederatedMavenRepositoryInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetFederatedMavenRepositoryResult> getFederatedMavenRepository(GetFederatedMavenRepositoryArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: artifactory:index/getFederatedMavenRepository:getFederatedMavenRepository
  arguments:
    # arguments dictionary

The following arguments are supported:

Key string: the identity key of the repo.
ArchiveBrowsingEnabled bool
BlackedOut bool
CdnRedirect bool
ChecksumPolicyType string
CleanupOnDelete bool
Description string
DownloadDirect bool
ExcludesPattern string
HandleReleases bool
HandleSnapshots bool
IncludesPattern string
MaxUniqueSnapshots int
Members List<GetFederatedMavenRepositoryMember>: 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
PriorityResolution bool
ProjectEnvironments List<string>
ProjectKey string
PropertySets List<string>
RepoLayoutRef string
SnapshotVersionBehavior string
SuppressPomConsistencyChecks bool
XrayIndex bool

Key string: the identity key of the repo.
ArchiveBrowsingEnabled bool
BlackedOut bool
CdnRedirect bool
ChecksumPolicyType string
CleanupOnDelete bool
Description string
DownloadDirect bool
ExcludesPattern string
HandleReleases bool
HandleSnapshots bool
IncludesPattern string
MaxUniqueSnapshots int
Members []GetFederatedMavenRepositoryMember: 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
PriorityResolution bool
ProjectEnvironments []string
ProjectKey string
PropertySets []string
RepoLayoutRef string
SnapshotVersionBehavior string
SuppressPomConsistencyChecks bool
XrayIndex bool

key String: the identity key of the repo.
archiveBrowsingEnabled Boolean
blackedOut Boolean
cdnRedirect Boolean
checksumPolicyType String
cleanupOnDelete Boolean
description String
downloadDirect Boolean
excludesPattern String
handleReleases Boolean
handleSnapshots Boolean
includesPattern String
maxUniqueSnapshots Integer
members List<GetFederatedMavenRepositoryMember>: 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
priorityResolution Boolean
projectEnvironments List<String>
projectKey String
propertySets List<String>
repoLayoutRef String
snapshotVersionBehavior String
suppressPomConsistencyChecks Boolean
xrayIndex Boolean

key string: the identity key of the repo.
archiveBrowsingEnabled boolean
blackedOut boolean
cdnRedirect boolean
checksumPolicyType string
cleanupOnDelete boolean
description string
downloadDirect boolean
excludesPattern string
handleReleases boolean
handleSnapshots boolean
includesPattern string
maxUniqueSnapshots number
members GetFederatedMavenRepositoryMember[]: 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
priorityResolution boolean
projectEnvironments string[]
projectKey string
propertySets string[]
repoLayoutRef string
snapshotVersionBehavior string
suppressPomConsistencyChecks boolean
xrayIndex boolean

key str: the identity key of the repo.
archive_browsing_enabled bool
blacked_out bool
cdn_redirect bool
checksum_policy_type str
cleanup_on_delete bool
description str
download_direct bool
excludes_pattern str
handle_releases bool
handle_snapshots bool
includes_pattern str
max_unique_snapshots int
members Sequence[GetFederatedMavenRepositoryMember]: 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
priority_resolution bool
project_environments Sequence[str]
project_key str
property_sets Sequence[str]
repo_layout_ref str
snapshot_version_behavior str
suppress_pom_consistency_checks bool
xray_index bool

key String: the identity key of the repo.
archiveBrowsingEnabled Boolean
blackedOut Boolean
cdnRedirect Boolean
checksumPolicyType String
cleanupOnDelete Boolean
description String
downloadDirect Boolean
excludesPattern String
handleReleases Boolean
handleSnapshots Boolean
includesPattern String
maxUniqueSnapshots 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
priorityResolution Boolean
projectEnvironments List<String>
projectKey String
propertySets List<String>
repoLayoutRef String
snapshotVersionBehavior String
suppressPomConsistencyChecks Boolean
xrayIndex Boolean

getFederatedMavenRepository Result

The following output properties are available:

ExcludesPattern string
Id string: The provider-assigned unique ID for this managed resource.
IncludesPattern string
Key string
PackageType string
ProjectEnvironments List<string>
ArchiveBrowsingEnabled bool
BlackedOut bool
CdnRedirect bool
ChecksumPolicyType string
CleanupOnDelete bool
Description string
DownloadDirect bool
HandleReleases bool
HandleSnapshots bool
MaxUniqueSnapshots int
Members List<GetFederatedMavenRepositoryMember>: 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
PriorityResolution bool
ProjectKey string
PropertySets List<string>
RepoLayoutRef string
SnapshotVersionBehavior string
SuppressPomConsistencyChecks bool
XrayIndex bool

ExcludesPattern string
Id string: The provider-assigned unique ID for this managed resource.
IncludesPattern string
Key string
PackageType string
ProjectEnvironments []string
ArchiveBrowsingEnabled bool
BlackedOut bool
CdnRedirect bool
ChecksumPolicyType string
CleanupOnDelete bool
Description string
DownloadDirect bool
HandleReleases bool
HandleSnapshots bool
MaxUniqueSnapshots int
Members []GetFederatedMavenRepositoryMember: 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
PriorityResolution bool
ProjectKey string
PropertySets []string
RepoLayoutRef string
SnapshotVersionBehavior string
SuppressPomConsistencyChecks bool
XrayIndex bool

excludesPattern String
id String: The provider-assigned unique ID for this managed resource.
includesPattern String
key String
packageType String
projectEnvironments List<String>
archiveBrowsingEnabled Boolean
blackedOut Boolean
cdnRedirect Boolean
checksumPolicyType String
cleanupOnDelete Boolean
description String
downloadDirect Boolean
handleReleases Boolean
handleSnapshots Boolean
maxUniqueSnapshots Integer
members List<GetFederatedMavenRepositoryMember>: 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
priorityResolution Boolean
projectKey String
propertySets List<String>
repoLayoutRef String
snapshotVersionBehavior String
suppressPomConsistencyChecks Boolean
xrayIndex Boolean

excludesPattern string
id string: The provider-assigned unique ID for this managed resource.
includesPattern string
key string
packageType string
projectEnvironments string[]
archiveBrowsingEnabled boolean
blackedOut boolean
cdnRedirect boolean
checksumPolicyType string
cleanupOnDelete boolean
description string
downloadDirect boolean
handleReleases boolean
handleSnapshots boolean
maxUniqueSnapshots number
members GetFederatedMavenRepositoryMember[]: 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
priorityResolution boolean
projectKey string
propertySets string[]
repoLayoutRef string
snapshotVersionBehavior string
suppressPomConsistencyChecks boolean
xrayIndex boolean

excludes_pattern str
id str: The provider-assigned unique ID for this managed resource.
includes_pattern str
key str
package_type str
project_environments Sequence[str]
archive_browsing_enabled bool
blacked_out bool
cdn_redirect bool
checksum_policy_type str
cleanup_on_delete bool
description str
download_direct bool
handle_releases bool
handle_snapshots bool
max_unique_snapshots int
members Sequence[GetFederatedMavenRepositoryMember]: 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
priority_resolution bool
project_key str
property_sets Sequence[str]
repo_layout_ref str
snapshot_version_behavior str
suppress_pom_consistency_checks bool
xray_index bool

excludesPattern String
id String: The provider-assigned unique ID for this managed resource.
includesPattern String
key String
packageType String
projectEnvironments List<String>
archiveBrowsingEnabled Boolean
blackedOut Boolean
cdnRedirect Boolean
checksumPolicyType String
cleanupOnDelete Boolean
description String
downloadDirect Boolean
handleReleases Boolean
handleSnapshots Boolean
maxUniqueSnapshots 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
priorityResolution Boolean
projectKey String
propertySets List<String>
repoLayoutRef String
snapshotVersionBehavior String
suppressPomConsistencyChecks Boolean
xrayIndex Boolean

Supporting Types

GetFederatedMavenRepositoryMember

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.

Package Details

Repository: artifactory pulumi/pulumi-artifactory
License: Apache-2.0
Notes: This Pulumi package is based on the artifactory Terraform Provider.