1. Packages
  2. Artifactory
  3. API Docs
  4. LocalCargoRepository
artifactory v6.7.0 published on Friday, Apr 19, 2024 by Pulumi

artifactory.LocalCargoRepository

Explore with Pulumi AI

artifactory logo
artifactory v6.7.0 published on Friday, Apr 19, 2024 by Pulumi

    Creates a local Cargo repository.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as artifactory from "@pulumi/artifactory";
    
    const terraform_local_test_cargo_repo_basic = new artifactory.LocalCargoRepository("terraform-local-test-cargo-repo-basic", {
        anonymousAccess: false,
        enableSparseIndex: true,
        key: "terraform-local-test-cargo-repo-basic",
    });
    
    import pulumi
    import pulumi_artifactory as artifactory
    
    terraform_local_test_cargo_repo_basic = artifactory.LocalCargoRepository("terraform-local-test-cargo-repo-basic",
        anonymous_access=False,
        enable_sparse_index=True,
        key="terraform-local-test-cargo-repo-basic")
    
    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.NewLocalCargoRepository(ctx, "terraform-local-test-cargo-repo-basic", &artifactory.LocalCargoRepositoryArgs{
    			AnonymousAccess:   pulumi.Bool(false),
    			EnableSparseIndex: pulumi.Bool(true),
    			Key:               pulumi.String("terraform-local-test-cargo-repo-basic"),
    		})
    		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 terraform_local_test_cargo_repo_basic = new Artifactory.LocalCargoRepository("terraform-local-test-cargo-repo-basic", new()
        {
            AnonymousAccess = false,
            EnableSparseIndex = true,
            Key = "terraform-local-test-cargo-repo-basic",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.artifactory.LocalCargoRepository;
    import com.pulumi.artifactory.LocalCargoRepositoryArgs;
    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_local_test_cargo_repo_basic = new LocalCargoRepository("terraform-local-test-cargo-repo-basic", LocalCargoRepositoryArgs.builder()        
                .anonymousAccess(false)
                .enableSparseIndex(true)
                .key("terraform-local-test-cargo-repo-basic")
                .build());
    
        }
    }
    
    resources:
      terraform-local-test-cargo-repo-basic:
        type: artifactory:LocalCargoRepository
        properties:
          anonymousAccess: false
          enableSparseIndex: true
          key: terraform-local-test-cargo-repo-basic
    

    Create LocalCargoRepository Resource

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

    Constructor syntax

    new LocalCargoRepository(name: string, args: LocalCargoRepositoryArgs, opts?: CustomResourceOptions);
    @overload
    def LocalCargoRepository(resource_name: str,
                             args: LocalCargoRepositoryArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def LocalCargoRepository(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             key: Optional[str] = None,
                             includes_pattern: Optional[str] = None,
                             download_direct: Optional[bool] = None,
                             index_compression_formats: Optional[Sequence[str]] = None,
                             description: Optional[str] = None,
                             archive_browsing_enabled: Optional[bool] = None,
                             enable_sparse_index: Optional[bool] = None,
                             excludes_pattern: Optional[str] = None,
                             notes: Optional[str] = None,
                             cdn_redirect: Optional[bool] = None,
                             blacked_out: Optional[bool] = None,
                             anonymous_access: Optional[bool] = 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)
    func NewLocalCargoRepository(ctx *Context, name string, args LocalCargoRepositoryArgs, opts ...ResourceOption) (*LocalCargoRepository, error)
    public LocalCargoRepository(string name, LocalCargoRepositoryArgs args, CustomResourceOptions? opts = null)
    public LocalCargoRepository(String name, LocalCargoRepositoryArgs args)
    public LocalCargoRepository(String name, LocalCargoRepositoryArgs args, CustomResourceOptions options)
    
    type: artifactory:LocalCargoRepository
    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 LocalCargoRepositoryArgs
    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 LocalCargoRepositoryArgs
    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 LocalCargoRepositoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LocalCargoRepositoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LocalCargoRepositoryArgs
    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 localCargoRepositoryResource = new Artifactory.LocalCargoRepository("localCargoRepositoryResource", new()
    {
        Key = "string",
        IncludesPattern = "string",
        DownloadDirect = false,
        IndexCompressionFormats = new[]
        {
            "string",
        },
        Description = "string",
        ArchiveBrowsingEnabled = false,
        EnableSparseIndex = false,
        ExcludesPattern = "string",
        Notes = "string",
        CdnRedirect = false,
        BlackedOut = false,
        AnonymousAccess = false,
        PriorityResolution = false,
        ProjectEnvironments = new[]
        {
            "string",
        },
        ProjectKey = "string",
        PropertySets = new[]
        {
            "string",
        },
        RepoLayoutRef = "string",
        XrayIndex = false,
    });
    
    example, err := artifactory.NewLocalCargoRepository(ctx, "localCargoRepositoryResource", &artifactory.LocalCargoRepositoryArgs{
    	Key:             pulumi.String("string"),
    	IncludesPattern: pulumi.String("string"),
    	DownloadDirect:  pulumi.Bool(false),
    	IndexCompressionFormats: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description:            pulumi.String("string"),
    	ArchiveBrowsingEnabled: pulumi.Bool(false),
    	EnableSparseIndex:      pulumi.Bool(false),
    	ExcludesPattern:        pulumi.String("string"),
    	Notes:                  pulumi.String("string"),
    	CdnRedirect:            pulumi.Bool(false),
    	BlackedOut:             pulumi.Bool(false),
    	AnonymousAccess:        pulumi.Bool(false),
    	PriorityResolution:     pulumi.Bool(false),
    	ProjectEnvironments: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ProjectKey: pulumi.String("string"),
    	PropertySets: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	RepoLayoutRef: pulumi.String("string"),
    	XrayIndex:     pulumi.Bool(false),
    })
    
    var localCargoRepositoryResource = new LocalCargoRepository("localCargoRepositoryResource", LocalCargoRepositoryArgs.builder()        
        .key("string")
        .includesPattern("string")
        .downloadDirect(false)
        .indexCompressionFormats("string")
        .description("string")
        .archiveBrowsingEnabled(false)
        .enableSparseIndex(false)
        .excludesPattern("string")
        .notes("string")
        .cdnRedirect(false)
        .blackedOut(false)
        .anonymousAccess(false)
        .priorityResolution(false)
        .projectEnvironments("string")
        .projectKey("string")
        .propertySets("string")
        .repoLayoutRef("string")
        .xrayIndex(false)
        .build());
    
    local_cargo_repository_resource = artifactory.LocalCargoRepository("localCargoRepositoryResource",
        key="string",
        includes_pattern="string",
        download_direct=False,
        index_compression_formats=["string"],
        description="string",
        archive_browsing_enabled=False,
        enable_sparse_index=False,
        excludes_pattern="string",
        notes="string",
        cdn_redirect=False,
        blacked_out=False,
        anonymous_access=False,
        priority_resolution=False,
        project_environments=["string"],
        project_key="string",
        property_sets=["string"],
        repo_layout_ref="string",
        xray_index=False)
    
    const localCargoRepositoryResource = new artifactory.LocalCargoRepository("localCargoRepositoryResource", {
        key: "string",
        includesPattern: "string",
        downloadDirect: false,
        indexCompressionFormats: ["string"],
        description: "string",
        archiveBrowsingEnabled: false,
        enableSparseIndex: false,
        excludesPattern: "string",
        notes: "string",
        cdnRedirect: false,
        blackedOut: false,
        anonymousAccess: false,
        priorityResolution: false,
        projectEnvironments: ["string"],
        projectKey: "string",
        propertySets: ["string"],
        repoLayoutRef: "string",
        xrayIndex: false,
    });
    
    type: artifactory:LocalCargoRepository
    properties:
        anonymousAccess: false
        archiveBrowsingEnabled: false
        blackedOut: false
        cdnRedirect: false
        description: string
        downloadDirect: false
        enableSparseIndex: false
        excludesPattern: string
        includesPattern: string
        indexCompressionFormats:
            - string
        key: string
        notes: string
        priorityResolution: false
        projectEnvironments:
            - string
        projectKey: string
        propertySets:
            - string
        repoLayoutRef: string
        xrayIndex: false
    

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

    Key string
    the identity key of the repo.
    AnonymousAccess bool
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    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'
    Description string
    Public description.
    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.
    EnableSparseIndex bool
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    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 (/*).
    IndexCompressionFormats List<string>
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    PropertySets List<string>
    List of property set name
    RepoLayoutRef string
    Repository layout key for the local 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.
    AnonymousAccess bool
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    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'
    Description string
    Public description.
    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.
    EnableSparseIndex bool
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    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 (/*).
    IndexCompressionFormats []string
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    PropertySets []string
    List of property set name
    RepoLayoutRef string
    Repository layout key for the local 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.
    anonymousAccess Boolean
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    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'
    description String
    Public description.
    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.
    enableSparseIndex Boolean
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    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 (/*).
    indexCompressionFormats List<String>
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    propertySets List<String>
    List of property set name
    repoLayoutRef String
    Repository layout key for the local 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.
    anonymousAccess boolean
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    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'
    description string
    Public description.
    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.
    enableSparseIndex boolean
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    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 (/*).
    indexCompressionFormats string[]
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    propertySets string[]
    List of property set name
    repoLayoutRef string
    Repository layout key for the local 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.
    anonymous_access bool
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    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'
    description str
    Public description.
    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.
    enable_sparse_index bool
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    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 (/*).
    index_compression_formats Sequence[str]
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    property_sets Sequence[str]
    List of property set name
    repo_layout_ref str
    Repository layout key for the local 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.
    anonymousAccess Boolean
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    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'
    description String
    Public description.
    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.
    enableSparseIndex Boolean
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    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 (/*).
    indexCompressionFormats List<String>
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    propertySets List<String>
    List of property set name
    repoLayoutRef String
    Repository layout key for the local 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 LocalCargoRepository 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 LocalCargoRepository Resource

    Get an existing LocalCargoRepository 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?: LocalCargoRepositoryState, opts?: CustomResourceOptions): LocalCargoRepository
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            anonymous_access: Optional[bool] = None,
            archive_browsing_enabled: Optional[bool] = None,
            blacked_out: Optional[bool] = None,
            cdn_redirect: Optional[bool] = None,
            description: Optional[str] = None,
            download_direct: Optional[bool] = None,
            enable_sparse_index: Optional[bool] = None,
            excludes_pattern: Optional[str] = None,
            includes_pattern: Optional[str] = None,
            index_compression_formats: Optional[Sequence[str]] = None,
            key: Optional[str] = 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,
            repo_layout_ref: Optional[str] = None,
            xray_index: Optional[bool] = None) -> LocalCargoRepository
    func GetLocalCargoRepository(ctx *Context, name string, id IDInput, state *LocalCargoRepositoryState, opts ...ResourceOption) (*LocalCargoRepository, error)
    public static LocalCargoRepository Get(string name, Input<string> id, LocalCargoRepositoryState? state, CustomResourceOptions? opts = null)
    public static LocalCargoRepository get(String name, Output<String> id, LocalCargoRepositoryState 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:
    AnonymousAccess bool
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    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'
    Description string
    Public description.
    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.
    EnableSparseIndex bool
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    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 (/*).
    IndexCompressionFormats List<string>
    Key string
    the identity key of the repo.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    PropertySets List<string>
    List of property set name
    RepoLayoutRef string
    Repository layout key for the local 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.
    AnonymousAccess bool
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    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'
    Description string
    Public description.
    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.
    EnableSparseIndex bool
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    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 (/*).
    IndexCompressionFormats []string
    Key string
    the identity key of the repo.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    PropertySets []string
    List of property set name
    RepoLayoutRef string
    Repository layout key for the local 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.
    anonymousAccess Boolean
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    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'
    description String
    Public description.
    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.
    enableSparseIndex Boolean
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    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 (/*).
    indexCompressionFormats List<String>
    key String
    the identity key of the repo.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    propertySets List<String>
    List of property set name
    repoLayoutRef String
    Repository layout key for the local 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.
    anonymousAccess boolean
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    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'
    description string
    Public description.
    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.
    enableSparseIndex boolean
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    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 (/*).
    indexCompressionFormats string[]
    key string
    the identity key of the repo.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    propertySets string[]
    List of property set name
    repoLayoutRef string
    Repository layout key for the local 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.
    anonymous_access bool
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    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'
    description str
    Public description.
    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.
    enable_sparse_index bool
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    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 (/*).
    index_compression_formats Sequence[str]
    key str
    the identity key of the repo.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    property_sets Sequence[str]
    List of property set name
    repo_layout_ref str
    Repository layout key for the local 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.
    anonymousAccess Boolean
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    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'
    description String
    Public description.
    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.
    enableSparseIndex Boolean
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    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 (/*).
    indexCompressionFormats List<String>
    key String
    the identity key of the repo.
    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 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    propertySets List<String>
    List of property set name
    repoLayoutRef String
    Repository layout key for the local 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.

    Import

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

    $ pulumi import artifactory:index/localCargoRepository:LocalCargoRepository terraform-local-test-cargo-repo-basic terraform-local-test-cargo-repo-basic
    

    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.7.0 published on Friday, Apr 19, 2024 by Pulumi