artifactory.RemoteMavenRepository
Explore with Pulumi AI
Creates a remote Maven repository. Official documentation can be found here.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as artifactory from "@pulumi/artifactory";
const maven_remote = new artifactory.RemoteMavenRepository("maven-remote", {
key: "maven-remote-foo",
url: "https://repo1.maven.org/maven2/",
fetchJarsEagerly: true,
fetchSourcesEagerly: false,
suppressPomConsistencyChecks: false,
rejectInvalidJars: true,
metadataRetrievalTimeoutSecs: 120,
maxUniqueSnapshots: 10,
});
import pulumi
import pulumi_artifactory as artifactory
maven_remote = artifactory.RemoteMavenRepository("maven-remote",
key="maven-remote-foo",
url="https://repo1.maven.org/maven2/",
fetch_jars_eagerly=True,
fetch_sources_eagerly=False,
suppress_pom_consistency_checks=False,
reject_invalid_jars=True,
metadata_retrieval_timeout_secs=120,
max_unique_snapshots=10)
package main
import (
"github.com/pulumi/pulumi-artifactory/sdk/v8/go/artifactory"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := artifactory.NewRemoteMavenRepository(ctx, "maven-remote", &artifactory.RemoteMavenRepositoryArgs{
Key: pulumi.String("maven-remote-foo"),
Url: pulumi.String("https://repo1.maven.org/maven2/"),
FetchJarsEagerly: pulumi.Bool(true),
FetchSourcesEagerly: pulumi.Bool(false),
SuppressPomConsistencyChecks: pulumi.Bool(false),
RejectInvalidJars: pulumi.Bool(true),
MetadataRetrievalTimeoutSecs: pulumi.Int(120),
MaxUniqueSnapshots: pulumi.Int(10),
})
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 maven_remote = new Artifactory.RemoteMavenRepository("maven-remote", new()
{
Key = "maven-remote-foo",
Url = "https://repo1.maven.org/maven2/",
FetchJarsEagerly = true,
FetchSourcesEagerly = false,
SuppressPomConsistencyChecks = false,
RejectInvalidJars = true,
MetadataRetrievalTimeoutSecs = 120,
MaxUniqueSnapshots = 10,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.artifactory.RemoteMavenRepository;
import com.pulumi.artifactory.RemoteMavenRepositoryArgs;
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 maven_remote = new RemoteMavenRepository("maven-remote", RemoteMavenRepositoryArgs.builder()
.key("maven-remote-foo")
.url("https://repo1.maven.org/maven2/")
.fetchJarsEagerly(true)
.fetchSourcesEagerly(false)
.suppressPomConsistencyChecks(false)
.rejectInvalidJars(true)
.metadataRetrievalTimeoutSecs(120)
.maxUniqueSnapshots(10)
.build());
}
}
resources:
maven-remote:
type: artifactory:RemoteMavenRepository
properties:
key: maven-remote-foo
url: https://repo1.maven.org/maven2/
fetchJarsEagerly: true
fetchSourcesEagerly: false
suppressPomConsistencyChecks: false
rejectInvalidJars: true
metadataRetrievalTimeoutSecs: 120
maxUniqueSnapshots: 10
Create RemoteMavenRepository Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RemoteMavenRepository(name: string, args: RemoteMavenRepositoryArgs, opts?: CustomResourceOptions);
@overload
def RemoteMavenRepository(resource_name: str,
args: RemoteMavenRepositoryArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RemoteMavenRepository(resource_name: str,
opts: Optional[ResourceOptions] = None,
key: Optional[str] = None,
allow_any_host_auth: Optional[bool] = None,
archive_browsing_enabled: Optional[bool] = None,
assumed_offline_period_secs: Optional[int] = None,
blacked_out: Optional[bool] = None,
block_mismatching_mime_types: Optional[bool] = None,
bypass_head_requests: Optional[bool] = None,
cdn_redirect: Optional[bool] = None,
client_tls_certificate: Optional[str] = None,
content_synchronisation: Optional[RemoteMavenRepositoryContentSynchronisationArgs] = None,
curated: Optional[bool] = None,
description: Optional[str] = None,
disable_proxy: Optional[bool] = None,
disable_url_normalization: Optional[bool] = None,
download_direct: Optional[bool] = None,
enable_cookie_management: Optional[bool] = None,
excludes_pattern: Optional[str] = None,
fetch_jars_eagerly: Optional[bool] = None,
fetch_sources_eagerly: Optional[bool] = None,
handle_releases: Optional[bool] = None,
handle_snapshots: Optional[bool] = None,
hard_fail: Optional[bool] = None,
includes_pattern: Optional[str] = None,
list_remote_folder_items: Optional[bool] = None,
local_address: Optional[str] = None,
max_unique_snapshots: Optional[int] = None,
metadata_retrieval_timeout_secs: Optional[int] = None,
mismatching_mime_types_override_list: Optional[str] = None,
missed_cache_period_seconds: Optional[int] = None,
notes: Optional[str] = None,
offline: Optional[bool] = None,
password: Optional[str] = None,
priority_resolution: Optional[bool] = None,
project_environments: Optional[Sequence[str]] = None,
project_key: Optional[str] = None,
property_sets: Optional[Sequence[str]] = None,
proxy: Optional[str] = None,
query_params: Optional[str] = None,
reject_invalid_jars: Optional[bool] = None,
remote_repo_checksum_policy_type: Optional[str] = None,
remote_repo_layout_ref: Optional[str] = None,
repo_layout_ref: Optional[str] = None,
retrieval_cache_period_seconds: Optional[int] = None,
share_configuration: Optional[bool] = None,
socket_timeout_millis: Optional[int] = None,
store_artifacts_locally: Optional[bool] = None,
suppress_pom_consistency_checks: Optional[bool] = None,
synchronize_properties: Optional[bool] = None,
unused_artifacts_cleanup_period_hours: Optional[int] = None,
url: Optional[str] = None,
username: Optional[str] = None,
xray_index: Optional[bool] = None)
func NewRemoteMavenRepository(ctx *Context, name string, args RemoteMavenRepositoryArgs, opts ...ResourceOption) (*RemoteMavenRepository, error)
public RemoteMavenRepository(string name, RemoteMavenRepositoryArgs args, CustomResourceOptions? opts = null)
public RemoteMavenRepository(String name, RemoteMavenRepositoryArgs args)
public RemoteMavenRepository(String name, RemoteMavenRepositoryArgs args, CustomResourceOptions options)
type: artifactory:RemoteMavenRepository
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 RemoteMavenRepositoryArgs
- 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 RemoteMavenRepositoryArgs
- 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 RemoteMavenRepositoryArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RemoteMavenRepositoryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RemoteMavenRepositoryArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var remoteMavenRepositoryResource = new Artifactory.RemoteMavenRepository("remoteMavenRepositoryResource", new()
{
Key = "string",
AllowAnyHostAuth = false,
ArchiveBrowsingEnabled = false,
AssumedOfflinePeriodSecs = 0,
BlackedOut = false,
BlockMismatchingMimeTypes = false,
BypassHeadRequests = false,
CdnRedirect = false,
ClientTlsCertificate = "string",
ContentSynchronisation = new Artifactory.Inputs.RemoteMavenRepositoryContentSynchronisationArgs
{
Enabled = false,
PropertiesEnabled = false,
SourceOriginAbsenceDetection = false,
StatisticsEnabled = false,
},
Curated = false,
Description = "string",
DisableProxy = false,
DisableUrlNormalization = false,
DownloadDirect = false,
EnableCookieManagement = false,
ExcludesPattern = "string",
FetchJarsEagerly = false,
FetchSourcesEagerly = false,
HandleReleases = false,
HandleSnapshots = false,
HardFail = false,
IncludesPattern = "string",
ListRemoteFolderItems = false,
LocalAddress = "string",
MaxUniqueSnapshots = 0,
MetadataRetrievalTimeoutSecs = 0,
MismatchingMimeTypesOverrideList = "string",
MissedCachePeriodSeconds = 0,
Notes = "string",
Offline = false,
Password = "string",
PriorityResolution = false,
ProjectEnvironments = new[]
{
"string",
},
ProjectKey = "string",
PropertySets = new[]
{
"string",
},
Proxy = "string",
QueryParams = "string",
RejectInvalidJars = false,
RemoteRepoChecksumPolicyType = "string",
RemoteRepoLayoutRef = "string",
RepoLayoutRef = "string",
RetrievalCachePeriodSeconds = 0,
ShareConfiguration = false,
SocketTimeoutMillis = 0,
StoreArtifactsLocally = false,
SuppressPomConsistencyChecks = false,
SynchronizeProperties = false,
UnusedArtifactsCleanupPeriodHours = 0,
Url = "string",
Username = "string",
XrayIndex = false,
});
example, err := artifactory.NewRemoteMavenRepository(ctx, "remoteMavenRepositoryResource", &artifactory.RemoteMavenRepositoryArgs{
Key: pulumi.String("string"),
AllowAnyHostAuth: pulumi.Bool(false),
ArchiveBrowsingEnabled: pulumi.Bool(false),
AssumedOfflinePeriodSecs: pulumi.Int(0),
BlackedOut: pulumi.Bool(false),
BlockMismatchingMimeTypes: pulumi.Bool(false),
BypassHeadRequests: pulumi.Bool(false),
CdnRedirect: pulumi.Bool(false),
ClientTlsCertificate: pulumi.String("string"),
ContentSynchronisation: &artifactory.RemoteMavenRepositoryContentSynchronisationArgs{
Enabled: pulumi.Bool(false),
PropertiesEnabled: pulumi.Bool(false),
SourceOriginAbsenceDetection: pulumi.Bool(false),
StatisticsEnabled: pulumi.Bool(false),
},
Curated: pulumi.Bool(false),
Description: pulumi.String("string"),
DisableProxy: pulumi.Bool(false),
DisableUrlNormalization: pulumi.Bool(false),
DownloadDirect: pulumi.Bool(false),
EnableCookieManagement: pulumi.Bool(false),
ExcludesPattern: pulumi.String("string"),
FetchJarsEagerly: pulumi.Bool(false),
FetchSourcesEagerly: pulumi.Bool(false),
HandleReleases: pulumi.Bool(false),
HandleSnapshots: pulumi.Bool(false),
HardFail: pulumi.Bool(false),
IncludesPattern: pulumi.String("string"),
ListRemoteFolderItems: pulumi.Bool(false),
LocalAddress: pulumi.String("string"),
MaxUniqueSnapshots: pulumi.Int(0),
MetadataRetrievalTimeoutSecs: pulumi.Int(0),
MismatchingMimeTypesOverrideList: pulumi.String("string"),
MissedCachePeriodSeconds: pulumi.Int(0),
Notes: pulumi.String("string"),
Offline: pulumi.Bool(false),
Password: pulumi.String("string"),
PriorityResolution: pulumi.Bool(false),
ProjectEnvironments: pulumi.StringArray{
pulumi.String("string"),
},
ProjectKey: pulumi.String("string"),
PropertySets: pulumi.StringArray{
pulumi.String("string"),
},
Proxy: pulumi.String("string"),
QueryParams: pulumi.String("string"),
RejectInvalidJars: pulumi.Bool(false),
RemoteRepoChecksumPolicyType: pulumi.String("string"),
RemoteRepoLayoutRef: pulumi.String("string"),
RepoLayoutRef: pulumi.String("string"),
RetrievalCachePeriodSeconds: pulumi.Int(0),
ShareConfiguration: pulumi.Bool(false),
SocketTimeoutMillis: pulumi.Int(0),
StoreArtifactsLocally: pulumi.Bool(false),
SuppressPomConsistencyChecks: pulumi.Bool(false),
SynchronizeProperties: pulumi.Bool(false),
UnusedArtifactsCleanupPeriodHours: pulumi.Int(0),
Url: pulumi.String("string"),
Username: pulumi.String("string"),
XrayIndex: pulumi.Bool(false),
})
var remoteMavenRepositoryResource = new RemoteMavenRepository("remoteMavenRepositoryResource", RemoteMavenRepositoryArgs.builder()
.key("string")
.allowAnyHostAuth(false)
.archiveBrowsingEnabled(false)
.assumedOfflinePeriodSecs(0)
.blackedOut(false)
.blockMismatchingMimeTypes(false)
.bypassHeadRequests(false)
.cdnRedirect(false)
.clientTlsCertificate("string")
.contentSynchronisation(RemoteMavenRepositoryContentSynchronisationArgs.builder()
.enabled(false)
.propertiesEnabled(false)
.sourceOriginAbsenceDetection(false)
.statisticsEnabled(false)
.build())
.curated(false)
.description("string")
.disableProxy(false)
.disableUrlNormalization(false)
.downloadDirect(false)
.enableCookieManagement(false)
.excludesPattern("string")
.fetchJarsEagerly(false)
.fetchSourcesEagerly(false)
.handleReleases(false)
.handleSnapshots(false)
.hardFail(false)
.includesPattern("string")
.listRemoteFolderItems(false)
.localAddress("string")
.maxUniqueSnapshots(0)
.metadataRetrievalTimeoutSecs(0)
.mismatchingMimeTypesOverrideList("string")
.missedCachePeriodSeconds(0)
.notes("string")
.offline(false)
.password("string")
.priorityResolution(false)
.projectEnvironments("string")
.projectKey("string")
.propertySets("string")
.proxy("string")
.queryParams("string")
.rejectInvalidJars(false)
.remoteRepoChecksumPolicyType("string")
.remoteRepoLayoutRef("string")
.repoLayoutRef("string")
.retrievalCachePeriodSeconds(0)
.shareConfiguration(false)
.socketTimeoutMillis(0)
.storeArtifactsLocally(false)
.suppressPomConsistencyChecks(false)
.synchronizeProperties(false)
.unusedArtifactsCleanupPeriodHours(0)
.url("string")
.username("string")
.xrayIndex(false)
.build());
remote_maven_repository_resource = artifactory.RemoteMavenRepository("remoteMavenRepositoryResource",
key="string",
allow_any_host_auth=False,
archive_browsing_enabled=False,
assumed_offline_period_secs=0,
blacked_out=False,
block_mismatching_mime_types=False,
bypass_head_requests=False,
cdn_redirect=False,
client_tls_certificate="string",
content_synchronisation={
"enabled": False,
"properties_enabled": False,
"source_origin_absence_detection": False,
"statistics_enabled": False,
},
curated=False,
description="string",
disable_proxy=False,
disable_url_normalization=False,
download_direct=False,
enable_cookie_management=False,
excludes_pattern="string",
fetch_jars_eagerly=False,
fetch_sources_eagerly=False,
handle_releases=False,
handle_snapshots=False,
hard_fail=False,
includes_pattern="string",
list_remote_folder_items=False,
local_address="string",
max_unique_snapshots=0,
metadata_retrieval_timeout_secs=0,
mismatching_mime_types_override_list="string",
missed_cache_period_seconds=0,
notes="string",
offline=False,
password="string",
priority_resolution=False,
project_environments=["string"],
project_key="string",
property_sets=["string"],
proxy="string",
query_params="string",
reject_invalid_jars=False,
remote_repo_checksum_policy_type="string",
remote_repo_layout_ref="string",
repo_layout_ref="string",
retrieval_cache_period_seconds=0,
share_configuration=False,
socket_timeout_millis=0,
store_artifacts_locally=False,
suppress_pom_consistency_checks=False,
synchronize_properties=False,
unused_artifacts_cleanup_period_hours=0,
url="string",
username="string",
xray_index=False)
const remoteMavenRepositoryResource = new artifactory.RemoteMavenRepository("remoteMavenRepositoryResource", {
key: "string",
allowAnyHostAuth: false,
archiveBrowsingEnabled: false,
assumedOfflinePeriodSecs: 0,
blackedOut: false,
blockMismatchingMimeTypes: false,
bypassHeadRequests: false,
cdnRedirect: false,
clientTlsCertificate: "string",
contentSynchronisation: {
enabled: false,
propertiesEnabled: false,
sourceOriginAbsenceDetection: false,
statisticsEnabled: false,
},
curated: false,
description: "string",
disableProxy: false,
disableUrlNormalization: false,
downloadDirect: false,
enableCookieManagement: false,
excludesPattern: "string",
fetchJarsEagerly: false,
fetchSourcesEagerly: false,
handleReleases: false,
handleSnapshots: false,
hardFail: false,
includesPattern: "string",
listRemoteFolderItems: false,
localAddress: "string",
maxUniqueSnapshots: 0,
metadataRetrievalTimeoutSecs: 0,
mismatchingMimeTypesOverrideList: "string",
missedCachePeriodSeconds: 0,
notes: "string",
offline: false,
password: "string",
priorityResolution: false,
projectEnvironments: ["string"],
projectKey: "string",
propertySets: ["string"],
proxy: "string",
queryParams: "string",
rejectInvalidJars: false,
remoteRepoChecksumPolicyType: "string",
remoteRepoLayoutRef: "string",
repoLayoutRef: "string",
retrievalCachePeriodSeconds: 0,
shareConfiguration: false,
socketTimeoutMillis: 0,
storeArtifactsLocally: false,
suppressPomConsistencyChecks: false,
synchronizeProperties: false,
unusedArtifactsCleanupPeriodHours: 0,
url: "string",
username: "string",
xrayIndex: false,
});
type: artifactory:RemoteMavenRepository
properties:
allowAnyHostAuth: false
archiveBrowsingEnabled: false
assumedOfflinePeriodSecs: 0
blackedOut: false
blockMismatchingMimeTypes: false
bypassHeadRequests: false
cdnRedirect: false
clientTlsCertificate: string
contentSynchronisation:
enabled: false
propertiesEnabled: false
sourceOriginAbsenceDetection: false
statisticsEnabled: false
curated: false
description: string
disableProxy: false
disableUrlNormalization: false
downloadDirect: false
enableCookieManagement: false
excludesPattern: string
fetchJarsEagerly: false
fetchSourcesEagerly: false
handleReleases: false
handleSnapshots: false
hardFail: false
includesPattern: string
key: string
listRemoteFolderItems: false
localAddress: string
maxUniqueSnapshots: 0
metadataRetrievalTimeoutSecs: 0
mismatchingMimeTypesOverrideList: string
missedCachePeriodSeconds: 0
notes: string
offline: false
password: string
priorityResolution: false
projectEnvironments:
- string
projectKey: string
propertySets:
- string
proxy: string
queryParams: string
rejectInvalidJars: false
remoteRepoChecksumPolicyType: string
remoteRepoLayoutRef: string
repoLayoutRef: string
retrievalCachePeriodSeconds: 0
shareConfiguration: false
socketTimeoutMillis: 0
storeArtifactsLocally: false
suppressPomConsistencyChecks: false
synchronizeProperties: false
unusedArtifactsCleanupPeriodHours: 0
url: string
username: string
xrayIndex: false
RemoteMavenRepository Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The RemoteMavenRepository 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.
- Allow
Any boolHost Auth - 'Lenient Host Authentication' in the UI. Allow credentials of this repository to be used on requests redirected to any other host.
- Archive
Browsing boolEnabled - 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).
- Assumed
Offline intPeriod Secs - The number of seconds the repository stays in assumed offline state after a connection error. At the end of this time, an online check is attempted in order to reset the offline status. A value of 0 means the repository is never assumed offline.
- Blacked
Out bool - (A.K.A 'Ignore Repository' on the UI) When set, the repository or its local cache do not participate in artifact resolution.
- Block
Mismatching boolMime Types - If set, artifacts will fail to download if a mismatch is detected between requested and received mimetype, according to the list specified in the system properties file under blockedMismatchingMimeTypes. You can override by adding mimetypes to the override list 'mismatching_mime_types_override_list'.
- Bypass
Head boolRequests - Before caching an artifact, Artifactory first sends a HEAD request to the remote resource. In some remote resources, HEAD requests are disallowed and therefore rejected, even though downloading the artifact is allowed. When checked, Artifactory will bypass the HEAD request and cache the artifact directly using a GET request.
- 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'
- Client
Tls stringCertificate - Client TLS certificate name.
- Content
Synchronisation RemoteMaven Repository Content Synchronisation - Curated bool
- Enable repository to be protected by the Curation service.
- Description string
- Public description.
- Disable
Proxy bool - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. Introduced since Artifactory 7.41.7. - Disable
Url boolNormalization - Whether to disable URL normalization, default is
false
. - 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. Default value is 'false'.
- bool
- Enables cookie management if the remote repository uses cookies to manage client state.
- Excludes
Pattern string - List of artifact patterns to exclude when evaluating artifact requests, in the form of
x/y/**/z/*
.By default no artifacts are excluded. - Fetch
Jars boolEagerly - When set, if a POM is requested, Artifactory attempts to fetch the corresponding jar in the background. This will accelerate first access time to the jar when it is subsequently requested.
- Fetch
Sources boolEagerly - When set, if a binaries jar is requested, Artifactory attempts to fetch the corresponding source jar in the background. This will accelerate first access time to the source jar when it is subsequently requested.
- Handle
Releases bool - If set, Artifactory allows you to deploy release artifacts into this repository.
- Handle
Snapshots bool - If set, Artifactory allows you to deploy snapshot artifacts into this repository.
- Hard
Fail bool - When set, Artifactory will return an error to the client that causes the build to fail if there is a failure to communicate with this repository.
- Includes
Pattern 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 (**/*
). - List
Remote boolFolder Items - Lists the items of remote folders in simple and list browsing. The remote content is cached according to the value of the 'Retrieval Cache Period'. Default value is 'false'. This field exists in the API but not in the UI.
- Local
Address string - The local address to be used when creating connections. Useful for specifying the interface to use on systems with multiple network interfaces.
- Max
Unique intSnapshots - The maximum number of unique snapshots of a single artifact to store. Once the number of snapshots exceeds this setting, older versions are removed. A value of 0 (default) indicates there is no limit, and unique snapshots are not cleaned up.
- Metadata
Retrieval intTimeout Secs - Metadata Retrieval Cache Timeout (Sec) in the UI.This value refers to the number of seconds to wait for retrieval from the remote before serving locally cached artifact or fail the request.
- Mismatching
Mime stringTypes Override List - The set of mime types that should override the block_mismatching_mime_types setting. Eg: 'application/json,application/xml'. Default value is empty.
- Missed
Cache intPeriod Seconds - Missed Retrieval Cache Period (Sec) in the UI. The number of seconds to cache artifact retrieval misses (artifact not found). A value of 0 indicates no caching.
- Notes string
- Internal description.
- Offline bool
- If set, Artifactory does not try to fetch remote artifacts. Only locally-cached artifacts are retrieved.
- Password string
- Priority
Resolution bool - Setting Priority Resolution takes precedence over the resolution order when resolving virtual repositories. Setting repositories with priority will cause metadata to be merged only from repositories set with a priority. If a package is not found in those repositories, Artifactory will merge from repositories marked as non-priority.
- Project
Environments List<string> - Project
Key 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.
- Property
Sets List<string> - List of property set names
- Proxy string
- Proxy key from Artifactory Proxies settings. Can't be set if
disable_proxy = true
. - Query
Params string - Custom HTTP query parameters that will be automatically included in all remote resource requests. For example:
param1=val1¶m2=val2¶m3=val3
- Reject
Invalid boolJars - Reject the caching of jar files that are found to be invalid. For example, pseudo jars retrieved behind a "captive portal".
- Remote
Repo stringChecksum Policy Type - Checking the Checksum effectively verifies the integrity of a deployed resource. The Checksum Policy determines how the system behaves when a client checksum for a remote resource is missing or conflicts with the locally calculated checksum. Available policies are
generate-if-absent
,fail
,ignore-and-generate
, andpass-thru
. - Remote
Repo stringLayout Ref - Repository layout key for the remote layout mapping. Repository can be created without this attribute (or set to an empty string). Once it's set, it can't be removed by passing an empty string or removing the attribute, that will be ignored by the Artifactory API. UI shows an error message, if the user tries to remove the value.
- Repo
Layout stringRef - Repository layout key for the remote repository
- Retrieval
Cache intPeriod Seconds - Metadata Retrieval Cache Period (Sec) in the UI. This value refers to the number of seconds to cache metadata files before checking for newer versions on remote server. A value of 0 indicates no caching.
- bool
- Socket
Timeout intMillis - Network timeout (in ms) to use when establishing a connection and for unanswered requests. Timing out on a network operation is considered a retrieval failure.
- Store
Artifacts boolLocally - When set, the repository should store cached artifacts locally. When not set, artifacts are not stored locally, and direct repository-to-client streaming is used. This can be useful for multi-server setups over a high-speed LAN, with one Artifactory caching certain data on central storage, and streaming it directly to satellite pass-though Artifactory servers.
- Suppress
Pom boolConsistency Checks - By default, the system keeps your repositories healthy by refusing POMs with incorrect coordinates (path). If the groupId:artifactId:version information inside the POM does not match the deployed path, Artifactory rejects the deployment with a "409 Conflict" error. You can disable this behavior by setting this attribute to
true
. - Synchronize
Properties bool - When set, remote artifacts are fetched along with their properties.
- Unused
Artifacts intCleanup Period Hours - Unused Artifacts Cleanup Period (Hr) in the UI. The number of hours to wait before an artifact is deemed 'unused' and eligible for cleanup from the repository. A value of 0 means automatic cleanup of cached artifacts is disabled.
- Url string
- The remote repo URL.
- Username string
- 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
- A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
- Allow
Any boolHost Auth - 'Lenient Host Authentication' in the UI. Allow credentials of this repository to be used on requests redirected to any other host.
- Archive
Browsing boolEnabled - 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).
- Assumed
Offline intPeriod Secs - The number of seconds the repository stays in assumed offline state after a connection error. At the end of this time, an online check is attempted in order to reset the offline status. A value of 0 means the repository is never assumed offline.
- Blacked
Out bool - (A.K.A 'Ignore Repository' on the UI) When set, the repository or its local cache do not participate in artifact resolution.
- Block
Mismatching boolMime Types - If set, artifacts will fail to download if a mismatch is detected between requested and received mimetype, according to the list specified in the system properties file under blockedMismatchingMimeTypes. You can override by adding mimetypes to the override list 'mismatching_mime_types_override_list'.
- Bypass
Head boolRequests - Before caching an artifact, Artifactory first sends a HEAD request to the remote resource. In some remote resources, HEAD requests are disallowed and therefore rejected, even though downloading the artifact is allowed. When checked, Artifactory will bypass the HEAD request and cache the artifact directly using a GET request.
- 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'
- Client
Tls stringCertificate - Client TLS certificate name.
- Content
Synchronisation RemoteMaven Repository Content Synchronisation Args - Curated bool
- Enable repository to be protected by the Curation service.
- Description string
- Public description.
- Disable
Proxy bool - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. Introduced since Artifactory 7.41.7. - Disable
Url boolNormalization - Whether to disable URL normalization, default is
false
. - 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. Default value is 'false'.
- bool
- Enables cookie management if the remote repository uses cookies to manage client state.
- Excludes
Pattern string - List of artifact patterns to exclude when evaluating artifact requests, in the form of
x/y/**/z/*
.By default no artifacts are excluded. - Fetch
Jars boolEagerly - When set, if a POM is requested, Artifactory attempts to fetch the corresponding jar in the background. This will accelerate first access time to the jar when it is subsequently requested.
- Fetch
Sources boolEagerly - When set, if a binaries jar is requested, Artifactory attempts to fetch the corresponding source jar in the background. This will accelerate first access time to the source jar when it is subsequently requested.
- Handle
Releases bool - If set, Artifactory allows you to deploy release artifacts into this repository.
- Handle
Snapshots bool - If set, Artifactory allows you to deploy snapshot artifacts into this repository.
- Hard
Fail bool - When set, Artifactory will return an error to the client that causes the build to fail if there is a failure to communicate with this repository.
- Includes
Pattern 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 (**/*
). - List
Remote boolFolder Items - Lists the items of remote folders in simple and list browsing. The remote content is cached according to the value of the 'Retrieval Cache Period'. Default value is 'false'. This field exists in the API but not in the UI.
- Local
Address string - The local address to be used when creating connections. Useful for specifying the interface to use on systems with multiple network interfaces.
- Max
Unique intSnapshots - The maximum number of unique snapshots of a single artifact to store. Once the number of snapshots exceeds this setting, older versions are removed. A value of 0 (default) indicates there is no limit, and unique snapshots are not cleaned up.
- Metadata
Retrieval intTimeout Secs - Metadata Retrieval Cache Timeout (Sec) in the UI.This value refers to the number of seconds to wait for retrieval from the remote before serving locally cached artifact or fail the request.
- Mismatching
Mime stringTypes Override List - The set of mime types that should override the block_mismatching_mime_types setting. Eg: 'application/json,application/xml'. Default value is empty.
- Missed
Cache intPeriod Seconds - Missed Retrieval Cache Period (Sec) in the UI. The number of seconds to cache artifact retrieval misses (artifact not found). A value of 0 indicates no caching.
- Notes string
- Internal description.
- Offline bool
- If set, Artifactory does not try to fetch remote artifacts. Only locally-cached artifacts are retrieved.
- Password string
- Priority
Resolution bool - Setting Priority Resolution takes precedence over the resolution order when resolving virtual repositories. Setting repositories with priority will cause metadata to be merged only from repositories set with a priority. If a package is not found in those repositories, Artifactory will merge from repositories marked as non-priority.
- Project
Environments []string - Project
Key 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.
- Property
Sets []string - List of property set names
- Proxy string
- Proxy key from Artifactory Proxies settings. Can't be set if
disable_proxy = true
. - Query
Params string - Custom HTTP query parameters that will be automatically included in all remote resource requests. For example:
param1=val1¶m2=val2¶m3=val3
- Reject
Invalid boolJars - Reject the caching of jar files that are found to be invalid. For example, pseudo jars retrieved behind a "captive portal".
- Remote
Repo stringChecksum Policy Type - Checking the Checksum effectively verifies the integrity of a deployed resource. The Checksum Policy determines how the system behaves when a client checksum for a remote resource is missing or conflicts with the locally calculated checksum. Available policies are
generate-if-absent
,fail
,ignore-and-generate
, andpass-thru
. - Remote
Repo stringLayout Ref - Repository layout key for the remote layout mapping. Repository can be created without this attribute (or set to an empty string). Once it's set, it can't be removed by passing an empty string or removing the attribute, that will be ignored by the Artifactory API. UI shows an error message, if the user tries to remove the value.
- Repo
Layout stringRef - Repository layout key for the remote repository
- Retrieval
Cache intPeriod Seconds - Metadata Retrieval Cache Period (Sec) in the UI. This value refers to the number of seconds to cache metadata files before checking for newer versions on remote server. A value of 0 indicates no caching.
- bool
- Socket
Timeout intMillis - Network timeout (in ms) to use when establishing a connection and for unanswered requests. Timing out on a network operation is considered a retrieval failure.
- Store
Artifacts boolLocally - When set, the repository should store cached artifacts locally. When not set, artifacts are not stored locally, and direct repository-to-client streaming is used. This can be useful for multi-server setups over a high-speed LAN, with one Artifactory caching certain data on central storage, and streaming it directly to satellite pass-though Artifactory servers.
- Suppress
Pom boolConsistency Checks - By default, the system keeps your repositories healthy by refusing POMs with incorrect coordinates (path). If the groupId:artifactId:version information inside the POM does not match the deployed path, Artifactory rejects the deployment with a "409 Conflict" error. You can disable this behavior by setting this attribute to
true
. - Synchronize
Properties bool - When set, remote artifacts are fetched along with their properties.
- Unused
Artifacts intCleanup Period Hours - Unused Artifacts Cleanup Period (Hr) in the UI. The number of hours to wait before an artifact is deemed 'unused' and eligible for cleanup from the repository. A value of 0 means automatic cleanup of cached artifacts is disabled.
- Url string
- The remote repo URL.
- Username string
- 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
- A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
- allow
Any BooleanHost Auth - 'Lenient Host Authentication' in the UI. Allow credentials of this repository to be used on requests redirected to any other host.
- archive
Browsing BooleanEnabled - 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).
- assumed
Offline IntegerPeriod Secs - The number of seconds the repository stays in assumed offline state after a connection error. At the end of this time, an online check is attempted in order to reset the offline status. A value of 0 means the repository is never assumed offline.
- blacked
Out Boolean - (A.K.A 'Ignore Repository' on the UI) When set, the repository or its local cache do not participate in artifact resolution.
- block
Mismatching BooleanMime Types - If set, artifacts will fail to download if a mismatch is detected between requested and received mimetype, according to the list specified in the system properties file under blockedMismatchingMimeTypes. You can override by adding mimetypes to the override list 'mismatching_mime_types_override_list'.
- bypass
Head BooleanRequests - Before caching an artifact, Artifactory first sends a HEAD request to the remote resource. In some remote resources, HEAD requests are disallowed and therefore rejected, even though downloading the artifact is allowed. When checked, Artifactory will bypass the HEAD request and cache the artifact directly using a GET request.
- cdn
Redirect 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'
- client
Tls StringCertificate - Client TLS certificate name.
- content
Synchronisation RemoteMaven Repository Content Synchronisation - curated Boolean
- Enable repository to be protected by the Curation service.
- description String
- Public description.
- disable
Proxy Boolean - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. Introduced since Artifactory 7.41.7. - disable
Url BooleanNormalization - Whether to disable URL normalization, default is
false
. - download
Direct 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. Default value is 'false'.
- Boolean
- Enables cookie management if the remote repository uses cookies to manage client state.
- excludes
Pattern String - List of artifact patterns to exclude when evaluating artifact requests, in the form of
x/y/**/z/*
.By default no artifacts are excluded. - fetch
Jars BooleanEagerly - When set, if a POM is requested, Artifactory attempts to fetch the corresponding jar in the background. This will accelerate first access time to the jar when it is subsequently requested.
- fetch
Sources BooleanEagerly - When set, if a binaries jar is requested, Artifactory attempts to fetch the corresponding source jar in the background. This will accelerate first access time to the source jar when it is subsequently requested.
- handle
Releases Boolean - If set, Artifactory allows you to deploy release artifacts into this repository.
- handle
Snapshots Boolean - If set, Artifactory allows you to deploy snapshot artifacts into this repository.
- hard
Fail Boolean - When set, Artifactory will return an error to the client that causes the build to fail if there is a failure to communicate with this repository.
- includes
Pattern 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 (**/*
). - list
Remote BooleanFolder Items - Lists the items of remote folders in simple and list browsing. The remote content is cached according to the value of the 'Retrieval Cache Period'. Default value is 'false'. This field exists in the API but not in the UI.
- local
Address String - The local address to be used when creating connections. Useful for specifying the interface to use on systems with multiple network interfaces.
- max
Unique IntegerSnapshots - The maximum number of unique snapshots of a single artifact to store. Once the number of snapshots exceeds this setting, older versions are removed. A value of 0 (default) indicates there is no limit, and unique snapshots are not cleaned up.
- metadata
Retrieval IntegerTimeout Secs - Metadata Retrieval Cache Timeout (Sec) in the UI.This value refers to the number of seconds to wait for retrieval from the remote before serving locally cached artifact or fail the request.
- mismatching
Mime StringTypes Override List - The set of mime types that should override the block_mismatching_mime_types setting. Eg: 'application/json,application/xml'. Default value is empty.
- missed
Cache IntegerPeriod Seconds - Missed Retrieval Cache Period (Sec) in the UI. The number of seconds to cache artifact retrieval misses (artifact not found). A value of 0 indicates no caching.
- notes String
- Internal description.
- offline Boolean
- If set, Artifactory does not try to fetch remote artifacts. Only locally-cached artifacts are retrieved.
- password String
- priority
Resolution Boolean - Setting Priority Resolution takes precedence over the resolution order when resolving virtual repositories. Setting repositories with priority will cause metadata to be merged only from repositories set with a priority. If a package is not found in those repositories, Artifactory will merge from repositories marked as non-priority.
- project
Environments List<String> - project
Key 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.
- property
Sets List<String> - List of property set names
- proxy String
- Proxy key from Artifactory Proxies settings. Can't be set if
disable_proxy = true
. - query
Params String - Custom HTTP query parameters that will be automatically included in all remote resource requests. For example:
param1=val1¶m2=val2¶m3=val3
- reject
Invalid BooleanJars - Reject the caching of jar files that are found to be invalid. For example, pseudo jars retrieved behind a "captive portal".
- remote
Repo StringChecksum Policy Type - Checking the Checksum effectively verifies the integrity of a deployed resource. The Checksum Policy determines how the system behaves when a client checksum for a remote resource is missing or conflicts with the locally calculated checksum. Available policies are
generate-if-absent
,fail
,ignore-and-generate
, andpass-thru
. - remote
Repo StringLayout Ref - Repository layout key for the remote layout mapping. Repository can be created without this attribute (or set to an empty string). Once it's set, it can't be removed by passing an empty string or removing the attribute, that will be ignored by the Artifactory API. UI shows an error message, if the user tries to remove the value.
- repo
Layout StringRef - Repository layout key for the remote repository
- retrieval
Cache IntegerPeriod Seconds - Metadata Retrieval Cache Period (Sec) in the UI. This value refers to the number of seconds to cache metadata files before checking for newer versions on remote server. A value of 0 indicates no caching.
- Boolean
- socket
Timeout IntegerMillis - Network timeout (in ms) to use when establishing a connection and for unanswered requests. Timing out on a network operation is considered a retrieval failure.
- store
Artifacts BooleanLocally - When set, the repository should store cached artifacts locally. When not set, artifacts are not stored locally, and direct repository-to-client streaming is used. This can be useful for multi-server setups over a high-speed LAN, with one Artifactory caching certain data on central storage, and streaming it directly to satellite pass-though Artifactory servers.
- suppress
Pom BooleanConsistency Checks - By default, the system keeps your repositories healthy by refusing POMs with incorrect coordinates (path). If the groupId:artifactId:version information inside the POM does not match the deployed path, Artifactory rejects the deployment with a "409 Conflict" error. You can disable this behavior by setting this attribute to
true
. - synchronize
Properties Boolean - When set, remote artifacts are fetched along with their properties.
- unused
Artifacts IntegerCleanup Period Hours - Unused Artifacts Cleanup Period (Hr) in the UI. The number of hours to wait before an artifact is deemed 'unused' and eligible for cleanup from the repository. A value of 0 means automatic cleanup of cached artifacts is disabled.
- url String
- The remote repo URL.
- username String
- xray
Index 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
- A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
- allow
Any booleanHost Auth - 'Lenient Host Authentication' in the UI. Allow credentials of this repository to be used on requests redirected to any other host.
- archive
Browsing booleanEnabled - 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).
- assumed
Offline numberPeriod Secs - The number of seconds the repository stays in assumed offline state after a connection error. At the end of this time, an online check is attempted in order to reset the offline status. A value of 0 means the repository is never assumed offline.
- blacked
Out boolean - (A.K.A 'Ignore Repository' on the UI) When set, the repository or its local cache do not participate in artifact resolution.
- block
Mismatching booleanMime Types - If set, artifacts will fail to download if a mismatch is detected between requested and received mimetype, according to the list specified in the system properties file under blockedMismatchingMimeTypes. You can override by adding mimetypes to the override list 'mismatching_mime_types_override_list'.
- bypass
Head booleanRequests - Before caching an artifact, Artifactory first sends a HEAD request to the remote resource. In some remote resources, HEAD requests are disallowed and therefore rejected, even though downloading the artifact is allowed. When checked, Artifactory will bypass the HEAD request and cache the artifact directly using a GET request.
- cdn
Redirect 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'
- client
Tls stringCertificate - Client TLS certificate name.
- content
Synchronisation RemoteMaven Repository Content Synchronisation - curated boolean
- Enable repository to be protected by the Curation service.
- description string
- Public description.
- disable
Proxy boolean - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. Introduced since Artifactory 7.41.7. - disable
Url booleanNormalization - Whether to disable URL normalization, default is
false
. - download
Direct 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. Default value is 'false'.
- boolean
- Enables cookie management if the remote repository uses cookies to manage client state.
- excludes
Pattern string - List of artifact patterns to exclude when evaluating artifact requests, in the form of
x/y/**/z/*
.By default no artifacts are excluded. - fetch
Jars booleanEagerly - When set, if a POM is requested, Artifactory attempts to fetch the corresponding jar in the background. This will accelerate first access time to the jar when it is subsequently requested.
- fetch
Sources booleanEagerly - When set, if a binaries jar is requested, Artifactory attempts to fetch the corresponding source jar in the background. This will accelerate first access time to the source jar when it is subsequently requested.
- handle
Releases boolean - If set, Artifactory allows you to deploy release artifacts into this repository.
- handle
Snapshots boolean - If set, Artifactory allows you to deploy snapshot artifacts into this repository.
- hard
Fail boolean - When set, Artifactory will return an error to the client that causes the build to fail if there is a failure to communicate with this repository.
- includes
Pattern 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 (**/*
). - list
Remote booleanFolder Items - Lists the items of remote folders in simple and list browsing. The remote content is cached according to the value of the 'Retrieval Cache Period'. Default value is 'false'. This field exists in the API but not in the UI.
- local
Address string - The local address to be used when creating connections. Useful for specifying the interface to use on systems with multiple network interfaces.
- max
Unique numberSnapshots - The maximum number of unique snapshots of a single artifact to store. Once the number of snapshots exceeds this setting, older versions are removed. A value of 0 (default) indicates there is no limit, and unique snapshots are not cleaned up.
- metadata
Retrieval numberTimeout Secs - Metadata Retrieval Cache Timeout (Sec) in the UI.This value refers to the number of seconds to wait for retrieval from the remote before serving locally cached artifact or fail the request.
- mismatching
Mime stringTypes Override List - The set of mime types that should override the block_mismatching_mime_types setting. Eg: 'application/json,application/xml'. Default value is empty.
- missed
Cache numberPeriod Seconds - Missed Retrieval Cache Period (Sec) in the UI. The number of seconds to cache artifact retrieval misses (artifact not found). A value of 0 indicates no caching.
- notes string
- Internal description.
- offline boolean
- If set, Artifactory does not try to fetch remote artifacts. Only locally-cached artifacts are retrieved.
- password string
- priority
Resolution boolean - Setting Priority Resolution takes precedence over the resolution order when resolving virtual repositories. Setting repositories with priority will cause metadata to be merged only from repositories set with a priority. If a package is not found in those repositories, Artifactory will merge from repositories marked as non-priority.
- project
Environments string[] - project
Key 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.
- property
Sets string[] - List of property set names
- proxy string
- Proxy key from Artifactory Proxies settings. Can't be set if
disable_proxy = true
. - query
Params string - Custom HTTP query parameters that will be automatically included in all remote resource requests. For example:
param1=val1¶m2=val2¶m3=val3
- reject
Invalid booleanJars - Reject the caching of jar files that are found to be invalid. For example, pseudo jars retrieved behind a "captive portal".
- remote
Repo stringChecksum Policy Type - Checking the Checksum effectively verifies the integrity of a deployed resource. The Checksum Policy determines how the system behaves when a client checksum for a remote resource is missing or conflicts with the locally calculated checksum. Available policies are
generate-if-absent
,fail
,ignore-and-generate
, andpass-thru
. - remote
Repo stringLayout Ref - Repository layout key for the remote layout mapping. Repository can be created without this attribute (or set to an empty string). Once it's set, it can't be removed by passing an empty string or removing the attribute, that will be ignored by the Artifactory API. UI shows an error message, if the user tries to remove the value.
- repo
Layout stringRef - Repository layout key for the remote repository
- retrieval
Cache numberPeriod Seconds - Metadata Retrieval Cache Period (Sec) in the UI. This value refers to the number of seconds to cache metadata files before checking for newer versions on remote server. A value of 0 indicates no caching.
- boolean
- socket
Timeout numberMillis - Network timeout (in ms) to use when establishing a connection and for unanswered requests. Timing out on a network operation is considered a retrieval failure.
- store
Artifacts booleanLocally - When set, the repository should store cached artifacts locally. When not set, artifacts are not stored locally, and direct repository-to-client streaming is used. This can be useful for multi-server setups over a high-speed LAN, with one Artifactory caching certain data on central storage, and streaming it directly to satellite pass-though Artifactory servers.
- suppress
Pom booleanConsistency Checks - By default, the system keeps your repositories healthy by refusing POMs with incorrect coordinates (path). If the groupId:artifactId:version information inside the POM does not match the deployed path, Artifactory rejects the deployment with a "409 Conflict" error. You can disable this behavior by setting this attribute to
true
. - synchronize
Properties boolean - When set, remote artifacts are fetched along with their properties.
- unused
Artifacts numberCleanup Period Hours - Unused Artifacts Cleanup Period (Hr) in the UI. The number of hours to wait before an artifact is deemed 'unused' and eligible for cleanup from the repository. A value of 0 means automatic cleanup of cached artifacts is disabled.
- url string
- The remote repo URL.
- username string
- xray
Index 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
- A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
- allow_
any_ boolhost_ auth - 'Lenient Host Authentication' in the UI. Allow credentials of this repository to be used on requests redirected to any other host.
- archive_
browsing_ boolenabled - 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).
- assumed_
offline_ intperiod_ secs - The number of seconds the repository stays in assumed offline state after a connection error. At the end of this time, an online check is attempted in order to reset the offline status. A value of 0 means the repository is never assumed offline.
- blacked_
out bool - (A.K.A 'Ignore Repository' on the UI) When set, the repository or its local cache do not participate in artifact resolution.
- block_
mismatching_ boolmime_ types - If set, artifacts will fail to download if a mismatch is detected between requested and received mimetype, according to the list specified in the system properties file under blockedMismatchingMimeTypes. You can override by adding mimetypes to the override list 'mismatching_mime_types_override_list'.
- bypass_
head_ boolrequests - Before caching an artifact, Artifactory first sends a HEAD request to the remote resource. In some remote resources, HEAD requests are disallowed and therefore rejected, even though downloading the artifact is allowed. When checked, Artifactory will bypass the HEAD request and cache the artifact directly using a GET request.
- 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'
- client_
tls_ strcertificate - Client TLS certificate name.
- content_
synchronisation RemoteMaven Repository Content Synchronisation Args - curated bool
- Enable repository to be protected by the Curation service.
- description str
- Public description.
- disable_
proxy bool - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. Introduced since Artifactory 7.41.7. - disable_
url_ boolnormalization - Whether to disable URL normalization, default is
false
. - 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. Default value is 'false'.
- bool
- Enables cookie management if the remote repository uses cookies to manage client state.
- 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. - fetch_
jars_ booleagerly - When set, if a POM is requested, Artifactory attempts to fetch the corresponding jar in the background. This will accelerate first access time to the jar when it is subsequently requested.
- fetch_
sources_ booleagerly - When set, if a binaries jar is requested, Artifactory attempts to fetch the corresponding source jar in the background. This will accelerate first access time to the source jar when it is subsequently requested.
- handle_
releases bool - If set, Artifactory allows you to deploy release artifacts into this repository.
- handle_
snapshots bool - If set, Artifactory allows you to deploy snapshot artifacts into this repository.
- hard_
fail bool - When set, Artifactory will return an error to the client that causes the build to fail if there is a failure to communicate with this repository.
- 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 (**/*
). - list_
remote_ boolfolder_ items - Lists the items of remote folders in simple and list browsing. The remote content is cached according to the value of the 'Retrieval Cache Period'. Default value is 'false'. This field exists in the API but not in the UI.
- local_
address str - The local address to be used when creating connections. Useful for specifying the interface to use on systems with multiple network interfaces.
- max_
unique_ intsnapshots - The maximum number of unique snapshots of a single artifact to store. Once the number of snapshots exceeds this setting, older versions are removed. A value of 0 (default) indicates there is no limit, and unique snapshots are not cleaned up.
- metadata_
retrieval_ inttimeout_ secs - Metadata Retrieval Cache Timeout (Sec) in the UI.This value refers to the number of seconds to wait for retrieval from the remote before serving locally cached artifact or fail the request.
- mismatching_
mime_ strtypes_ override_ list - The set of mime types that should override the block_mismatching_mime_types setting. Eg: 'application/json,application/xml'. Default value is empty.
- missed_
cache_ intperiod_ seconds - Missed Retrieval Cache Period (Sec) in the UI. The number of seconds to cache artifact retrieval misses (artifact not found). A value of 0 indicates no caching.
- notes str
- Internal description.
- offline bool
- If set, Artifactory does not try to fetch remote artifacts. Only locally-cached artifacts are retrieved.
- password str
- priority_
resolution bool - Setting Priority Resolution takes precedence over the resolution order when resolving virtual repositories. Setting repositories with priority will cause metadata to be merged only from repositories set with a priority. If a package is not found in those repositories, Artifactory will merge from repositories marked as non-priority.
- project_
environments Sequence[str] - 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 names
- proxy str
- Proxy key from Artifactory Proxies settings. Can't be set if
disable_proxy = true
. - query_
params str - Custom HTTP query parameters that will be automatically included in all remote resource requests. For example:
param1=val1¶m2=val2¶m3=val3
- reject_
invalid_ booljars - Reject the caching of jar files that are found to be invalid. For example, pseudo jars retrieved behind a "captive portal".
- remote_
repo_ strchecksum_ policy_ type - Checking the Checksum effectively verifies the integrity of a deployed resource. The Checksum Policy determines how the system behaves when a client checksum for a remote resource is missing or conflicts with the locally calculated checksum. Available policies are
generate-if-absent
,fail
,ignore-and-generate
, andpass-thru
. - remote_
repo_ strlayout_ ref - Repository layout key for the remote layout mapping. Repository can be created without this attribute (or set to an empty string). Once it's set, it can't be removed by passing an empty string or removing the attribute, that will be ignored by the Artifactory API. UI shows an error message, if the user tries to remove the value.
- repo_
layout_ strref - Repository layout key for the remote repository
- retrieval_
cache_ intperiod_ seconds - Metadata Retrieval Cache Period (Sec) in the UI. This value refers to the number of seconds to cache metadata files before checking for newer versions on remote server. A value of 0 indicates no caching.
- bool
- socket_
timeout_ intmillis - Network timeout (in ms) to use when establishing a connection and for unanswered requests. Timing out on a network operation is considered a retrieval failure.
- store_
artifacts_ boollocally - When set, the repository should store cached artifacts locally. When not set, artifacts are not stored locally, and direct repository-to-client streaming is used. This can be useful for multi-server setups over a high-speed LAN, with one Artifactory caching certain data on central storage, and streaming it directly to satellite pass-though Artifactory servers.
- suppress_
pom_ boolconsistency_ checks - By default, the system keeps your repositories healthy by refusing POMs with incorrect coordinates (path). If the groupId:artifactId:version information inside the POM does not match the deployed path, Artifactory rejects the deployment with a "409 Conflict" error. You can disable this behavior by setting this attribute to
true
. - synchronize_
properties bool - When set, remote artifacts are fetched along with their properties.
- unused_
artifacts_ intcleanup_ period_ hours - Unused Artifacts Cleanup Period (Hr) in the UI. The number of hours to wait before an artifact is deemed 'unused' and eligible for cleanup from the repository. A value of 0 means automatic cleanup of cached artifacts is disabled.
- url str
- The remote repo URL.
- username str
- 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
- A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
- allow
Any BooleanHost Auth - 'Lenient Host Authentication' in the UI. Allow credentials of this repository to be used on requests redirected to any other host.
- archive
Browsing BooleanEnabled - 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).
- assumed
Offline NumberPeriod Secs - The number of seconds the repository stays in assumed offline state after a connection error. At the end of this time, an online check is attempted in order to reset the offline status. A value of 0 means the repository is never assumed offline.
- blacked
Out Boolean - (A.K.A 'Ignore Repository' on the UI) When set, the repository or its local cache do not participate in artifact resolution.
- block
Mismatching BooleanMime Types - If set, artifacts will fail to download if a mismatch is detected between requested and received mimetype, according to the list specified in the system properties file under blockedMismatchingMimeTypes. You can override by adding mimetypes to the override list 'mismatching_mime_types_override_list'.
- bypass
Head BooleanRequests - Before caching an artifact, Artifactory first sends a HEAD request to the remote resource. In some remote resources, HEAD requests are disallowed and therefore rejected, even though downloading the artifact is allowed. When checked, Artifactory will bypass the HEAD request and cache the artifact directly using a GET request.
- cdn
Redirect 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'
- client
Tls StringCertificate - Client TLS certificate name.
- content
Synchronisation Property Map - curated Boolean
- Enable repository to be protected by the Curation service.
- description String
- Public description.
- disable
Proxy Boolean - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. Introduced since Artifactory 7.41.7. - disable
Url BooleanNormalization - Whether to disable URL normalization, default is
false
. - download
Direct 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. Default value is 'false'.
- Boolean
- Enables cookie management if the remote repository uses cookies to manage client state.
- excludes
Pattern String - List of artifact patterns to exclude when evaluating artifact requests, in the form of
x/y/**/z/*
.By default no artifacts are excluded. - fetch
Jars BooleanEagerly - When set, if a POM is requested, Artifactory attempts to fetch the corresponding jar in the background. This will accelerate first access time to the jar when it is subsequently requested.
- fetch
Sources BooleanEagerly - When set, if a binaries jar is requested, Artifactory attempts to fetch the corresponding source jar in the background. This will accelerate first access time to the source jar when it is subsequently requested.
- handle
Releases Boolean - If set, Artifactory allows you to deploy release artifacts into this repository.
- handle
Snapshots Boolean - If set, Artifactory allows you to deploy snapshot artifacts into this repository.
- hard
Fail Boolean - When set, Artifactory will return an error to the client that causes the build to fail if there is a failure to communicate with this repository.
- includes
Pattern 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 (**/*
). - list
Remote BooleanFolder Items - Lists the items of remote folders in simple and list browsing. The remote content is cached according to the value of the 'Retrieval Cache Period'. Default value is 'false'. This field exists in the API but not in the UI.
- local
Address String - The local address to be used when creating connections. Useful for specifying the interface to use on systems with multiple network interfaces.
- max
Unique NumberSnapshots - The maximum number of unique snapshots of a single artifact to store. Once the number of snapshots exceeds this setting, older versions are removed. A value of 0 (default) indicates there is no limit, and unique snapshots are not cleaned up.
- metadata
Retrieval NumberTimeout Secs - Metadata Retrieval Cache Timeout (Sec) in the UI.This value refers to the number of seconds to wait for retrieval from the remote before serving locally cached artifact or fail the request.
- mismatching
Mime StringTypes Override List - The set of mime types that should override the block_mismatching_mime_types setting. Eg: 'application/json,application/xml'. Default value is empty.
- missed
Cache NumberPeriod Seconds - Missed Retrieval Cache Period (Sec) in the UI. The number of seconds to cache artifact retrieval misses (artifact not found). A value of 0 indicates no caching.
- notes String
- Internal description.
- offline Boolean
- If set, Artifactory does not try to fetch remote artifacts. Only locally-cached artifacts are retrieved.
- password String
- priority
Resolution Boolean - Setting Priority Resolution takes precedence over the resolution order when resolving virtual repositories. Setting repositories with priority will cause metadata to be merged only from repositories set with a priority. If a package is not found in those repositories, Artifactory will merge from repositories marked as non-priority.
- project
Environments List<String> - project
Key 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.
- property
Sets List<String> - List of property set names
- proxy String
- Proxy key from Artifactory Proxies settings. Can't be set if
disable_proxy = true
. - query
Params String - Custom HTTP query parameters that will be automatically included in all remote resource requests. For example:
param1=val1¶m2=val2¶m3=val3
- reject
Invalid BooleanJars - Reject the caching of jar files that are found to be invalid. For example, pseudo jars retrieved behind a "captive portal".
- remote
Repo StringChecksum Policy Type - Checking the Checksum effectively verifies the integrity of a deployed resource. The Checksum Policy determines how the system behaves when a client checksum for a remote resource is missing or conflicts with the locally calculated checksum. Available policies are
generate-if-absent
,fail
,ignore-and-generate
, andpass-thru
. - remote
Repo StringLayout Ref - Repository layout key for the remote layout mapping. Repository can be created without this attribute (or set to an empty string). Once it's set, it can't be removed by passing an empty string or removing the attribute, that will be ignored by the Artifactory API. UI shows an error message, if the user tries to remove the value.
- repo
Layout StringRef - Repository layout key for the remote repository
- retrieval
Cache NumberPeriod Seconds - Metadata Retrieval Cache Period (Sec) in the UI. This value refers to the number of seconds to cache metadata files before checking for newer versions on remote server. A value of 0 indicates no caching.
- Boolean
- socket
Timeout NumberMillis - Network timeout (in ms) to use when establishing a connection and for unanswered requests. Timing out on a network operation is considered a retrieval failure.
- store
Artifacts BooleanLocally - When set, the repository should store cached artifacts locally. When not set, artifacts are not stored locally, and direct repository-to-client streaming is used. This can be useful for multi-server setups over a high-speed LAN, with one Artifactory caching certain data on central storage, and streaming it directly to satellite pass-though Artifactory servers.
- suppress
Pom BooleanConsistency Checks - By default, the system keeps your repositories healthy by refusing POMs with incorrect coordinates (path). If the groupId:artifactId:version information inside the POM does not match the deployed path, Artifactory rejects the deployment with a "409 Conflict" error. You can disable this behavior by setting this attribute to
true
. - synchronize
Properties Boolean - When set, remote artifacts are fetched along with their properties.
- unused
Artifacts NumberCleanup Period Hours - Unused Artifacts Cleanup Period (Hr) in the UI. The number of hours to wait before an artifact is deemed 'unused' and eligible for cleanup from the repository. A value of 0 means automatic cleanup of cached artifacts is disabled.
- url String
- The remote repo URL.
- username String
- xray
Index 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 RemoteMavenRepository resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Package
Type string
- Id string
- The provider-assigned unique ID for this managed resource.
- Package
Type string
- id String
- The provider-assigned unique ID for this managed resource.
- package
Type String
- id string
- The provider-assigned unique ID for this managed resource.
- package
Type 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.
- package
Type String
Look up Existing RemoteMavenRepository Resource
Get an existing RemoteMavenRepository 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?: RemoteMavenRepositoryState, opts?: CustomResourceOptions): RemoteMavenRepository
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allow_any_host_auth: Optional[bool] = None,
archive_browsing_enabled: Optional[bool] = None,
assumed_offline_period_secs: Optional[int] = None,
blacked_out: Optional[bool] = None,
block_mismatching_mime_types: Optional[bool] = None,
bypass_head_requests: Optional[bool] = None,
cdn_redirect: Optional[bool] = None,
client_tls_certificate: Optional[str] = None,
content_synchronisation: Optional[RemoteMavenRepositoryContentSynchronisationArgs] = None,
curated: Optional[bool] = None,
description: Optional[str] = None,
disable_proxy: Optional[bool] = None,
disable_url_normalization: Optional[bool] = None,
download_direct: Optional[bool] = None,
enable_cookie_management: Optional[bool] = None,
excludes_pattern: Optional[str] = None,
fetch_jars_eagerly: Optional[bool] = None,
fetch_sources_eagerly: Optional[bool] = None,
handle_releases: Optional[bool] = None,
handle_snapshots: Optional[bool] = None,
hard_fail: Optional[bool] = None,
includes_pattern: Optional[str] = None,
key: Optional[str] = None,
list_remote_folder_items: Optional[bool] = None,
local_address: Optional[str] = None,
max_unique_snapshots: Optional[int] = None,
metadata_retrieval_timeout_secs: Optional[int] = None,
mismatching_mime_types_override_list: Optional[str] = None,
missed_cache_period_seconds: Optional[int] = None,
notes: Optional[str] = None,
offline: Optional[bool] = None,
package_type: Optional[str] = None,
password: Optional[str] = None,
priority_resolution: Optional[bool] = None,
project_environments: Optional[Sequence[str]] = None,
project_key: Optional[str] = None,
property_sets: Optional[Sequence[str]] = None,
proxy: Optional[str] = None,
query_params: Optional[str] = None,
reject_invalid_jars: Optional[bool] = None,
remote_repo_checksum_policy_type: Optional[str] = None,
remote_repo_layout_ref: Optional[str] = None,
repo_layout_ref: Optional[str] = None,
retrieval_cache_period_seconds: Optional[int] = None,
share_configuration: Optional[bool] = None,
socket_timeout_millis: Optional[int] = None,
store_artifacts_locally: Optional[bool] = None,
suppress_pom_consistency_checks: Optional[bool] = None,
synchronize_properties: Optional[bool] = None,
unused_artifacts_cleanup_period_hours: Optional[int] = None,
url: Optional[str] = None,
username: Optional[str] = None,
xray_index: Optional[bool] = None) -> RemoteMavenRepository
func GetRemoteMavenRepository(ctx *Context, name string, id IDInput, state *RemoteMavenRepositoryState, opts ...ResourceOption) (*RemoteMavenRepository, error)
public static RemoteMavenRepository Get(string name, Input<string> id, RemoteMavenRepositoryState? state, CustomResourceOptions? opts = null)
public static RemoteMavenRepository get(String name, Output<String> id, RemoteMavenRepositoryState 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.
- Allow
Any boolHost Auth - 'Lenient Host Authentication' in the UI. Allow credentials of this repository to be used on requests redirected to any other host.
- Archive
Browsing boolEnabled - 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).
- Assumed
Offline intPeriod Secs - The number of seconds the repository stays in assumed offline state after a connection error. At the end of this time, an online check is attempted in order to reset the offline status. A value of 0 means the repository is never assumed offline.
- Blacked
Out bool - (A.K.A 'Ignore Repository' on the UI) When set, the repository or its local cache do not participate in artifact resolution.
- Block
Mismatching boolMime Types - If set, artifacts will fail to download if a mismatch is detected between requested and received mimetype, according to the list specified in the system properties file under blockedMismatchingMimeTypes. You can override by adding mimetypes to the override list 'mismatching_mime_types_override_list'.
- Bypass
Head boolRequests - Before caching an artifact, Artifactory first sends a HEAD request to the remote resource. In some remote resources, HEAD requests are disallowed and therefore rejected, even though downloading the artifact is allowed. When checked, Artifactory will bypass the HEAD request and cache the artifact directly using a GET request.
- 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'
- Client
Tls stringCertificate - Client TLS certificate name.
- Content
Synchronisation RemoteMaven Repository Content Synchronisation - Curated bool
- Enable repository to be protected by the Curation service.
- Description string
- Public description.
- Disable
Proxy bool - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. Introduced since Artifactory 7.41.7. - Disable
Url boolNormalization - Whether to disable URL normalization, default is
false
. - 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. Default value is 'false'.
- bool
- Enables cookie management if the remote repository uses cookies to manage client state.
- Excludes
Pattern string - List of artifact patterns to exclude when evaluating artifact requests, in the form of
x/y/**/z/*
.By default no artifacts are excluded. - Fetch
Jars boolEagerly - When set, if a POM is requested, Artifactory attempts to fetch the corresponding jar in the background. This will accelerate first access time to the jar when it is subsequently requested.
- Fetch
Sources boolEagerly - When set, if a binaries jar is requested, Artifactory attempts to fetch the corresponding source jar in the background. This will accelerate first access time to the source jar when it is subsequently requested.
- Handle
Releases bool - If set, Artifactory allows you to deploy release artifacts into this repository.
- Handle
Snapshots bool - If set, Artifactory allows you to deploy snapshot artifacts into this repository.
- Hard
Fail bool - When set, Artifactory will return an error to the client that causes the build to fail if there is a failure to communicate with this repository.
- Includes
Pattern 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.
- List
Remote boolFolder Items - Lists the items of remote folders in simple and list browsing. The remote content is cached according to the value of the 'Retrieval Cache Period'. Default value is 'false'. This field exists in the API but not in the UI.
- Local
Address string - The local address to be used when creating connections. Useful for specifying the interface to use on systems with multiple network interfaces.
- Max
Unique intSnapshots - The maximum number of unique snapshots of a single artifact to store. Once the number of snapshots exceeds this setting, older versions are removed. A value of 0 (default) indicates there is no limit, and unique snapshots are not cleaned up.
- Metadata
Retrieval intTimeout Secs - Metadata Retrieval Cache Timeout (Sec) in the UI.This value refers to the number of seconds to wait for retrieval from the remote before serving locally cached artifact or fail the request.
- Mismatching
Mime stringTypes Override List - The set of mime types that should override the block_mismatching_mime_types setting. Eg: 'application/json,application/xml'. Default value is empty.
- Missed
Cache intPeriod Seconds - Missed Retrieval Cache Period (Sec) in the UI. The number of seconds to cache artifact retrieval misses (artifact not found). A value of 0 indicates no caching.
- Notes string
- Internal description.
- Offline bool
- If set, Artifactory does not try to fetch remote artifacts. Only locally-cached artifacts are retrieved.
- Package
Type string - Password string
- Priority
Resolution bool - Setting Priority Resolution takes precedence over the resolution order when resolving virtual repositories. Setting repositories with priority will cause metadata to be merged only from repositories set with a priority. If a package is not found in those repositories, Artifactory will merge from repositories marked as non-priority.
- Project
Environments List<string> - Project
Key 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.
- Property
Sets List<string> - List of property set names
- Proxy string
- Proxy key from Artifactory Proxies settings. Can't be set if
disable_proxy = true
. - Query
Params string - Custom HTTP query parameters that will be automatically included in all remote resource requests. For example:
param1=val1¶m2=val2¶m3=val3
- Reject
Invalid boolJars - Reject the caching of jar files that are found to be invalid. For example, pseudo jars retrieved behind a "captive portal".
- Remote
Repo stringChecksum Policy Type - Checking the Checksum effectively verifies the integrity of a deployed resource. The Checksum Policy determines how the system behaves when a client checksum for a remote resource is missing or conflicts with the locally calculated checksum. Available policies are
generate-if-absent
,fail
,ignore-and-generate
, andpass-thru
. - Remote
Repo stringLayout Ref - Repository layout key for the remote layout mapping. Repository can be created without this attribute (or set to an empty string). Once it's set, it can't be removed by passing an empty string or removing the attribute, that will be ignored by the Artifactory API. UI shows an error message, if the user tries to remove the value.
- Repo
Layout stringRef - Repository layout key for the remote repository
- Retrieval
Cache intPeriod Seconds - Metadata Retrieval Cache Period (Sec) in the UI. This value refers to the number of seconds to cache metadata files before checking for newer versions on remote server. A value of 0 indicates no caching.
- bool
- Socket
Timeout intMillis - Network timeout (in ms) to use when establishing a connection and for unanswered requests. Timing out on a network operation is considered a retrieval failure.
- Store
Artifacts boolLocally - When set, the repository should store cached artifacts locally. When not set, artifacts are not stored locally, and direct repository-to-client streaming is used. This can be useful for multi-server setups over a high-speed LAN, with one Artifactory caching certain data on central storage, and streaming it directly to satellite pass-though Artifactory servers.
- Suppress
Pom boolConsistency Checks - By default, the system keeps your repositories healthy by refusing POMs with incorrect coordinates (path). If the groupId:artifactId:version information inside the POM does not match the deployed path, Artifactory rejects the deployment with a "409 Conflict" error. You can disable this behavior by setting this attribute to
true
. - Synchronize
Properties bool - When set, remote artifacts are fetched along with their properties.
- Unused
Artifacts intCleanup Period Hours - Unused Artifacts Cleanup Period (Hr) in the UI. The number of hours to wait before an artifact is deemed 'unused' and eligible for cleanup from the repository. A value of 0 means automatic cleanup of cached artifacts is disabled.
- Url string
- The remote repo URL.
- Username string
- 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.
- Allow
Any boolHost Auth - 'Lenient Host Authentication' in the UI. Allow credentials of this repository to be used on requests redirected to any other host.
- Archive
Browsing boolEnabled - 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).
- Assumed
Offline intPeriod Secs - The number of seconds the repository stays in assumed offline state after a connection error. At the end of this time, an online check is attempted in order to reset the offline status. A value of 0 means the repository is never assumed offline.
- Blacked
Out bool - (A.K.A 'Ignore Repository' on the UI) When set, the repository or its local cache do not participate in artifact resolution.
- Block
Mismatching boolMime Types - If set, artifacts will fail to download if a mismatch is detected between requested and received mimetype, according to the list specified in the system properties file under blockedMismatchingMimeTypes. You can override by adding mimetypes to the override list 'mismatching_mime_types_override_list'.
- Bypass
Head boolRequests - Before caching an artifact, Artifactory first sends a HEAD request to the remote resource. In some remote resources, HEAD requests are disallowed and therefore rejected, even though downloading the artifact is allowed. When checked, Artifactory will bypass the HEAD request and cache the artifact directly using a GET request.
- 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'
- Client
Tls stringCertificate - Client TLS certificate name.
- Content
Synchronisation RemoteMaven Repository Content Synchronisation Args - Curated bool
- Enable repository to be protected by the Curation service.
- Description string
- Public description.
- Disable
Proxy bool - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. Introduced since Artifactory 7.41.7. - Disable
Url boolNormalization - Whether to disable URL normalization, default is
false
. - 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. Default value is 'false'.
- bool
- Enables cookie management if the remote repository uses cookies to manage client state.
- Excludes
Pattern string - List of artifact patterns to exclude when evaluating artifact requests, in the form of
x/y/**/z/*
.By default no artifacts are excluded. - Fetch
Jars boolEagerly - When set, if a POM is requested, Artifactory attempts to fetch the corresponding jar in the background. This will accelerate first access time to the jar when it is subsequently requested.
- Fetch
Sources boolEagerly - When set, if a binaries jar is requested, Artifactory attempts to fetch the corresponding source jar in the background. This will accelerate first access time to the source jar when it is subsequently requested.
- Handle
Releases bool - If set, Artifactory allows you to deploy release artifacts into this repository.
- Handle
Snapshots bool - If set, Artifactory allows you to deploy snapshot artifacts into this repository.
- Hard
Fail bool - When set, Artifactory will return an error to the client that causes the build to fail if there is a failure to communicate with this repository.
- Includes
Pattern 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.
- List
Remote boolFolder Items - Lists the items of remote folders in simple and list browsing. The remote content is cached according to the value of the 'Retrieval Cache Period'. Default value is 'false'. This field exists in the API but not in the UI.
- Local
Address string - The local address to be used when creating connections. Useful for specifying the interface to use on systems with multiple network interfaces.
- Max
Unique intSnapshots - The maximum number of unique snapshots of a single artifact to store. Once the number of snapshots exceeds this setting, older versions are removed. A value of 0 (default) indicates there is no limit, and unique snapshots are not cleaned up.
- Metadata
Retrieval intTimeout Secs - Metadata Retrieval Cache Timeout (Sec) in the UI.This value refers to the number of seconds to wait for retrieval from the remote before serving locally cached artifact or fail the request.
- Mismatching
Mime stringTypes Override List - The set of mime types that should override the block_mismatching_mime_types setting. Eg: 'application/json,application/xml'. Default value is empty.
- Missed
Cache intPeriod Seconds - Missed Retrieval Cache Period (Sec) in the UI. The number of seconds to cache artifact retrieval misses (artifact not found). A value of 0 indicates no caching.
- Notes string
- Internal description.
- Offline bool
- If set, Artifactory does not try to fetch remote artifacts. Only locally-cached artifacts are retrieved.
- Package
Type string - Password string
- Priority
Resolution bool - Setting Priority Resolution takes precedence over the resolution order when resolving virtual repositories. Setting repositories with priority will cause metadata to be merged only from repositories set with a priority. If a package is not found in those repositories, Artifactory will merge from repositories marked as non-priority.
- Project
Environments []string - Project
Key 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.
- Property
Sets []string - List of property set names
- Proxy string
- Proxy key from Artifactory Proxies settings. Can't be set if
disable_proxy = true
. - Query
Params string - Custom HTTP query parameters that will be automatically included in all remote resource requests. For example:
param1=val1¶m2=val2¶m3=val3
- Reject
Invalid boolJars - Reject the caching of jar files that are found to be invalid. For example, pseudo jars retrieved behind a "captive portal".
- Remote
Repo stringChecksum Policy Type - Checking the Checksum effectively verifies the integrity of a deployed resource. The Checksum Policy determines how the system behaves when a client checksum for a remote resource is missing or conflicts with the locally calculated checksum. Available policies are
generate-if-absent
,fail
,ignore-and-generate
, andpass-thru
. - Remote
Repo stringLayout Ref - Repository layout key for the remote layout mapping. Repository can be created without this attribute (or set to an empty string). Once it's set, it can't be removed by passing an empty string or removing the attribute, that will be ignored by the Artifactory API. UI shows an error message, if the user tries to remove the value.
- Repo
Layout stringRef - Repository layout key for the remote repository
- Retrieval
Cache intPeriod Seconds - Metadata Retrieval Cache Period (Sec) in the UI. This value refers to the number of seconds to cache metadata files before checking for newer versions on remote server. A value of 0 indicates no caching.
- bool
- Socket
Timeout intMillis - Network timeout (in ms) to use when establishing a connection and for unanswered requests. Timing out on a network operation is considered a retrieval failure.
- Store
Artifacts boolLocally - When set, the repository should store cached artifacts locally. When not set, artifacts are not stored locally, and direct repository-to-client streaming is used. This can be useful for multi-server setups over a high-speed LAN, with one Artifactory caching certain data on central storage, and streaming it directly to satellite pass-though Artifactory servers.
- Suppress
Pom boolConsistency Checks - By default, the system keeps your repositories healthy by refusing POMs with incorrect coordinates (path). If the groupId:artifactId:version information inside the POM does not match the deployed path, Artifactory rejects the deployment with a "409 Conflict" error. You can disable this behavior by setting this attribute to
true
. - Synchronize
Properties bool - When set, remote artifacts are fetched along with their properties.
- Unused
Artifacts intCleanup Period Hours - Unused Artifacts Cleanup Period (Hr) in the UI. The number of hours to wait before an artifact is deemed 'unused' and eligible for cleanup from the repository. A value of 0 means automatic cleanup of cached artifacts is disabled.
- Url string
- The remote repo URL.
- Username string
- 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.
- allow
Any BooleanHost Auth - 'Lenient Host Authentication' in the UI. Allow credentials of this repository to be used on requests redirected to any other host.
- archive
Browsing BooleanEnabled - 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).
- assumed
Offline IntegerPeriod Secs - The number of seconds the repository stays in assumed offline state after a connection error. At the end of this time, an online check is attempted in order to reset the offline status. A value of 0 means the repository is never assumed offline.
- blacked
Out Boolean - (A.K.A 'Ignore Repository' on the UI) When set, the repository or its local cache do not participate in artifact resolution.
- block
Mismatching BooleanMime Types - If set, artifacts will fail to download if a mismatch is detected between requested and received mimetype, according to the list specified in the system properties file under blockedMismatchingMimeTypes. You can override by adding mimetypes to the override list 'mismatching_mime_types_override_list'.
- bypass
Head BooleanRequests - Before caching an artifact, Artifactory first sends a HEAD request to the remote resource. In some remote resources, HEAD requests are disallowed and therefore rejected, even though downloading the artifact is allowed. When checked, Artifactory will bypass the HEAD request and cache the artifact directly using a GET request.
- cdn
Redirect 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'
- client
Tls StringCertificate - Client TLS certificate name.
- content
Synchronisation RemoteMaven Repository Content Synchronisation - curated Boolean
- Enable repository to be protected by the Curation service.
- description String
- Public description.
- disable
Proxy Boolean - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. Introduced since Artifactory 7.41.7. - disable
Url BooleanNormalization - Whether to disable URL normalization, default is
false
. - download
Direct 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. Default value is 'false'.
- Boolean
- Enables cookie management if the remote repository uses cookies to manage client state.
- excludes
Pattern String - List of artifact patterns to exclude when evaluating artifact requests, in the form of
x/y/**/z/*
.By default no artifacts are excluded. - fetch
Jars BooleanEagerly - When set, if a POM is requested, Artifactory attempts to fetch the corresponding jar in the background. This will accelerate first access time to the jar when it is subsequently requested.
- fetch
Sources BooleanEagerly - When set, if a binaries jar is requested, Artifactory attempts to fetch the corresponding source jar in the background. This will accelerate first access time to the source jar when it is subsequently requested.
- handle
Releases Boolean - If set, Artifactory allows you to deploy release artifacts into this repository.
- handle
Snapshots Boolean - If set, Artifactory allows you to deploy snapshot artifacts into this repository.
- hard
Fail Boolean - When set, Artifactory will return an error to the client that causes the build to fail if there is a failure to communicate with this repository.
- includes
Pattern 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.
- list
Remote BooleanFolder Items - Lists the items of remote folders in simple and list browsing. The remote content is cached according to the value of the 'Retrieval Cache Period'. Default value is 'false'. This field exists in the API but not in the UI.
- local
Address String - The local address to be used when creating connections. Useful for specifying the interface to use on systems with multiple network interfaces.
- max
Unique IntegerSnapshots - The maximum number of unique snapshots of a single artifact to store. Once the number of snapshots exceeds this setting, older versions are removed. A value of 0 (default) indicates there is no limit, and unique snapshots are not cleaned up.
- metadata
Retrieval IntegerTimeout Secs - Metadata Retrieval Cache Timeout (Sec) in the UI.This value refers to the number of seconds to wait for retrieval from the remote before serving locally cached artifact or fail the request.
- mismatching
Mime StringTypes Override List - The set of mime types that should override the block_mismatching_mime_types setting. Eg: 'application/json,application/xml'. Default value is empty.
- missed
Cache IntegerPeriod Seconds - Missed Retrieval Cache Period (Sec) in the UI. The number of seconds to cache artifact retrieval misses (artifact not found). A value of 0 indicates no caching.
- notes String
- Internal description.
- offline Boolean
- If set, Artifactory does not try to fetch remote artifacts. Only locally-cached artifacts are retrieved.
- package
Type String - password String
- priority
Resolution Boolean - Setting Priority Resolution takes precedence over the resolution order when resolving virtual repositories. Setting repositories with priority will cause metadata to be merged only from repositories set with a priority. If a package is not found in those repositories, Artifactory will merge from repositories marked as non-priority.
- project
Environments List<String> - project
Key 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.
- property
Sets List<String> - List of property set names
- proxy String
- Proxy key from Artifactory Proxies settings. Can't be set if
disable_proxy = true
. - query
Params String - Custom HTTP query parameters that will be automatically included in all remote resource requests. For example:
param1=val1¶m2=val2¶m3=val3
- reject
Invalid BooleanJars - Reject the caching of jar files that are found to be invalid. For example, pseudo jars retrieved behind a "captive portal".
- remote
Repo StringChecksum Policy Type - Checking the Checksum effectively verifies the integrity of a deployed resource. The Checksum Policy determines how the system behaves when a client checksum for a remote resource is missing or conflicts with the locally calculated checksum. Available policies are
generate-if-absent
,fail
,ignore-and-generate
, andpass-thru
. - remote
Repo StringLayout Ref - Repository layout key for the remote layout mapping. Repository can be created without this attribute (or set to an empty string). Once it's set, it can't be removed by passing an empty string or removing the attribute, that will be ignored by the Artifactory API. UI shows an error message, if the user tries to remove the value.
- repo
Layout StringRef - Repository layout key for the remote repository
- retrieval
Cache IntegerPeriod Seconds - Metadata Retrieval Cache Period (Sec) in the UI. This value refers to the number of seconds to cache metadata files before checking for newer versions on remote server. A value of 0 indicates no caching.
- Boolean
- socket
Timeout IntegerMillis - Network timeout (in ms) to use when establishing a connection and for unanswered requests. Timing out on a network operation is considered a retrieval failure.
- store
Artifacts BooleanLocally - When set, the repository should store cached artifacts locally. When not set, artifacts are not stored locally, and direct repository-to-client streaming is used. This can be useful for multi-server setups over a high-speed LAN, with one Artifactory caching certain data on central storage, and streaming it directly to satellite pass-though Artifactory servers.
- suppress
Pom BooleanConsistency Checks - By default, the system keeps your repositories healthy by refusing POMs with incorrect coordinates (path). If the groupId:artifactId:version information inside the POM does not match the deployed path, Artifactory rejects the deployment with a "409 Conflict" error. You can disable this behavior by setting this attribute to
true
. - synchronize
Properties Boolean - When set, remote artifacts are fetched along with their properties.
- unused
Artifacts IntegerCleanup Period Hours - Unused Artifacts Cleanup Period (Hr) in the UI. The number of hours to wait before an artifact is deemed 'unused' and eligible for cleanup from the repository. A value of 0 means automatic cleanup of cached artifacts is disabled.
- url String
- The remote repo URL.
- username String
- xray
Index Boolean - Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
- allow
Any booleanHost Auth - 'Lenient Host Authentication' in the UI. Allow credentials of this repository to be used on requests redirected to any other host.
- archive
Browsing booleanEnabled - 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).
- assumed
Offline numberPeriod Secs - The number of seconds the repository stays in assumed offline state after a connection error. At the end of this time, an online check is attempted in order to reset the offline status. A value of 0 means the repository is never assumed offline.
- blacked
Out boolean - (A.K.A 'Ignore Repository' on the UI) When set, the repository or its local cache do not participate in artifact resolution.
- block
Mismatching booleanMime Types - If set, artifacts will fail to download if a mismatch is detected between requested and received mimetype, according to the list specified in the system properties file under blockedMismatchingMimeTypes. You can override by adding mimetypes to the override list 'mismatching_mime_types_override_list'.
- bypass
Head booleanRequests - Before caching an artifact, Artifactory first sends a HEAD request to the remote resource. In some remote resources, HEAD requests are disallowed and therefore rejected, even though downloading the artifact is allowed. When checked, Artifactory will bypass the HEAD request and cache the artifact directly using a GET request.
- cdn
Redirect 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'
- client
Tls stringCertificate - Client TLS certificate name.
- content
Synchronisation RemoteMaven Repository Content Synchronisation - curated boolean
- Enable repository to be protected by the Curation service.
- description string
- Public description.
- disable
Proxy boolean - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. Introduced since Artifactory 7.41.7. - disable
Url booleanNormalization - Whether to disable URL normalization, default is
false
. - download
Direct 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. Default value is 'false'.
- boolean
- Enables cookie management if the remote repository uses cookies to manage client state.
- excludes
Pattern string - List of artifact patterns to exclude when evaluating artifact requests, in the form of
x/y/**/z/*
.By default no artifacts are excluded. - fetch
Jars booleanEagerly - When set, if a POM is requested, Artifactory attempts to fetch the corresponding jar in the background. This will accelerate first access time to the jar when it is subsequently requested.
- fetch
Sources booleanEagerly - When set, if a binaries jar is requested, Artifactory attempts to fetch the corresponding source jar in the background. This will accelerate first access time to the source jar when it is subsequently requested.
- handle
Releases boolean - If set, Artifactory allows you to deploy release artifacts into this repository.
- handle
Snapshots boolean - If set, Artifactory allows you to deploy snapshot artifacts into this repository.
- hard
Fail boolean - When set, Artifactory will return an error to the client that causes the build to fail if there is a failure to communicate with this repository.
- includes
Pattern 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.
- list
Remote booleanFolder Items - Lists the items of remote folders in simple and list browsing. The remote content is cached according to the value of the 'Retrieval Cache Period'. Default value is 'false'. This field exists in the API but not in the UI.
- local
Address string - The local address to be used when creating connections. Useful for specifying the interface to use on systems with multiple network interfaces.
- max
Unique numberSnapshots - The maximum number of unique snapshots of a single artifact to store. Once the number of snapshots exceeds this setting, older versions are removed. A value of 0 (default) indicates there is no limit, and unique snapshots are not cleaned up.
- metadata
Retrieval numberTimeout Secs - Metadata Retrieval Cache Timeout (Sec) in the UI.This value refers to the number of seconds to wait for retrieval from the remote before serving locally cached artifact or fail the request.
- mismatching
Mime stringTypes Override List - The set of mime types that should override the block_mismatching_mime_types setting. Eg: 'application/json,application/xml'. Default value is empty.
- missed
Cache numberPeriod Seconds - Missed Retrieval Cache Period (Sec) in the UI. The number of seconds to cache artifact retrieval misses (artifact not found). A value of 0 indicates no caching.
- notes string
- Internal description.
- offline boolean
- If set, Artifactory does not try to fetch remote artifacts. Only locally-cached artifacts are retrieved.
- package
Type string - password string
- priority
Resolution boolean - Setting Priority Resolution takes precedence over the resolution order when resolving virtual repositories. Setting repositories with priority will cause metadata to be merged only from repositories set with a priority. If a package is not found in those repositories, Artifactory will merge from repositories marked as non-priority.
- project
Environments string[] - project
Key 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.
- property
Sets string[] - List of property set names
- proxy string
- Proxy key from Artifactory Proxies settings. Can't be set if
disable_proxy = true
. - query
Params string - Custom HTTP query parameters that will be automatically included in all remote resource requests. For example:
param1=val1¶m2=val2¶m3=val3
- reject
Invalid booleanJars - Reject the caching of jar files that are found to be invalid. For example, pseudo jars retrieved behind a "captive portal".
- remote
Repo stringChecksum Policy Type - Checking the Checksum effectively verifies the integrity of a deployed resource. The Checksum Policy determines how the system behaves when a client checksum for a remote resource is missing or conflicts with the locally calculated checksum. Available policies are
generate-if-absent
,fail
,ignore-and-generate
, andpass-thru
. - remote
Repo stringLayout Ref - Repository layout key for the remote layout mapping. Repository can be created without this attribute (or set to an empty string). Once it's set, it can't be removed by passing an empty string or removing the attribute, that will be ignored by the Artifactory API. UI shows an error message, if the user tries to remove the value.
- repo
Layout stringRef - Repository layout key for the remote repository
- retrieval
Cache numberPeriod Seconds - Metadata Retrieval Cache Period (Sec) in the UI. This value refers to the number of seconds to cache metadata files before checking for newer versions on remote server. A value of 0 indicates no caching.
- boolean
- socket
Timeout numberMillis - Network timeout (in ms) to use when establishing a connection and for unanswered requests. Timing out on a network operation is considered a retrieval failure.
- store
Artifacts booleanLocally - When set, the repository should store cached artifacts locally. When not set, artifacts are not stored locally, and direct repository-to-client streaming is used. This can be useful for multi-server setups over a high-speed LAN, with one Artifactory caching certain data on central storage, and streaming it directly to satellite pass-though Artifactory servers.
- suppress
Pom booleanConsistency Checks - By default, the system keeps your repositories healthy by refusing POMs with incorrect coordinates (path). If the groupId:artifactId:version information inside the POM does not match the deployed path, Artifactory rejects the deployment with a "409 Conflict" error. You can disable this behavior by setting this attribute to
true
. - synchronize
Properties boolean - When set, remote artifacts are fetched along with their properties.
- unused
Artifacts numberCleanup Period Hours - Unused Artifacts Cleanup Period (Hr) in the UI. The number of hours to wait before an artifact is deemed 'unused' and eligible for cleanup from the repository. A value of 0 means automatic cleanup of cached artifacts is disabled.
- url string
- The remote repo URL.
- username string
- xray
Index boolean - Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
- allow_
any_ boolhost_ auth - 'Lenient Host Authentication' in the UI. Allow credentials of this repository to be used on requests redirected to any other host.
- archive_
browsing_ boolenabled - 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).
- assumed_
offline_ intperiod_ secs - The number of seconds the repository stays in assumed offline state after a connection error. At the end of this time, an online check is attempted in order to reset the offline status. A value of 0 means the repository is never assumed offline.
- blacked_
out bool - (A.K.A 'Ignore Repository' on the UI) When set, the repository or its local cache do not participate in artifact resolution.
- block_
mismatching_ boolmime_ types - If set, artifacts will fail to download if a mismatch is detected between requested and received mimetype, according to the list specified in the system properties file under blockedMismatchingMimeTypes. You can override by adding mimetypes to the override list 'mismatching_mime_types_override_list'.
- bypass_
head_ boolrequests - Before caching an artifact, Artifactory first sends a HEAD request to the remote resource. In some remote resources, HEAD requests are disallowed and therefore rejected, even though downloading the artifact is allowed. When checked, Artifactory will bypass the HEAD request and cache the artifact directly using a GET request.
- 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'
- client_
tls_ strcertificate - Client TLS certificate name.
- content_
synchronisation RemoteMaven Repository Content Synchronisation Args - curated bool
- Enable repository to be protected by the Curation service.
- description str
- Public description.
- disable_
proxy bool - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. Introduced since Artifactory 7.41.7. - disable_
url_ boolnormalization - Whether to disable URL normalization, default is
false
. - 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. Default value is 'false'.
- bool
- Enables cookie management if the remote repository uses cookies to manage client state.
- 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. - fetch_
jars_ booleagerly - When set, if a POM is requested, Artifactory attempts to fetch the corresponding jar in the background. This will accelerate first access time to the jar when it is subsequently requested.
- fetch_
sources_ booleagerly - When set, if a binaries jar is requested, Artifactory attempts to fetch the corresponding source jar in the background. This will accelerate first access time to the source jar when it is subsequently requested.
- handle_
releases bool - If set, Artifactory allows you to deploy release artifacts into this repository.
- handle_
snapshots bool - If set, Artifactory allows you to deploy snapshot artifacts into this repository.
- hard_
fail bool - When set, Artifactory will return an error to the client that causes the build to fail if there is a failure to communicate with this repository.
- 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.
- list_
remote_ boolfolder_ items - Lists the items of remote folders in simple and list browsing. The remote content is cached according to the value of the 'Retrieval Cache Period'. Default value is 'false'. This field exists in the API but not in the UI.
- local_
address str - The local address to be used when creating connections. Useful for specifying the interface to use on systems with multiple network interfaces.
- max_
unique_ intsnapshots - The maximum number of unique snapshots of a single artifact to store. Once the number of snapshots exceeds this setting, older versions are removed. A value of 0 (default) indicates there is no limit, and unique snapshots are not cleaned up.
- metadata_
retrieval_ inttimeout_ secs - Metadata Retrieval Cache Timeout (Sec) in the UI.This value refers to the number of seconds to wait for retrieval from the remote before serving locally cached artifact or fail the request.
- mismatching_
mime_ strtypes_ override_ list - The set of mime types that should override the block_mismatching_mime_types setting. Eg: 'application/json,application/xml'. Default value is empty.
- missed_
cache_ intperiod_ seconds - Missed Retrieval Cache Period (Sec) in the UI. The number of seconds to cache artifact retrieval misses (artifact not found). A value of 0 indicates no caching.
- notes str
- Internal description.
- offline bool
- If set, Artifactory does not try to fetch remote artifacts. Only locally-cached artifacts are retrieved.
- package_
type str - password str
- priority_
resolution bool - Setting Priority Resolution takes precedence over the resolution order when resolving virtual repositories. Setting repositories with priority will cause metadata to be merged only from repositories set with a priority. If a package is not found in those repositories, Artifactory will merge from repositories marked as non-priority.
- project_
environments Sequence[str] - 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 names
- proxy str
- Proxy key from Artifactory Proxies settings. Can't be set if
disable_proxy = true
. - query_
params str - Custom HTTP query parameters that will be automatically included in all remote resource requests. For example:
param1=val1¶m2=val2¶m3=val3
- reject_
invalid_ booljars - Reject the caching of jar files that are found to be invalid. For example, pseudo jars retrieved behind a "captive portal".
- remote_
repo_ strchecksum_ policy_ type - Checking the Checksum effectively verifies the integrity of a deployed resource. The Checksum Policy determines how the system behaves when a client checksum for a remote resource is missing or conflicts with the locally calculated checksum. Available policies are
generate-if-absent
,fail
,ignore-and-generate
, andpass-thru
. - remote_
repo_ strlayout_ ref - Repository layout key for the remote layout mapping. Repository can be created without this attribute (or set to an empty string). Once it's set, it can't be removed by passing an empty string or removing the attribute, that will be ignored by the Artifactory API. UI shows an error message, if the user tries to remove the value.
- repo_
layout_ strref - Repository layout key for the remote repository
- retrieval_
cache_ intperiod_ seconds - Metadata Retrieval Cache Period (Sec) in the UI. This value refers to the number of seconds to cache metadata files before checking for newer versions on remote server. A value of 0 indicates no caching.
- bool
- socket_
timeout_ intmillis - Network timeout (in ms) to use when establishing a connection and for unanswered requests. Timing out on a network operation is considered a retrieval failure.
- store_
artifacts_ boollocally - When set, the repository should store cached artifacts locally. When not set, artifacts are not stored locally, and direct repository-to-client streaming is used. This can be useful for multi-server setups over a high-speed LAN, with one Artifactory caching certain data on central storage, and streaming it directly to satellite pass-though Artifactory servers.
- suppress_
pom_ boolconsistency_ checks - By default, the system keeps your repositories healthy by refusing POMs with incorrect coordinates (path). If the groupId:artifactId:version information inside the POM does not match the deployed path, Artifactory rejects the deployment with a "409 Conflict" error. You can disable this behavior by setting this attribute to
true
. - synchronize_
properties bool - When set, remote artifacts are fetched along with their properties.
- unused_
artifacts_ intcleanup_ period_ hours - Unused Artifacts Cleanup Period (Hr) in the UI. The number of hours to wait before an artifact is deemed 'unused' and eligible for cleanup from the repository. A value of 0 means automatic cleanup of cached artifacts is disabled.
- url str
- The remote repo URL.
- username str
- 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.
- allow
Any BooleanHost Auth - 'Lenient Host Authentication' in the UI. Allow credentials of this repository to be used on requests redirected to any other host.
- archive
Browsing BooleanEnabled - 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).
- assumed
Offline NumberPeriod Secs - The number of seconds the repository stays in assumed offline state after a connection error. At the end of this time, an online check is attempted in order to reset the offline status. A value of 0 means the repository is never assumed offline.
- blacked
Out Boolean - (A.K.A 'Ignore Repository' on the UI) When set, the repository or its local cache do not participate in artifact resolution.
- block
Mismatching BooleanMime Types - If set, artifacts will fail to download if a mismatch is detected between requested and received mimetype, according to the list specified in the system properties file under blockedMismatchingMimeTypes. You can override by adding mimetypes to the override list 'mismatching_mime_types_override_list'.
- bypass
Head BooleanRequests - Before caching an artifact, Artifactory first sends a HEAD request to the remote resource. In some remote resources, HEAD requests are disallowed and therefore rejected, even though downloading the artifact is allowed. When checked, Artifactory will bypass the HEAD request and cache the artifact directly using a GET request.
- cdn
Redirect 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'
- client
Tls StringCertificate - Client TLS certificate name.
- content
Synchronisation Property Map - curated Boolean
- Enable repository to be protected by the Curation service.
- description String
- Public description.
- disable
Proxy Boolean - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. Introduced since Artifactory 7.41.7. - disable
Url BooleanNormalization - Whether to disable URL normalization, default is
false
. - download
Direct 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. Default value is 'false'.
- Boolean
- Enables cookie management if the remote repository uses cookies to manage client state.
- excludes
Pattern String - List of artifact patterns to exclude when evaluating artifact requests, in the form of
x/y/**/z/*
.By default no artifacts are excluded. - fetch
Jars BooleanEagerly - When set, if a POM is requested, Artifactory attempts to fetch the corresponding jar in the background. This will accelerate first access time to the jar when it is subsequently requested.
- fetch
Sources BooleanEagerly - When set, if a binaries jar is requested, Artifactory attempts to fetch the corresponding source jar in the background. This will accelerate first access time to the source jar when it is subsequently requested.
- handle
Releases Boolean - If set, Artifactory allows you to deploy release artifacts into this repository.
- handle
Snapshots Boolean - If set, Artifactory allows you to deploy snapshot artifacts into this repository.
- hard
Fail Boolean - When set, Artifactory will return an error to the client that causes the build to fail if there is a failure to communicate with this repository.
- includes
Pattern 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.
- list
Remote BooleanFolder Items - Lists the items of remote folders in simple and list browsing. The remote content is cached according to the value of the 'Retrieval Cache Period'. Default value is 'false'. This field exists in the API but not in the UI.
- local
Address String - The local address to be used when creating connections. Useful for specifying the interface to use on systems with multiple network interfaces.
- max
Unique NumberSnapshots - The maximum number of unique snapshots of a single artifact to store. Once the number of snapshots exceeds this setting, older versions are removed. A value of 0 (default) indicates there is no limit, and unique snapshots are not cleaned up.
- metadata
Retrieval NumberTimeout Secs - Metadata Retrieval Cache Timeout (Sec) in the UI.This value refers to the number of seconds to wait for retrieval from the remote before serving locally cached artifact or fail the request.
- mismatching
Mime StringTypes Override List - The set of mime types that should override the block_mismatching_mime_types setting. Eg: 'application/json,application/xml'. Default value is empty.
- missed
Cache NumberPeriod Seconds - Missed Retrieval Cache Period (Sec) in the UI. The number of seconds to cache artifact retrieval misses (artifact not found). A value of 0 indicates no caching.
- notes String
- Internal description.
- offline Boolean
- If set, Artifactory does not try to fetch remote artifacts. Only locally-cached artifacts are retrieved.
- package
Type String - password String
- priority
Resolution Boolean - Setting Priority Resolution takes precedence over the resolution order when resolving virtual repositories. Setting repositories with priority will cause metadata to be merged only from repositories set with a priority. If a package is not found in those repositories, Artifactory will merge from repositories marked as non-priority.
- project
Environments List<String> - project
Key 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.
- property
Sets List<String> - List of property set names
- proxy String
- Proxy key from Artifactory Proxies settings. Can't be set if
disable_proxy = true
. - query
Params String - Custom HTTP query parameters that will be automatically included in all remote resource requests. For example:
param1=val1¶m2=val2¶m3=val3
- reject
Invalid BooleanJars - Reject the caching of jar files that are found to be invalid. For example, pseudo jars retrieved behind a "captive portal".
- remote
Repo StringChecksum Policy Type - Checking the Checksum effectively verifies the integrity of a deployed resource. The Checksum Policy determines how the system behaves when a client checksum for a remote resource is missing or conflicts with the locally calculated checksum. Available policies are
generate-if-absent
,fail
,ignore-and-generate
, andpass-thru
. - remote
Repo StringLayout Ref - Repository layout key for the remote layout mapping. Repository can be created without this attribute (or set to an empty string). Once it's set, it can't be removed by passing an empty string or removing the attribute, that will be ignored by the Artifactory API. UI shows an error message, if the user tries to remove the value.
- repo
Layout StringRef - Repository layout key for the remote repository
- retrieval
Cache NumberPeriod Seconds - Metadata Retrieval Cache Period (Sec) in the UI. This value refers to the number of seconds to cache metadata files before checking for newer versions on remote server. A value of 0 indicates no caching.
- Boolean
- socket
Timeout NumberMillis - Network timeout (in ms) to use when establishing a connection and for unanswered requests. Timing out on a network operation is considered a retrieval failure.
- store
Artifacts BooleanLocally - When set, the repository should store cached artifacts locally. When not set, artifacts are not stored locally, and direct repository-to-client streaming is used. This can be useful for multi-server setups over a high-speed LAN, with one Artifactory caching certain data on central storage, and streaming it directly to satellite pass-though Artifactory servers.
- suppress
Pom BooleanConsistency Checks - By default, the system keeps your repositories healthy by refusing POMs with incorrect coordinates (path). If the groupId:artifactId:version information inside the POM does not match the deployed path, Artifactory rejects the deployment with a "409 Conflict" error. You can disable this behavior by setting this attribute to
true
. - synchronize
Properties Boolean - When set, remote artifacts are fetched along with their properties.
- unused
Artifacts NumberCleanup Period Hours - Unused Artifacts Cleanup Period (Hr) in the UI. The number of hours to wait before an artifact is deemed 'unused' and eligible for cleanup from the repository. A value of 0 means automatic cleanup of cached artifacts is disabled.
- url String
- The remote repo URL.
- username String
- xray
Index Boolean - Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
Supporting Types
RemoteMavenRepositoryContentSynchronisation, RemoteMavenRepositoryContentSynchronisationArgs
- Enabled bool
- If set, Remote repository proxies a local or remote repository from another instance of Artifactory. Default value is 'false'.
- Properties
Enabled bool - If set, properties for artifacts that have been cached in this repository will be updated if they are modified in the artifact hosted at the remote Artifactory instance. The trigger to synchronize the properties is download of the artifact from the remote repository cache of the local Artifactory instance. Default value is 'false'.
- Source
Origin boolAbsence Detection - If set, Artifactory displays an indication on cached items if they have been deleted from the corresponding repository in the remote Artifactory instance. Default value is 'false'
- Statistics
Enabled bool - If set, Artifactory will notify the remote instance whenever an artifact in the Smart Remote Repository is downloaded locally so that it can update its download counter. Note that if this option is not set, there may be a discrepancy between the number of artifacts reported to have been downloaded in the different Artifactory instances of the proxy chain. Default value is 'false'.
- Enabled bool
- If set, Remote repository proxies a local or remote repository from another instance of Artifactory. Default value is 'false'.
- Properties
Enabled bool - If set, properties for artifacts that have been cached in this repository will be updated if they are modified in the artifact hosted at the remote Artifactory instance. The trigger to synchronize the properties is download of the artifact from the remote repository cache of the local Artifactory instance. Default value is 'false'.
- Source
Origin boolAbsence Detection - If set, Artifactory displays an indication on cached items if they have been deleted from the corresponding repository in the remote Artifactory instance. Default value is 'false'
- Statistics
Enabled bool - If set, Artifactory will notify the remote instance whenever an artifact in the Smart Remote Repository is downloaded locally so that it can update its download counter. Note that if this option is not set, there may be a discrepancy between the number of artifacts reported to have been downloaded in the different Artifactory instances of the proxy chain. Default value is 'false'.
- enabled Boolean
- If set, Remote repository proxies a local or remote repository from another instance of Artifactory. Default value is 'false'.
- properties
Enabled Boolean - If set, properties for artifacts that have been cached in this repository will be updated if they are modified in the artifact hosted at the remote Artifactory instance. The trigger to synchronize the properties is download of the artifact from the remote repository cache of the local Artifactory instance. Default value is 'false'.
- source
Origin BooleanAbsence Detection - If set, Artifactory displays an indication on cached items if they have been deleted from the corresponding repository in the remote Artifactory instance. Default value is 'false'
- statistics
Enabled Boolean - If set, Artifactory will notify the remote instance whenever an artifact in the Smart Remote Repository is downloaded locally so that it can update its download counter. Note that if this option is not set, there may be a discrepancy between the number of artifacts reported to have been downloaded in the different Artifactory instances of the proxy chain. Default value is 'false'.
- enabled boolean
- If set, Remote repository proxies a local or remote repository from another instance of Artifactory. Default value is 'false'.
- properties
Enabled boolean - If set, properties for artifacts that have been cached in this repository will be updated if they are modified in the artifact hosted at the remote Artifactory instance. The trigger to synchronize the properties is download of the artifact from the remote repository cache of the local Artifactory instance. Default value is 'false'.
- source
Origin booleanAbsence Detection - If set, Artifactory displays an indication on cached items if they have been deleted from the corresponding repository in the remote Artifactory instance. Default value is 'false'
- statistics
Enabled boolean - If set, Artifactory will notify the remote instance whenever an artifact in the Smart Remote Repository is downloaded locally so that it can update its download counter. Note that if this option is not set, there may be a discrepancy between the number of artifacts reported to have been downloaded in the different Artifactory instances of the proxy chain. Default value is 'false'.
- enabled bool
- If set, Remote repository proxies a local or remote repository from another instance of Artifactory. Default value is 'false'.
- properties_
enabled bool - If set, properties for artifacts that have been cached in this repository will be updated if they are modified in the artifact hosted at the remote Artifactory instance. The trigger to synchronize the properties is download of the artifact from the remote repository cache of the local Artifactory instance. Default value is 'false'.
- source_
origin_ boolabsence_ detection - If set, Artifactory displays an indication on cached items if they have been deleted from the corresponding repository in the remote Artifactory instance. Default value is 'false'
- statistics_
enabled bool - If set, Artifactory will notify the remote instance whenever an artifact in the Smart Remote Repository is downloaded locally so that it can update its download counter. Note that if this option is not set, there may be a discrepancy between the number of artifacts reported to have been downloaded in the different Artifactory instances of the proxy chain. Default value is 'false'.
- enabled Boolean
- If set, Remote repository proxies a local or remote repository from another instance of Artifactory. Default value is 'false'.
- properties
Enabled Boolean - If set, properties for artifacts that have been cached in this repository will be updated if they are modified in the artifact hosted at the remote Artifactory instance. The trigger to synchronize the properties is download of the artifact from the remote repository cache of the local Artifactory instance. Default value is 'false'.
- source
Origin BooleanAbsence Detection - If set, Artifactory displays an indication on cached items if they have been deleted from the corresponding repository in the remote Artifactory instance. Default value is 'false'
- statistics
Enabled Boolean - If set, Artifactory will notify the remote instance whenever an artifact in the Smart Remote Repository is downloaded locally so that it can update its download counter. Note that if this option is not set, there may be a discrepancy between the number of artifacts reported to have been downloaded in the different Artifactory instances of the proxy chain. Default value is 'false'.
Import
Remote repositories can be imported using their name, e.g.
$ pulumi import artifactory:index/remoteMavenRepository:RemoteMavenRepository maven-remote maven-remote
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.