1. Packages
  2. Artifactory
  3. API Docs
  4. VirtualIvyRepository
artifactory v6.6.0 published on Saturday, Apr 13, 2024 by Pulumi

artifactory.VirtualIvyRepository

Explore with Pulumi AI

artifactory logo
artifactory v6.6.0 published on Saturday, Apr 13, 2024 by Pulumi

    Creates a virtual Ivy repository. Official documentation can be found here.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as artifactory from "@pulumi/artifactory";
    
    const foo_ivy = new artifactory.VirtualIvyRepository("foo-ivy", {
        description: "A test virtual repo",
        excludesPattern: "com/google/**",
        includesPattern: "com/jfrog/**,cloud/jfrog/**",
        key: "foo-ivy",
        notes: "Internal description",
        pomRepositoryReferencesCleanupPolicy: "discard_active_reference",
        repositories: [],
    });
    
    import pulumi
    import pulumi_artifactory as artifactory
    
    foo_ivy = artifactory.VirtualIvyRepository("foo-ivy",
        description="A test virtual repo",
        excludes_pattern="com/google/**",
        includes_pattern="com/jfrog/**,cloud/jfrog/**",
        key="foo-ivy",
        notes="Internal description",
        pom_repository_references_cleanup_policy="discard_active_reference",
        repositories=[])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-artifactory/sdk/v6/go/artifactory"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := artifactory.NewVirtualIvyRepository(ctx, "foo-ivy", &artifactory.VirtualIvyRepositoryArgs{
    			Description:                          pulumi.String("A test virtual repo"),
    			ExcludesPattern:                      pulumi.String("com/google/**"),
    			IncludesPattern:                      pulumi.String("com/jfrog/**,cloud/jfrog/**"),
    			Key:                                  pulumi.String("foo-ivy"),
    			Notes:                                pulumi.String("Internal description"),
    			PomRepositoryReferencesCleanupPolicy: pulumi.String("discard_active_reference"),
    			Repositories:                         pulumi.StringArray{},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Artifactory = Pulumi.Artifactory;
    
    return await Deployment.RunAsync(() => 
    {
        var foo_ivy = new Artifactory.VirtualIvyRepository("foo-ivy", new()
        {
            Description = "A test virtual repo",
            ExcludesPattern = "com/google/**",
            IncludesPattern = "com/jfrog/**,cloud/jfrog/**",
            Key = "foo-ivy",
            Notes = "Internal description",
            PomRepositoryReferencesCleanupPolicy = "discard_active_reference",
            Repositories = new[] {},
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.artifactory.VirtualIvyRepository;
    import com.pulumi.artifactory.VirtualIvyRepositoryArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var foo_ivy = new VirtualIvyRepository("foo-ivy", VirtualIvyRepositoryArgs.builder()        
                .description("A test virtual repo")
                .excludesPattern("com/google/**")
                .includesPattern("com/jfrog/**,cloud/jfrog/**")
                .key("foo-ivy")
                .notes("Internal description")
                .pomRepositoryReferencesCleanupPolicy("discard_active_reference")
                .repositories()
                .build());
    
        }
    }
    
    resources:
      foo-ivy:
        type: artifactory:VirtualIvyRepository
        properties:
          description: A test virtual repo
          excludesPattern: com/google/**
          includesPattern: com/jfrog/**,cloud/jfrog/**
          key: foo-ivy
          notes: Internal description
          pomRepositoryReferencesCleanupPolicy: discard_active_reference
          repositories: []
    

    Create VirtualIvyRepository Resource

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

    Constructor syntax

    new VirtualIvyRepository(name: string, args: VirtualIvyRepositoryArgs, opts?: CustomResourceOptions);
    @overload
    def VirtualIvyRepository(resource_name: str,
                             args: VirtualIvyRepositoryArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def VirtualIvyRepository(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             key: Optional[str] = None,
                             excludes_pattern: Optional[str] = None,
                             description: Optional[str] = None,
                             artifactory_requests_can_retrieve_remote_artifacts: Optional[bool] = None,
                             force_maven_authentication: Optional[bool] = None,
                             includes_pattern: Optional[str] = None,
                             default_deployment_repo: Optional[str] = None,
                             key_pair: Optional[str] = None,
                             notes: Optional[str] = None,
                             pom_repository_references_cleanup_policy: Optional[str] = None,
                             project_environments: Optional[Sequence[str]] = None,
                             project_key: Optional[str] = None,
                             repo_layout_ref: Optional[str] = None,
                             repositories: Optional[Sequence[str]] = None)
    func NewVirtualIvyRepository(ctx *Context, name string, args VirtualIvyRepositoryArgs, opts ...ResourceOption) (*VirtualIvyRepository, error)
    public VirtualIvyRepository(string name, VirtualIvyRepositoryArgs args, CustomResourceOptions? opts = null)
    public VirtualIvyRepository(String name, VirtualIvyRepositoryArgs args)
    public VirtualIvyRepository(String name, VirtualIvyRepositoryArgs args, CustomResourceOptions options)
    
    type: artifactory:VirtualIvyRepository
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args VirtualIvyRepositoryArgs
    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 VirtualIvyRepositoryArgs
    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 VirtualIvyRepositoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VirtualIvyRepositoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VirtualIvyRepositoryArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var virtualIvyRepositoryResource = new Artifactory.VirtualIvyRepository("virtualIvyRepositoryResource", new()
    {
        Key = "string",
        ExcludesPattern = "string",
        Description = "string",
        ArtifactoryRequestsCanRetrieveRemoteArtifacts = false,
        ForceMavenAuthentication = false,
        IncludesPattern = "string",
        DefaultDeploymentRepo = "string",
        KeyPair = "string",
        Notes = "string",
        PomRepositoryReferencesCleanupPolicy = "string",
        ProjectEnvironments = new[]
        {
            "string",
        },
        ProjectKey = "string",
        RepoLayoutRef = "string",
        Repositories = new[]
        {
            "string",
        },
    });
    
    example, err := artifactory.NewVirtualIvyRepository(ctx, "virtualIvyRepositoryResource", &artifactory.VirtualIvyRepositoryArgs{
    	Key:             pulumi.String("string"),
    	ExcludesPattern: pulumi.String("string"),
    	Description:     pulumi.String("string"),
    	ArtifactoryRequestsCanRetrieveRemoteArtifacts: pulumi.Bool(false),
    	ForceMavenAuthentication:                      pulumi.Bool(false),
    	IncludesPattern:                               pulumi.String("string"),
    	DefaultDeploymentRepo:                         pulumi.String("string"),
    	KeyPair:                                       pulumi.String("string"),
    	Notes:                                         pulumi.String("string"),
    	PomRepositoryReferencesCleanupPolicy:          pulumi.String("string"),
    	ProjectEnvironments: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ProjectKey:    pulumi.String("string"),
    	RepoLayoutRef: pulumi.String("string"),
    	Repositories: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var virtualIvyRepositoryResource = new VirtualIvyRepository("virtualIvyRepositoryResource", VirtualIvyRepositoryArgs.builder()        
        .key("string")
        .excludesPattern("string")
        .description("string")
        .artifactoryRequestsCanRetrieveRemoteArtifacts(false)
        .forceMavenAuthentication(false)
        .includesPattern("string")
        .defaultDeploymentRepo("string")
        .keyPair("string")
        .notes("string")
        .pomRepositoryReferencesCleanupPolicy("string")
        .projectEnvironments("string")
        .projectKey("string")
        .repoLayoutRef("string")
        .repositories("string")
        .build());
    
    virtual_ivy_repository_resource = artifactory.VirtualIvyRepository("virtualIvyRepositoryResource",
        key="string",
        excludes_pattern="string",
        description="string",
        artifactory_requests_can_retrieve_remote_artifacts=False,
        force_maven_authentication=False,
        includes_pattern="string",
        default_deployment_repo="string",
        key_pair="string",
        notes="string",
        pom_repository_references_cleanup_policy="string",
        project_environments=["string"],
        project_key="string",
        repo_layout_ref="string",
        repositories=["string"])
    
    const virtualIvyRepositoryResource = new artifactory.VirtualIvyRepository("virtualIvyRepositoryResource", {
        key: "string",
        excludesPattern: "string",
        description: "string",
        artifactoryRequestsCanRetrieveRemoteArtifacts: false,
        forceMavenAuthentication: false,
        includesPattern: "string",
        defaultDeploymentRepo: "string",
        keyPair: "string",
        notes: "string",
        pomRepositoryReferencesCleanupPolicy: "string",
        projectEnvironments: ["string"],
        projectKey: "string",
        repoLayoutRef: "string",
        repositories: ["string"],
    });
    
    type: artifactory:VirtualIvyRepository
    properties:
        artifactoryRequestsCanRetrieveRemoteArtifacts: false
        defaultDeploymentRepo: string
        description: string
        excludesPattern: string
        forceMavenAuthentication: false
        includesPattern: string
        key: string
        keyPair: string
        notes: string
        pomRepositoryReferencesCleanupPolicy: string
        projectEnvironments:
            - string
        projectKey: string
        repoLayoutRef: string
        repositories:
            - string
    

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

    Key string
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    ArtifactoryRequestsCanRetrieveRemoteArtifacts bool
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    DefaultDeploymentRepo string
    Default repository to deploy artifacts.
    Description string
    Public description.
    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.
    ForceMavenAuthentication bool
    User authentication is required when accessing the repository. An anonymous request will display an HTTP 401 error. This is also enforced when aggregated repositories support anonymous requests.
    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 (/*).
    KeyPair string
    The keypair used to sign artifacts.
    Notes string
    Internal description.
    PomRepositoryReferencesCleanupPolicy string
    • (1: discard_active_reference) Discard Active References - Removes repository elements that are declared directly under project or under a profile in the same POM that is activeByDefault.
    • (2: discard_any_reference) Discard Any References - Removes all repository elements regardless of whether they are included in an active profile or not.
    • (3: nothing) Nothing - Does not remove any repository elements declared in the POM.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    RepoLayoutRef string
    Repository layout key for the virtual repository
    Repositories List<string>
    The effective list of actual repositories included in this virtual repository.
    Key string
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    ArtifactoryRequestsCanRetrieveRemoteArtifacts bool
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    DefaultDeploymentRepo string
    Default repository to deploy artifacts.
    Description string
    Public description.
    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.
    ForceMavenAuthentication bool
    User authentication is required when accessing the repository. An anonymous request will display an HTTP 401 error. This is also enforced when aggregated repositories support anonymous requests.
    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 (/*).
    KeyPair string
    The keypair used to sign artifacts.
    Notes string
    Internal description.
    PomRepositoryReferencesCleanupPolicy string
    • (1: discard_active_reference) Discard Active References - Removes repository elements that are declared directly under project or under a profile in the same POM that is activeByDefault.
    • (2: discard_any_reference) Discard Any References - Removes all repository elements regardless of whether they are included in an active profile or not.
    • (3: nothing) Nothing - Does not remove any repository elements declared in the POM.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    RepoLayoutRef string
    Repository layout key for the virtual repository
    Repositories []string
    The effective list of actual repositories included in this virtual repository.
    key String
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    artifactoryRequestsCanRetrieveRemoteArtifacts Boolean
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    defaultDeploymentRepo String
    Default repository to deploy artifacts.
    description String
    Public description.
    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.
    forceMavenAuthentication Boolean
    User authentication is required when accessing the repository. An anonymous request will display an HTTP 401 error. This is also enforced when aggregated repositories support anonymous requests.
    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 (/*).
    keyPair String
    The keypair used to sign artifacts.
    notes String
    Internal description.
    pomRepositoryReferencesCleanupPolicy String
    • (1: discard_active_reference) Discard Active References - Removes repository elements that are declared directly under project or under a profile in the same POM that is activeByDefault.
    • (2: discard_any_reference) Discard Any References - Removes all repository elements regardless of whether they are included in an active profile or not.
    • (3: nothing) Nothing - Does not remove any repository elements declared in the POM.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    repoLayoutRef String
    Repository layout key for the virtual repository
    repositories List<String>
    The effective list of actual repositories included in this virtual repository.
    key string
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    artifactoryRequestsCanRetrieveRemoteArtifacts boolean
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    defaultDeploymentRepo string
    Default repository to deploy artifacts.
    description string
    Public description.
    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.
    forceMavenAuthentication boolean
    User authentication is required when accessing the repository. An anonymous request will display an HTTP 401 error. This is also enforced when aggregated repositories support anonymous requests.
    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 (/*).
    keyPair string
    The keypair used to sign artifacts.
    notes string
    Internal description.
    pomRepositoryReferencesCleanupPolicy string
    • (1: discard_active_reference) Discard Active References - Removes repository elements that are declared directly under project or under a profile in the same POM that is activeByDefault.
    • (2: discard_any_reference) Discard Any References - Removes all repository elements regardless of whether they are included in an active profile or not.
    • (3: nothing) Nothing - Does not remove any repository elements declared in the POM.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    repoLayoutRef string
    Repository layout key for the virtual repository
    repositories string[]
    The effective list of actual repositories included in this virtual repository.
    key str
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    artifactory_requests_can_retrieve_remote_artifacts bool
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    default_deployment_repo str
    Default repository to deploy artifacts.
    description str
    Public description.
    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.
    force_maven_authentication bool
    User authentication is required when accessing the repository. An anonymous request will display an HTTP 401 error. This is also enforced when aggregated repositories support anonymous requests.
    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_pair str
    The keypair used to sign artifacts.
    notes str
    Internal description.
    pom_repository_references_cleanup_policy str
    • (1: discard_active_reference) Discard Active References - Removes repository elements that are declared directly under project or under a profile in the same POM that is activeByDefault.
    • (2: discard_any_reference) Discard Any References - Removes all repository elements regardless of whether they are included in an active profile or not.
    • (3: nothing) Nothing - Does not remove any repository elements declared in the POM.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    repo_layout_ref str
    Repository layout key for the virtual repository
    repositories Sequence[str]
    The effective list of actual repositories included in this virtual repository.
    key String
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    artifactoryRequestsCanRetrieveRemoteArtifacts Boolean
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    defaultDeploymentRepo String
    Default repository to deploy artifacts.
    description String
    Public description.
    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.
    forceMavenAuthentication Boolean
    User authentication is required when accessing the repository. An anonymous request will display an HTTP 401 error. This is also enforced when aggregated repositories support anonymous requests.
    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 (/*).
    keyPair String
    The keypair used to sign artifacts.
    notes String
    Internal description.
    pomRepositoryReferencesCleanupPolicy String
    • (1: discard_active_reference) Discard Active References - Removes repository elements that are declared directly under project or under a profile in the same POM that is activeByDefault.
    • (2: discard_any_reference) Discard Any References - Removes all repository elements regardless of whether they are included in an active profile or not.
    • (3: nothing) Nothing - Does not remove any repository elements declared in the POM.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    repoLayoutRef String
    Repository layout key for the virtual repository
    repositories List<String>
    The effective list of actual repositories included in this virtual repository.

    Outputs

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

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

    Look up Existing VirtualIvyRepository Resource

    Get an existing VirtualIvyRepository 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?: VirtualIvyRepositoryState, opts?: CustomResourceOptions): VirtualIvyRepository
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            artifactory_requests_can_retrieve_remote_artifacts: Optional[bool] = None,
            default_deployment_repo: Optional[str] = None,
            description: Optional[str] = None,
            excludes_pattern: Optional[str] = None,
            force_maven_authentication: Optional[bool] = None,
            includes_pattern: Optional[str] = None,
            key: Optional[str] = None,
            key_pair: Optional[str] = None,
            notes: Optional[str] = None,
            package_type: Optional[str] = None,
            pom_repository_references_cleanup_policy: Optional[str] = None,
            project_environments: Optional[Sequence[str]] = None,
            project_key: Optional[str] = None,
            repo_layout_ref: Optional[str] = None,
            repositories: Optional[Sequence[str]] = None) -> VirtualIvyRepository
    func GetVirtualIvyRepository(ctx *Context, name string, id IDInput, state *VirtualIvyRepositoryState, opts ...ResourceOption) (*VirtualIvyRepository, error)
    public static VirtualIvyRepository Get(string name, Input<string> id, VirtualIvyRepositoryState? state, CustomResourceOptions? opts = null)
    public static VirtualIvyRepository get(String name, Output<String> id, VirtualIvyRepositoryState 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:
    ArtifactoryRequestsCanRetrieveRemoteArtifacts bool
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    DefaultDeploymentRepo string
    Default repository to deploy artifacts.
    Description string
    Public description.
    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.
    ForceMavenAuthentication bool
    User authentication is required when accessing the repository. An anonymous request will display an HTTP 401 error. This is also enforced when aggregated repositories support anonymous requests.
    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
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    KeyPair string
    The keypair used to sign artifacts.
    Notes string
    Internal description.
    PackageType string
    PomRepositoryReferencesCleanupPolicy string
    • (1: discard_active_reference) Discard Active References - Removes repository elements that are declared directly under project or under a profile in the same POM that is activeByDefault.
    • (2: discard_any_reference) Discard Any References - Removes all repository elements regardless of whether they are included in an active profile or not.
    • (3: nothing) Nothing - Does not remove any repository elements declared in the POM.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    RepoLayoutRef string
    Repository layout key for the virtual repository
    Repositories List<string>
    The effective list of actual repositories included in this virtual repository.
    ArtifactoryRequestsCanRetrieveRemoteArtifacts bool
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    DefaultDeploymentRepo string
    Default repository to deploy artifacts.
    Description string
    Public description.
    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.
    ForceMavenAuthentication bool
    User authentication is required when accessing the repository. An anonymous request will display an HTTP 401 error. This is also enforced when aggregated repositories support anonymous requests.
    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
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    KeyPair string
    The keypair used to sign artifacts.
    Notes string
    Internal description.
    PackageType string
    PomRepositoryReferencesCleanupPolicy string
    • (1: discard_active_reference) Discard Active References - Removes repository elements that are declared directly under project or under a profile in the same POM that is activeByDefault.
    • (2: discard_any_reference) Discard Any References - Removes all repository elements regardless of whether they are included in an active profile or not.
    • (3: nothing) Nothing - Does not remove any repository elements declared in the POM.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    RepoLayoutRef string
    Repository layout key for the virtual repository
    Repositories []string
    The effective list of actual repositories included in this virtual repository.
    artifactoryRequestsCanRetrieveRemoteArtifacts Boolean
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    defaultDeploymentRepo String
    Default repository to deploy artifacts.
    description String
    Public description.
    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.
    forceMavenAuthentication Boolean
    User authentication is required when accessing the repository. An anonymous request will display an HTTP 401 error. This is also enforced when aggregated repositories support anonymous requests.
    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
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    keyPair String
    The keypair used to sign artifacts.
    notes String
    Internal description.
    packageType String
    pomRepositoryReferencesCleanupPolicy String
    • (1: discard_active_reference) Discard Active References - Removes repository elements that are declared directly under project or under a profile in the same POM that is activeByDefault.
    • (2: discard_any_reference) Discard Any References - Removes all repository elements regardless of whether they are included in an active profile or not.
    • (3: nothing) Nothing - Does not remove any repository elements declared in the POM.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    repoLayoutRef String
    Repository layout key for the virtual repository
    repositories List<String>
    The effective list of actual repositories included in this virtual repository.
    artifactoryRequestsCanRetrieveRemoteArtifacts boolean
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    defaultDeploymentRepo string
    Default repository to deploy artifacts.
    description string
    Public description.
    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.
    forceMavenAuthentication boolean
    User authentication is required when accessing the repository. An anonymous request will display an HTTP 401 error. This is also enforced when aggregated repositories support anonymous requests.
    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
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    keyPair string
    The keypair used to sign artifacts.
    notes string
    Internal description.
    packageType string
    pomRepositoryReferencesCleanupPolicy string
    • (1: discard_active_reference) Discard Active References - Removes repository elements that are declared directly under project or under a profile in the same POM that is activeByDefault.
    • (2: discard_any_reference) Discard Any References - Removes all repository elements regardless of whether they are included in an active profile or not.
    • (3: nothing) Nothing - Does not remove any repository elements declared in the POM.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    repoLayoutRef string
    Repository layout key for the virtual repository
    repositories string[]
    The effective list of actual repositories included in this virtual repository.
    artifactory_requests_can_retrieve_remote_artifacts bool
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    default_deployment_repo str
    Default repository to deploy artifacts.
    description str
    Public description.
    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.
    force_maven_authentication bool
    User authentication is required when accessing the repository. An anonymous request will display an HTTP 401 error. This is also enforced when aggregated repositories support anonymous requests.
    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
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    key_pair str
    The keypair used to sign artifacts.
    notes str
    Internal description.
    package_type str
    pom_repository_references_cleanup_policy str
    • (1: discard_active_reference) Discard Active References - Removes repository elements that are declared directly under project or under a profile in the same POM that is activeByDefault.
    • (2: discard_any_reference) Discard Any References - Removes all repository elements regardless of whether they are included in an active profile or not.
    • (3: nothing) Nothing - Does not remove any repository elements declared in the POM.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    repo_layout_ref str
    Repository layout key for the virtual repository
    repositories Sequence[str]
    The effective list of actual repositories included in this virtual repository.
    artifactoryRequestsCanRetrieveRemoteArtifacts Boolean
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    defaultDeploymentRepo String
    Default repository to deploy artifacts.
    description String
    Public description.
    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.
    forceMavenAuthentication Boolean
    User authentication is required when accessing the repository. An anonymous request will display an HTTP 401 error. This is also enforced when aggregated repositories support anonymous requests.
    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
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    keyPair String
    The keypair used to sign artifacts.
    notes String
    Internal description.
    packageType String
    pomRepositoryReferencesCleanupPolicy String
    • (1: discard_active_reference) Discard Active References - Removes repository elements that are declared directly under project or under a profile in the same POM that is activeByDefault.
    • (2: discard_any_reference) Discard Any References - Removes all repository elements regardless of whether they are included in an active profile or not.
    • (3: nothing) Nothing - Does not remove any repository elements declared in the POM.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    repoLayoutRef String
    Repository layout key for the virtual repository
    repositories List<String>
    The effective list of actual repositories included in this virtual repository.

    Import

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

    $ pulumi import artifactory:index/virtualIvyRepository:VirtualIvyRepository foo-ivy foo-ivy
    

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

    Package Details

    Repository
    artifactory pulumi/pulumi-artifactory
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the artifactory Terraform Provider.
    artifactory logo
    artifactory v6.6.0 published on Saturday, Apr 13, 2024 by Pulumi