1. Packages
  2. Artifactory
  3. API Docs
  4. getFederatedGemsRepository
artifactory v3.5.3 published on Thursday, Jun 1, 2023 by Pulumi

artifactory.getFederatedGemsRepository

Explore with Pulumi AI

artifactory logo
artifactory v3.5.3 published on Thursday, Jun 1, 2023 by Pulumi

    Retrieves a federated Gems repository.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Artifactory = Pulumi.Artifactory;
    
    return await Deployment.RunAsync(() => 
    {
        var federated_test_gems_repo = Artifactory.GetFederatedGemsRepository.Invoke(new()
        {
            Key = "federated-test-gems-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.LookupFederatedGemsRepository(ctx, &artifactory.LookupFederatedGemsRepositoryArgs{
    			Key: "federated-test-gems-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.GetFederatedGemsRepositoryArgs;
    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-gems-repo = ArtifactoryFunctions.getFederatedGemsRepository(GetFederatedGemsRepositoryArgs.builder()
                .key("federated-test-gems-repo")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_artifactory as artifactory
    
    federated_test_gems_repo = artifactory.get_federated_gems_repository(key="federated-test-gems-repo")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as artifactory from "@pulumi/artifactory";
    
    const federated-test-gems-repo = artifactory.getFederatedGemsRepository({
        key: "federated-test-gems-repo",
    });
    
    variables:
      federated-test-gems-repo:
        fn::invoke:
          Function: artifactory:getFederatedGemsRepository
          Arguments:
            key: federated-test-gems-repo
    

    Using getFederatedGemsRepository

    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 getFederatedGemsRepository(args: GetFederatedGemsRepositoryArgs, opts?: InvokeOptions): Promise<GetFederatedGemsRepositoryResult>
    function getFederatedGemsRepositoryOutput(args: GetFederatedGemsRepositoryOutputArgs, opts?: InvokeOptions): Output<GetFederatedGemsRepositoryResult>
    def get_federated_gems_repository(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,
                                      download_direct: Optional[bool] = None,
                                      excludes_pattern: Optional[str] = None,
                                      includes_pattern: Optional[str] = None,
                                      key: Optional[str] = None,
                                      members: Optional[Sequence[GetFederatedGemsRepositoryMember]] = 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,
                                      xray_index: Optional[bool] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetFederatedGemsRepositoryResult
    def get_federated_gems_repository_output(archive_browsing_enabled: Optional[pulumi.Input[bool]] = None,
                                      blacked_out: Optional[pulumi.Input[bool]] = None,
                                      cdn_redirect: Optional[pulumi.Input[bool]] = 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,
                                      includes_pattern: Optional[pulumi.Input[str]] = None,
                                      key: Optional[pulumi.Input[str]] = None,
                                      members: Optional[pulumi.Input[Sequence[pulumi.Input[GetFederatedGemsRepositoryMemberArgs]]]] = 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,
                                      xray_index: Optional[pulumi.Input[bool]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetFederatedGemsRepositoryResult]
    func LookupFederatedGemsRepository(ctx *Context, args *LookupFederatedGemsRepositoryArgs, opts ...InvokeOption) (*LookupFederatedGemsRepositoryResult, error)
    func LookupFederatedGemsRepositoryOutput(ctx *Context, args *LookupFederatedGemsRepositoryOutputArgs, opts ...InvokeOption) LookupFederatedGemsRepositoryResultOutput

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

    public static class GetFederatedGemsRepository 
    {
        public static Task<GetFederatedGemsRepositoryResult> InvokeAsync(GetFederatedGemsRepositoryArgs args, InvokeOptions? opts = null)
        public static Output<GetFederatedGemsRepositoryResult> Invoke(GetFederatedGemsRepositoryInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFederatedGemsRepositoryResult> getFederatedGemsRepository(GetFederatedGemsRepositoryArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: artifactory:index/getFederatedGemsRepository:getFederatedGemsRepository
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Key string

    the identity key of the repo.

    ArchiveBrowsingEnabled bool
    BlackedOut bool
    CdnRedirect bool
    CleanupOnDelete bool
    Description string
    DownloadDirect bool
    ExcludesPattern string
    IncludesPattern string
    Members List<GetFederatedGemsRepositoryMember>

    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
    XrayIndex bool
    Key string

    the identity key of the repo.

    ArchiveBrowsingEnabled bool
    BlackedOut bool
    CdnRedirect bool
    CleanupOnDelete bool
    Description string
    DownloadDirect bool
    ExcludesPattern string
    IncludesPattern string
    Members []GetFederatedGemsRepositoryMember

    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
    XrayIndex bool
    key String

    the identity key of the repo.

    archiveBrowsingEnabled Boolean
    blackedOut Boolean
    cdnRedirect Boolean
    cleanupOnDelete Boolean
    description String
    downloadDirect Boolean
    excludesPattern String
    includesPattern String
    members List<GetFederatedGemsRepositoryMember>

    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
    xrayIndex Boolean
    key string

    the identity key of the repo.

    archiveBrowsingEnabled boolean
    blackedOut boolean
    cdnRedirect boolean
    cleanupOnDelete boolean
    description string
    downloadDirect boolean
    excludesPattern string
    includesPattern string
    members GetFederatedGemsRepositoryMember[]

    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
    xrayIndex boolean
    key str

    the identity key of the repo.

    archive_browsing_enabled bool
    blacked_out bool
    cdn_redirect bool
    cleanup_on_delete bool
    description str
    download_direct bool
    excludes_pattern str
    includes_pattern str
    members Sequence[GetFederatedGemsRepositoryMember]

    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
    xray_index bool
    key String

    the identity key of the repo.

    archiveBrowsingEnabled Boolean
    blackedOut Boolean
    cdnRedirect Boolean
    cleanupOnDelete Boolean
    description String
    downloadDirect Boolean
    excludesPattern String
    includesPattern String
    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
    xrayIndex Boolean

    getFederatedGemsRepository 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
    CleanupOnDelete bool
    Description string
    DownloadDirect bool
    Members List<GetFederatedGemsRepositoryMember>

    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
    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
    CleanupOnDelete bool
    Description string
    DownloadDirect bool
    Members []GetFederatedGemsRepositoryMember

    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
    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
    cleanupOnDelete Boolean
    description String
    downloadDirect Boolean
    members List<GetFederatedGemsRepositoryMember>

    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
    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
    cleanupOnDelete boolean
    description string
    downloadDirect boolean
    members GetFederatedGemsRepositoryMember[]

    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
    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
    cleanup_on_delete bool
    description str
    download_direct bool
    members Sequence[GetFederatedGemsRepositoryMember]

    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
    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
    cleanupOnDelete Boolean
    description String
    downloadDirect Boolean
    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
    xrayIndex Boolean

    Supporting Types

    GetFederatedGemsRepositoryMember

    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.

    artifactory logo
    artifactory v3.5.3 published on Thursday, Jun 1, 2023 by Pulumi