1. Packages
  2. Artifactory Provider
  3. API Docs
  4. LocalRepositorySingleReplication
artifactory v8.8.1 published on Wednesday, Apr 9, 2025 by Pulumi

artifactory.LocalRepositorySingleReplication

Explore with Pulumi AI

Provides a local repository replication resource, also referred to as Artifactory push replication. This can be used to create and manage Artifactory local repository replications using Push Replication API.

Push replication is used to synchronize Local Repositories, and is implemented by the Artifactory server on the near end invoking a synchronization of artifacts to the far end. See the Official Documentation.

This resource can create the replication of local repository to single repository on the remote server.

Example Usage

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

const config = new pulumi.Config();
// The base URL of the Artifactory deployment
const artifactoryUrl = config.require("artifactoryUrl");
// The username for the Artifactory
const artifactoryUsername = config.require("artifactoryUsername");
// The password for the Artifactory
const artifactoryPassword = config.require("artifactoryPassword");
// Create a replication between two artifactory local repositories
const providerTestSource = new artifactory.LocalMavenRepository("provider_test_source", {key: "provider_test_source"});
const providerTestDest = new artifactory.LocalMavenRepository("provider_test_dest", {key: "provider_test_dest"});
const foo_rep = new artifactory.LocalRepositorySingleReplication("foo-rep", {
    repoKey: providerTestSource.key,
    cronExp: "0 0 * * * ?",
    enableEventReplication: true,
    url: pulumi.interpolate`${artifactoryUrl}/artifactory/${providerTestDest.key}`,
    username: "$var.artifactory_username",
    password: "$var.artifactory_password",
    enabled: true,
    socketTimeoutMillis: 16000,
    syncDeletes: false,
    syncProperties: true,
    syncStatistics: true,
    includePathPrefixPattern: "/some-repo/",
    excludePathPrefixPattern: "/some-other-repo/",
    checkBinaryExistenceInFilestore: true,
});
Copy
import pulumi
import pulumi_artifactory as artifactory

config = pulumi.Config()
# The base URL of the Artifactory deployment
artifactory_url = config.require("artifactoryUrl")
# The username for the Artifactory
artifactory_username = config.require("artifactoryUsername")
# The password for the Artifactory
artifactory_password = config.require("artifactoryPassword")
# Create a replication between two artifactory local repositories
provider_test_source = artifactory.LocalMavenRepository("provider_test_source", key="provider_test_source")
provider_test_dest = artifactory.LocalMavenRepository("provider_test_dest", key="provider_test_dest")
foo_rep = artifactory.LocalRepositorySingleReplication("foo-rep",
    repo_key=provider_test_source.key,
    cron_exp="0 0 * * * ?",
    enable_event_replication=True,
    url=provider_test_dest.key.apply(lambda key: f"{artifactory_url}/artifactory/{key}"),
    username="$var.artifactory_username",
    password="$var.artifactory_password",
    enabled=True,
    socket_timeout_millis=16000,
    sync_deletes=False,
    sync_properties=True,
    sync_statistics=True,
    include_path_prefix_pattern="/some-repo/",
    exclude_path_prefix_pattern="/some-other-repo/",
    check_binary_existence_in_filestore=True)
Copy
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-artifactory/sdk/v8/go/artifactory"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		// The base URL of the Artifactory deployment
		artifactoryUrl := cfg.Require("artifactoryUrl")
		// The username for the Artifactory
		artifactoryUsername := cfg.Require("artifactoryUsername")
		// The password for the Artifactory
		artifactoryPassword := cfg.Require("artifactoryPassword")
		// Create a replication between two artifactory local repositories
		providerTestSource, err := artifactory.NewLocalMavenRepository(ctx, "provider_test_source", &artifactory.LocalMavenRepositoryArgs{
			Key: pulumi.String("provider_test_source"),
		})
		if err != nil {
			return err
		}
		providerTestDest, err := artifactory.NewLocalMavenRepository(ctx, "provider_test_dest", &artifactory.LocalMavenRepositoryArgs{
			Key: pulumi.String("provider_test_dest"),
		})
		if err != nil {
			return err
		}
		_, err = artifactory.NewLocalRepositorySingleReplication(ctx, "foo-rep", &artifactory.LocalRepositorySingleReplicationArgs{
			RepoKey:                providerTestSource.Key,
			CronExp:                pulumi.String("0 0 * * * ?"),
			EnableEventReplication: pulumi.Bool(true),
			Url: providerTestDest.Key.ApplyT(func(key string) (string, error) {
				return fmt.Sprintf("%v/artifactory/%v", artifactoryUrl, key), nil
			}).(pulumi.StringOutput),
			Username:                        pulumi.String("$var.artifactory_username"),
			Password:                        pulumi.String("$var.artifactory_password"),
			Enabled:                         pulumi.Bool(true),
			SocketTimeoutMillis:             pulumi.Int(16000),
			SyncDeletes:                     pulumi.Bool(false),
			SyncProperties:                  pulumi.Bool(true),
			SyncStatistics:                  pulumi.Bool(true),
			IncludePathPrefixPattern:        pulumi.String("/some-repo/"),
			ExcludePathPrefixPattern:        pulumi.String("/some-other-repo/"),
			CheckBinaryExistenceInFilestore: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Artifactory = Pulumi.Artifactory;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    // The base URL of the Artifactory deployment
    var artifactoryUrl = config.Require("artifactoryUrl");
    // The username for the Artifactory
    var artifactoryUsername = config.Require("artifactoryUsername");
    // The password for the Artifactory
    var artifactoryPassword = config.Require("artifactoryPassword");
    // Create a replication between two artifactory local repositories
    var providerTestSource = new Artifactory.LocalMavenRepository("provider_test_source", new()
    {
        Key = "provider_test_source",
    });

    var providerTestDest = new Artifactory.LocalMavenRepository("provider_test_dest", new()
    {
        Key = "provider_test_dest",
    });

    var foo_rep = new Artifactory.LocalRepositorySingleReplication("foo-rep", new()
    {
        RepoKey = providerTestSource.Key,
        CronExp = "0 0 * * * ?",
        EnableEventReplication = true,
        Url = providerTestDest.Key.Apply(key => $"{artifactoryUrl}/artifactory/{key}"),
        Username = "$var.artifactory_username",
        Password = "$var.artifactory_password",
        Enabled = true,
        SocketTimeoutMillis = 16000,
        SyncDeletes = false,
        SyncProperties = true,
        SyncStatistics = true,
        IncludePathPrefixPattern = "/some-repo/",
        ExcludePathPrefixPattern = "/some-other-repo/",
        CheckBinaryExistenceInFilestore = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.artifactory.LocalMavenRepository;
import com.pulumi.artifactory.LocalMavenRepositoryArgs;
import com.pulumi.artifactory.LocalRepositorySingleReplication;
import com.pulumi.artifactory.LocalRepositorySingleReplicationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var artifactoryUrl = config.get("artifactoryUrl");
        final var artifactoryUsername = config.get("artifactoryUsername");
        final var artifactoryPassword = config.get("artifactoryPassword");
        // Create a replication between two artifactory local repositories
        var providerTestSource = new LocalMavenRepository("providerTestSource", LocalMavenRepositoryArgs.builder()
            .key("provider_test_source")
            .build());

        var providerTestDest = new LocalMavenRepository("providerTestDest", LocalMavenRepositoryArgs.builder()
            .key("provider_test_dest")
            .build());

        var foo_rep = new LocalRepositorySingleReplication("foo-rep", LocalRepositorySingleReplicationArgs.builder()
            .repoKey(providerTestSource.key())
            .cronExp("0 0 * * * ?")
            .enableEventReplication(true)
            .url(providerTestDest.key().applyValue(key -> String.format("%s/artifactory/%s", artifactoryUrl,key)))
            .username("$var.artifactory_username")
            .password("$var.artifactory_password")
            .enabled(true)
            .socketTimeoutMillis(16000)
            .syncDeletes(false)
            .syncProperties(true)
            .syncStatistics(true)
            .includePathPrefixPattern("/some-repo/")
            .excludePathPrefixPattern("/some-other-repo/")
            .checkBinaryExistenceInFilestore(true)
            .build());

    }
}
Copy
configuration:
  artifactoryUrl:
    type: string
  artifactoryUsername:
    type: string
  artifactoryPassword:
    type: string
resources:
  # Create a replication between two artifactory local repositories
  providerTestSource:
    type: artifactory:LocalMavenRepository
    name: provider_test_source
    properties:
      key: provider_test_source
  providerTestDest:
    type: artifactory:LocalMavenRepository
    name: provider_test_dest
    properties:
      key: provider_test_dest
  foo-rep:
    type: artifactory:LocalRepositorySingleReplication
    properties:
      repoKey: ${providerTestSource.key}
      cronExp: 0 0 * * * ?
      enableEventReplication: true
      url: ${artifactoryUrl}/artifactory/${providerTestDest.key}
      username: $var.artifactory_username
      password: $var.artifactory_password
      enabled: true
      socketTimeoutMillis: 16000
      syncDeletes: false
      syncProperties: true
      syncStatistics: true
      includePathPrefixPattern: /some-repo/
      excludePathPrefixPattern: /some-other-repo/
      checkBinaryExistenceInFilestore: true
Copy

Create LocalRepositorySingleReplication Resource

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

Constructor syntax

new LocalRepositorySingleReplication(name: string, args: LocalRepositorySingleReplicationArgs, opts?: CustomResourceOptions);
@overload
def LocalRepositorySingleReplication(resource_name: str,
                                     args: LocalRepositorySingleReplicationArgs,
                                     opts: Optional[ResourceOptions] = None)

@overload
def LocalRepositorySingleReplication(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     repo_key: Optional[str] = None,
                                     cron_exp: Optional[str] = None,
                                     username: Optional[str] = None,
                                     url: Optional[str] = None,
                                     password: Optional[str] = None,
                                     include_path_prefix_pattern: Optional[str] = None,
                                     check_binary_existence_in_filestore: Optional[bool] = None,
                                     proxy: Optional[str] = None,
                                     exclude_path_prefix_pattern: Optional[str] = None,
                                     socket_timeout_millis: Optional[int] = None,
                                     sync_deletes: Optional[bool] = None,
                                     sync_properties: Optional[bool] = None,
                                     sync_statistics: Optional[bool] = None,
                                     enabled: Optional[bool] = None,
                                     enable_event_replication: Optional[bool] = None)
func NewLocalRepositorySingleReplication(ctx *Context, name string, args LocalRepositorySingleReplicationArgs, opts ...ResourceOption) (*LocalRepositorySingleReplication, error)
public LocalRepositorySingleReplication(string name, LocalRepositorySingleReplicationArgs args, CustomResourceOptions? opts = null)
public LocalRepositorySingleReplication(String name, LocalRepositorySingleReplicationArgs args)
public LocalRepositorySingleReplication(String name, LocalRepositorySingleReplicationArgs args, CustomResourceOptions options)
type: artifactory:LocalRepositorySingleReplication
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. LocalRepositorySingleReplicationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. LocalRepositorySingleReplicationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. LocalRepositorySingleReplicationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. LocalRepositorySingleReplicationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. LocalRepositorySingleReplicationArgs
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 localRepositorySingleReplicationResource = new Artifactory.LocalRepositorySingleReplication("localRepositorySingleReplicationResource", new()
{
    RepoKey = "string",
    CronExp = "string",
    Username = "string",
    Url = "string",
    Password = "string",
    IncludePathPrefixPattern = "string",
    CheckBinaryExistenceInFilestore = false,
    Proxy = "string",
    ExcludePathPrefixPattern = "string",
    SocketTimeoutMillis = 0,
    SyncDeletes = false,
    SyncProperties = false,
    SyncStatistics = false,
    Enabled = false,
    EnableEventReplication = false,
});
Copy
example, err := artifactory.NewLocalRepositorySingleReplication(ctx, "localRepositorySingleReplicationResource", &artifactory.LocalRepositorySingleReplicationArgs{
	RepoKey:                         pulumi.String("string"),
	CronExp:                         pulumi.String("string"),
	Username:                        pulumi.String("string"),
	Url:                             pulumi.String("string"),
	Password:                        pulumi.String("string"),
	IncludePathPrefixPattern:        pulumi.String("string"),
	CheckBinaryExistenceInFilestore: pulumi.Bool(false),
	Proxy:                           pulumi.String("string"),
	ExcludePathPrefixPattern:        pulumi.String("string"),
	SocketTimeoutMillis:             pulumi.Int(0),
	SyncDeletes:                     pulumi.Bool(false),
	SyncProperties:                  pulumi.Bool(false),
	SyncStatistics:                  pulumi.Bool(false),
	Enabled:                         pulumi.Bool(false),
	EnableEventReplication:          pulumi.Bool(false),
})
Copy
var localRepositorySingleReplicationResource = new LocalRepositorySingleReplication("localRepositorySingleReplicationResource", LocalRepositorySingleReplicationArgs.builder()
    .repoKey("string")
    .cronExp("string")
    .username("string")
    .url("string")
    .password("string")
    .includePathPrefixPattern("string")
    .checkBinaryExistenceInFilestore(false)
    .proxy("string")
    .excludePathPrefixPattern("string")
    .socketTimeoutMillis(0)
    .syncDeletes(false)
    .syncProperties(false)
    .syncStatistics(false)
    .enabled(false)
    .enableEventReplication(false)
    .build());
Copy
local_repository_single_replication_resource = artifactory.LocalRepositorySingleReplication("localRepositorySingleReplicationResource",
    repo_key="string",
    cron_exp="string",
    username="string",
    url="string",
    password="string",
    include_path_prefix_pattern="string",
    check_binary_existence_in_filestore=False,
    proxy="string",
    exclude_path_prefix_pattern="string",
    socket_timeout_millis=0,
    sync_deletes=False,
    sync_properties=False,
    sync_statistics=False,
    enabled=False,
    enable_event_replication=False)
Copy
const localRepositorySingleReplicationResource = new artifactory.LocalRepositorySingleReplication("localRepositorySingleReplicationResource", {
    repoKey: "string",
    cronExp: "string",
    username: "string",
    url: "string",
    password: "string",
    includePathPrefixPattern: "string",
    checkBinaryExistenceInFilestore: false,
    proxy: "string",
    excludePathPrefixPattern: "string",
    socketTimeoutMillis: 0,
    syncDeletes: false,
    syncProperties: false,
    syncStatistics: false,
    enabled: false,
    enableEventReplication: false,
});
Copy
type: artifactory:LocalRepositorySingleReplication
properties:
    checkBinaryExistenceInFilestore: false
    cronExp: string
    enableEventReplication: false
    enabled: false
    excludePathPrefixPattern: string
    includePathPrefixPattern: string
    password: string
    proxy: string
    repoKey: string
    socketTimeoutMillis: 0
    syncDeletes: false
    syncProperties: false
    syncStatistics: false
    url: string
    username: string
Copy

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

CronExp This property is required. string
A valid CRON expression that you can use to control replication frequency. Eg: 0 0 12 * * ? *, 0 0 2 ? * MON-SAT *. Note: use 6 or 7 parts format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year (optional). Specifying both a day-of-week AND a day-of-month parameter is not supported. One of them should be replaced by ?. Incorrect: * 5,7,9 14/2 * * WED,SAT *, correct: * 5,7,9 14/2 ? * WED,SAT *. See details in Cron Trigger Tutorial.
RepoKey This property is required. string
Repository name.
Url This property is required. string
The URL of the target local repository on a remote Artifactory server. Use the format https://<artifactory_url>/artifactory/<repository_name>.
Username This property is required. string
Username on the remote Artifactory instance.
CheckBinaryExistenceInFilestore bool
Enabling the check_binary_existence_in_filestore flag requires an Enterprise Plus license. When true, enables distributed checksum storage. For more information, see Optimizing Repository Replication with Checksum-Based Storage.
EnableEventReplication bool
When set, each event will trigger replication of the artifacts changed in this event. This can be any type of event on artifact, e.g. add, deleted or property change. Default value is false.
Enabled bool
When set, enables replication of this repository to the target specified in url attribute. Default value is true.
ExcludePathPrefixPattern string
List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*. By default, no artifacts are excluded.
IncludePathPrefixPattern string
List of 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 (**/*).
Password string
Use either the HTTP authentication password or identity token.
Proxy string
Proxy key from Artifactory Proxies settings. The proxy configuration will be used when communicating with the remote instance.
SocketTimeoutMillis int
The network timeout in milliseconds to use for remote operations. Default value is 15000.
SyncDeletes bool
When set, items that were deleted locally should also be deleted remotely (also applies to properties metadata). Note that enabling this option, will delete artifacts on the target that do not exist in the source repository. Default value is false.
SyncProperties bool
When set, the task also synchronizes the properties of replicated artifacts. Default value is true.
SyncStatistics bool
When set, the task also synchronizes artifact download statistics. Set to avoid inadvertent cleanup at the target instance when setting up replication for disaster recovery. Default value is false
CronExp This property is required. string
A valid CRON expression that you can use to control replication frequency. Eg: 0 0 12 * * ? *, 0 0 2 ? * MON-SAT *. Note: use 6 or 7 parts format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year (optional). Specifying both a day-of-week AND a day-of-month parameter is not supported. One of them should be replaced by ?. Incorrect: * 5,7,9 14/2 * * WED,SAT *, correct: * 5,7,9 14/2 ? * WED,SAT *. See details in Cron Trigger Tutorial.
RepoKey This property is required. string
Repository name.
Url This property is required. string
The URL of the target local repository on a remote Artifactory server. Use the format https://<artifactory_url>/artifactory/<repository_name>.
Username This property is required. string
Username on the remote Artifactory instance.
CheckBinaryExistenceInFilestore bool
Enabling the check_binary_existence_in_filestore flag requires an Enterprise Plus license. When true, enables distributed checksum storage. For more information, see Optimizing Repository Replication with Checksum-Based Storage.
EnableEventReplication bool
When set, each event will trigger replication of the artifacts changed in this event. This can be any type of event on artifact, e.g. add, deleted or property change. Default value is false.
Enabled bool
When set, enables replication of this repository to the target specified in url attribute. Default value is true.
ExcludePathPrefixPattern string
List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*. By default, no artifacts are excluded.
IncludePathPrefixPattern string
List of 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 (**/*).
Password string
Use either the HTTP authentication password or identity token.
Proxy string
Proxy key from Artifactory Proxies settings. The proxy configuration will be used when communicating with the remote instance.
SocketTimeoutMillis int
The network timeout in milliseconds to use for remote operations. Default value is 15000.
SyncDeletes bool
When set, items that were deleted locally should also be deleted remotely (also applies to properties metadata). Note that enabling this option, will delete artifacts on the target that do not exist in the source repository. Default value is false.
SyncProperties bool
When set, the task also synchronizes the properties of replicated artifacts. Default value is true.
SyncStatistics bool
When set, the task also synchronizes artifact download statistics. Set to avoid inadvertent cleanup at the target instance when setting up replication for disaster recovery. Default value is false
cronExp This property is required. String
A valid CRON expression that you can use to control replication frequency. Eg: 0 0 12 * * ? *, 0 0 2 ? * MON-SAT *. Note: use 6 or 7 parts format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year (optional). Specifying both a day-of-week AND a day-of-month parameter is not supported. One of them should be replaced by ?. Incorrect: * 5,7,9 14/2 * * WED,SAT *, correct: * 5,7,9 14/2 ? * WED,SAT *. See details in Cron Trigger Tutorial.
repoKey This property is required. String
Repository name.
url This property is required. String
The URL of the target local repository on a remote Artifactory server. Use the format https://<artifactory_url>/artifactory/<repository_name>.
username This property is required. String
Username on the remote Artifactory instance.
checkBinaryExistenceInFilestore Boolean
Enabling the check_binary_existence_in_filestore flag requires an Enterprise Plus license. When true, enables distributed checksum storage. For more information, see Optimizing Repository Replication with Checksum-Based Storage.
enableEventReplication Boolean
When set, each event will trigger replication of the artifacts changed in this event. This can be any type of event on artifact, e.g. add, deleted or property change. Default value is false.
enabled Boolean
When set, enables replication of this repository to the target specified in url attribute. Default value is true.
excludePathPrefixPattern String
List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*. By default, no artifacts are excluded.
includePathPrefixPattern String
List of 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 (**/*).
password String
Use either the HTTP authentication password or identity token.
proxy String
Proxy key from Artifactory Proxies settings. The proxy configuration will be used when communicating with the remote instance.
socketTimeoutMillis Integer
The network timeout in milliseconds to use for remote operations. Default value is 15000.
syncDeletes Boolean
When set, items that were deleted locally should also be deleted remotely (also applies to properties metadata). Note that enabling this option, will delete artifacts on the target that do not exist in the source repository. Default value is false.
syncProperties Boolean
When set, the task also synchronizes the properties of replicated artifacts. Default value is true.
syncStatistics Boolean
When set, the task also synchronizes artifact download statistics. Set to avoid inadvertent cleanup at the target instance when setting up replication for disaster recovery. Default value is false
cronExp This property is required. string
A valid CRON expression that you can use to control replication frequency. Eg: 0 0 12 * * ? *, 0 0 2 ? * MON-SAT *. Note: use 6 or 7 parts format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year (optional). Specifying both a day-of-week AND a day-of-month parameter is not supported. One of them should be replaced by ?. Incorrect: * 5,7,9 14/2 * * WED,SAT *, correct: * 5,7,9 14/2 ? * WED,SAT *. See details in Cron Trigger Tutorial.
repoKey This property is required. string
Repository name.
url This property is required. string
The URL of the target local repository on a remote Artifactory server. Use the format https://<artifactory_url>/artifactory/<repository_name>.
username This property is required. string
Username on the remote Artifactory instance.
checkBinaryExistenceInFilestore boolean
Enabling the check_binary_existence_in_filestore flag requires an Enterprise Plus license. When true, enables distributed checksum storage. For more information, see Optimizing Repository Replication with Checksum-Based Storage.
enableEventReplication boolean
When set, each event will trigger replication of the artifacts changed in this event. This can be any type of event on artifact, e.g. add, deleted or property change. Default value is false.
enabled boolean
When set, enables replication of this repository to the target specified in url attribute. Default value is true.
excludePathPrefixPattern string
List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*. By default, no artifacts are excluded.
includePathPrefixPattern string
List of 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 (**/*).
password string
Use either the HTTP authentication password or identity token.
proxy string
Proxy key from Artifactory Proxies settings. The proxy configuration will be used when communicating with the remote instance.
socketTimeoutMillis number
The network timeout in milliseconds to use for remote operations. Default value is 15000.
syncDeletes boolean
When set, items that were deleted locally should also be deleted remotely (also applies to properties metadata). Note that enabling this option, will delete artifacts on the target that do not exist in the source repository. Default value is false.
syncProperties boolean
When set, the task also synchronizes the properties of replicated artifacts. Default value is true.
syncStatistics boolean
When set, the task also synchronizes artifact download statistics. Set to avoid inadvertent cleanup at the target instance when setting up replication for disaster recovery. Default value is false
cron_exp This property is required. str
A valid CRON expression that you can use to control replication frequency. Eg: 0 0 12 * * ? *, 0 0 2 ? * MON-SAT *. Note: use 6 or 7 parts format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year (optional). Specifying both a day-of-week AND a day-of-month parameter is not supported. One of them should be replaced by ?. Incorrect: * 5,7,9 14/2 * * WED,SAT *, correct: * 5,7,9 14/2 ? * WED,SAT *. See details in Cron Trigger Tutorial.
repo_key This property is required. str
Repository name.
url This property is required. str
The URL of the target local repository on a remote Artifactory server. Use the format https://<artifactory_url>/artifactory/<repository_name>.
username This property is required. str
Username on the remote Artifactory instance.
check_binary_existence_in_filestore bool
Enabling the check_binary_existence_in_filestore flag requires an Enterprise Plus license. When true, enables distributed checksum storage. For more information, see Optimizing Repository Replication with Checksum-Based Storage.
enable_event_replication bool
When set, each event will trigger replication of the artifacts changed in this event. This can be any type of event on artifact, e.g. add, deleted or property change. Default value is false.
enabled bool
When set, enables replication of this repository to the target specified in url attribute. Default value is true.
exclude_path_prefix_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.
include_path_prefix_pattern str
List of 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 (**/*).
password str
Use either the HTTP authentication password or identity token.
proxy str
Proxy key from Artifactory Proxies settings. The proxy configuration will be used when communicating with the remote instance.
socket_timeout_millis int
The network timeout in milliseconds to use for remote operations. Default value is 15000.
sync_deletes bool
When set, items that were deleted locally should also be deleted remotely (also applies to properties metadata). Note that enabling this option, will delete artifacts on the target that do not exist in the source repository. Default value is false.
sync_properties bool
When set, the task also synchronizes the properties of replicated artifacts. Default value is true.
sync_statistics bool
When set, the task also synchronizes artifact download statistics. Set to avoid inadvertent cleanup at the target instance when setting up replication for disaster recovery. Default value is false
cronExp This property is required. String
A valid CRON expression that you can use to control replication frequency. Eg: 0 0 12 * * ? *, 0 0 2 ? * MON-SAT *. Note: use 6 or 7 parts format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year (optional). Specifying both a day-of-week AND a day-of-month parameter is not supported. One of them should be replaced by ?. Incorrect: * 5,7,9 14/2 * * WED,SAT *, correct: * 5,7,9 14/2 ? * WED,SAT *. See details in Cron Trigger Tutorial.
repoKey This property is required. String
Repository name.
url This property is required. String
The URL of the target local repository on a remote Artifactory server. Use the format https://<artifactory_url>/artifactory/<repository_name>.
username This property is required. String
Username on the remote Artifactory instance.
checkBinaryExistenceInFilestore Boolean
Enabling the check_binary_existence_in_filestore flag requires an Enterprise Plus license. When true, enables distributed checksum storage. For more information, see Optimizing Repository Replication with Checksum-Based Storage.
enableEventReplication Boolean
When set, each event will trigger replication of the artifacts changed in this event. This can be any type of event on artifact, e.g. add, deleted or property change. Default value is false.
enabled Boolean
When set, enables replication of this repository to the target specified in url attribute. Default value is true.
excludePathPrefixPattern String
List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*. By default, no artifacts are excluded.
includePathPrefixPattern String
List of 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 (**/*).
password String
Use either the HTTP authentication password or identity token.
proxy String
Proxy key from Artifactory Proxies settings. The proxy configuration will be used when communicating with the remote instance.
socketTimeoutMillis Number
The network timeout in milliseconds to use for remote operations. Default value is 15000.
syncDeletes Boolean
When set, items that were deleted locally should also be deleted remotely (also applies to properties metadata). Note that enabling this option, will delete artifacts on the target that do not exist in the source repository. Default value is false.
syncProperties Boolean
When set, the task also synchronizes the properties of replicated artifacts. Default value is true.
syncStatistics Boolean
When set, the task also synchronizes artifact download statistics. Set to avoid inadvertent cleanup at the target instance when setting up replication for disaster recovery. Default value is false

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
ReplicationKey string
Replication ID, the value is unknown until the resource is created. Can't be set or updated.
Id string
The provider-assigned unique ID for this managed resource.
ReplicationKey string
Replication ID, the value is unknown until the resource is created. Can't be set or updated.
id String
The provider-assigned unique ID for this managed resource.
replicationKey String
Replication ID, the value is unknown until the resource is created. Can't be set or updated.
id string
The provider-assigned unique ID for this managed resource.
replicationKey string
Replication ID, the value is unknown until the resource is created. Can't be set or updated.
id str
The provider-assigned unique ID for this managed resource.
replication_key str
Replication ID, the value is unknown until the resource is created. Can't be set or updated.
id String
The provider-assigned unique ID for this managed resource.
replicationKey String
Replication ID, the value is unknown until the resource is created. Can't be set or updated.

Look up Existing LocalRepositorySingleReplication Resource

Get an existing LocalRepositorySingleReplication 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?: LocalRepositorySingleReplicationState, opts?: CustomResourceOptions): LocalRepositorySingleReplication
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        check_binary_existence_in_filestore: Optional[bool] = None,
        cron_exp: Optional[str] = None,
        enable_event_replication: Optional[bool] = None,
        enabled: Optional[bool] = None,
        exclude_path_prefix_pattern: Optional[str] = None,
        include_path_prefix_pattern: Optional[str] = None,
        password: Optional[str] = None,
        proxy: Optional[str] = None,
        replication_key: Optional[str] = None,
        repo_key: Optional[str] = None,
        socket_timeout_millis: Optional[int] = None,
        sync_deletes: Optional[bool] = None,
        sync_properties: Optional[bool] = None,
        sync_statistics: Optional[bool] = None,
        url: Optional[str] = None,
        username: Optional[str] = None) -> LocalRepositorySingleReplication
func GetLocalRepositorySingleReplication(ctx *Context, name string, id IDInput, state *LocalRepositorySingleReplicationState, opts ...ResourceOption) (*LocalRepositorySingleReplication, error)
public static LocalRepositorySingleReplication Get(string name, Input<string> id, LocalRepositorySingleReplicationState? state, CustomResourceOptions? opts = null)
public static LocalRepositorySingleReplication get(String name, Output<String> id, LocalRepositorySingleReplicationState state, CustomResourceOptions options)
resources:  _:    type: artifactory:LocalRepositorySingleReplication    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CheckBinaryExistenceInFilestore bool
Enabling the check_binary_existence_in_filestore flag requires an Enterprise Plus license. When true, enables distributed checksum storage. For more information, see Optimizing Repository Replication with Checksum-Based Storage.
CronExp string
A valid CRON expression that you can use to control replication frequency. Eg: 0 0 12 * * ? *, 0 0 2 ? * MON-SAT *. Note: use 6 or 7 parts format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year (optional). Specifying both a day-of-week AND a day-of-month parameter is not supported. One of them should be replaced by ?. Incorrect: * 5,7,9 14/2 * * WED,SAT *, correct: * 5,7,9 14/2 ? * WED,SAT *. See details in Cron Trigger Tutorial.
EnableEventReplication bool
When set, each event will trigger replication of the artifacts changed in this event. This can be any type of event on artifact, e.g. add, deleted or property change. Default value is false.
Enabled bool
When set, enables replication of this repository to the target specified in url attribute. Default value is true.
ExcludePathPrefixPattern string
List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*. By default, no artifacts are excluded.
IncludePathPrefixPattern string
List of 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 (**/*).
Password string
Use either the HTTP authentication password or identity token.
Proxy string
Proxy key from Artifactory Proxies settings. The proxy configuration will be used when communicating with the remote instance.
ReplicationKey string
Replication ID, the value is unknown until the resource is created. Can't be set or updated.
RepoKey string
Repository name.
SocketTimeoutMillis int
The network timeout in milliseconds to use for remote operations. Default value is 15000.
SyncDeletes bool
When set, items that were deleted locally should also be deleted remotely (also applies to properties metadata). Note that enabling this option, will delete artifacts on the target that do not exist in the source repository. Default value is false.
SyncProperties bool
When set, the task also synchronizes the properties of replicated artifacts. Default value is true.
SyncStatistics bool
When set, the task also synchronizes artifact download statistics. Set to avoid inadvertent cleanup at the target instance when setting up replication for disaster recovery. Default value is false
Url string
The URL of the target local repository on a remote Artifactory server. Use the format https://<artifactory_url>/artifactory/<repository_name>.
Username string
Username on the remote Artifactory instance.
CheckBinaryExistenceInFilestore bool
Enabling the check_binary_existence_in_filestore flag requires an Enterprise Plus license. When true, enables distributed checksum storage. For more information, see Optimizing Repository Replication with Checksum-Based Storage.
CronExp string
A valid CRON expression that you can use to control replication frequency. Eg: 0 0 12 * * ? *, 0 0 2 ? * MON-SAT *. Note: use 6 or 7 parts format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year (optional). Specifying both a day-of-week AND a day-of-month parameter is not supported. One of them should be replaced by ?. Incorrect: * 5,7,9 14/2 * * WED,SAT *, correct: * 5,7,9 14/2 ? * WED,SAT *. See details in Cron Trigger Tutorial.
EnableEventReplication bool
When set, each event will trigger replication of the artifacts changed in this event. This can be any type of event on artifact, e.g. add, deleted or property change. Default value is false.
Enabled bool
When set, enables replication of this repository to the target specified in url attribute. Default value is true.
ExcludePathPrefixPattern string
List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*. By default, no artifacts are excluded.
IncludePathPrefixPattern string
List of 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 (**/*).
Password string
Use either the HTTP authentication password or identity token.
Proxy string
Proxy key from Artifactory Proxies settings. The proxy configuration will be used when communicating with the remote instance.
ReplicationKey string
Replication ID, the value is unknown until the resource is created. Can't be set or updated.
RepoKey string
Repository name.
SocketTimeoutMillis int
The network timeout in milliseconds to use for remote operations. Default value is 15000.
SyncDeletes bool
When set, items that were deleted locally should also be deleted remotely (also applies to properties metadata). Note that enabling this option, will delete artifacts on the target that do not exist in the source repository. Default value is false.
SyncProperties bool
When set, the task also synchronizes the properties of replicated artifacts. Default value is true.
SyncStatistics bool
When set, the task also synchronizes artifact download statistics. Set to avoid inadvertent cleanup at the target instance when setting up replication for disaster recovery. Default value is false
Url string
The URL of the target local repository on a remote Artifactory server. Use the format https://<artifactory_url>/artifactory/<repository_name>.
Username string
Username on the remote Artifactory instance.
checkBinaryExistenceInFilestore Boolean
Enabling the check_binary_existence_in_filestore flag requires an Enterprise Plus license. When true, enables distributed checksum storage. For more information, see Optimizing Repository Replication with Checksum-Based Storage.
cronExp String
A valid CRON expression that you can use to control replication frequency. Eg: 0 0 12 * * ? *, 0 0 2 ? * MON-SAT *. Note: use 6 or 7 parts format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year (optional). Specifying both a day-of-week AND a day-of-month parameter is not supported. One of them should be replaced by ?. Incorrect: * 5,7,9 14/2 * * WED,SAT *, correct: * 5,7,9 14/2 ? * WED,SAT *. See details in Cron Trigger Tutorial.
enableEventReplication Boolean
When set, each event will trigger replication of the artifacts changed in this event. This can be any type of event on artifact, e.g. add, deleted or property change. Default value is false.
enabled Boolean
When set, enables replication of this repository to the target specified in url attribute. Default value is true.
excludePathPrefixPattern String
List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*. By default, no artifacts are excluded.
includePathPrefixPattern String
List of 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 (**/*).
password String
Use either the HTTP authentication password or identity token.
proxy String
Proxy key from Artifactory Proxies settings. The proxy configuration will be used when communicating with the remote instance.
replicationKey String
Replication ID, the value is unknown until the resource is created. Can't be set or updated.
repoKey String
Repository name.
socketTimeoutMillis Integer
The network timeout in milliseconds to use for remote operations. Default value is 15000.
syncDeletes Boolean
When set, items that were deleted locally should also be deleted remotely (also applies to properties metadata). Note that enabling this option, will delete artifacts on the target that do not exist in the source repository. Default value is false.
syncProperties Boolean
When set, the task also synchronizes the properties of replicated artifacts. Default value is true.
syncStatistics Boolean
When set, the task also synchronizes artifact download statistics. Set to avoid inadvertent cleanup at the target instance when setting up replication for disaster recovery. Default value is false
url String
The URL of the target local repository on a remote Artifactory server. Use the format https://<artifactory_url>/artifactory/<repository_name>.
username String
Username on the remote Artifactory instance.
checkBinaryExistenceInFilestore boolean
Enabling the check_binary_existence_in_filestore flag requires an Enterprise Plus license. When true, enables distributed checksum storage. For more information, see Optimizing Repository Replication with Checksum-Based Storage.
cronExp string
A valid CRON expression that you can use to control replication frequency. Eg: 0 0 12 * * ? *, 0 0 2 ? * MON-SAT *. Note: use 6 or 7 parts format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year (optional). Specifying both a day-of-week AND a day-of-month parameter is not supported. One of them should be replaced by ?. Incorrect: * 5,7,9 14/2 * * WED,SAT *, correct: * 5,7,9 14/2 ? * WED,SAT *. See details in Cron Trigger Tutorial.
enableEventReplication boolean
When set, each event will trigger replication of the artifacts changed in this event. This can be any type of event on artifact, e.g. add, deleted or property change. Default value is false.
enabled boolean
When set, enables replication of this repository to the target specified in url attribute. Default value is true.
excludePathPrefixPattern string
List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*. By default, no artifacts are excluded.
includePathPrefixPattern string
List of 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 (**/*).
password string
Use either the HTTP authentication password or identity token.
proxy string
Proxy key from Artifactory Proxies settings. The proxy configuration will be used when communicating with the remote instance.
replicationKey string
Replication ID, the value is unknown until the resource is created. Can't be set or updated.
repoKey string
Repository name.
socketTimeoutMillis number
The network timeout in milliseconds to use for remote operations. Default value is 15000.
syncDeletes boolean
When set, items that were deleted locally should also be deleted remotely (also applies to properties metadata). Note that enabling this option, will delete artifacts on the target that do not exist in the source repository. Default value is false.
syncProperties boolean
When set, the task also synchronizes the properties of replicated artifacts. Default value is true.
syncStatistics boolean
When set, the task also synchronizes artifact download statistics. Set to avoid inadvertent cleanup at the target instance when setting up replication for disaster recovery. Default value is false
url string
The URL of the target local repository on a remote Artifactory server. Use the format https://<artifactory_url>/artifactory/<repository_name>.
username string
Username on the remote Artifactory instance.
check_binary_existence_in_filestore bool
Enabling the check_binary_existence_in_filestore flag requires an Enterprise Plus license. When true, enables distributed checksum storage. For more information, see Optimizing Repository Replication with Checksum-Based Storage.
cron_exp str
A valid CRON expression that you can use to control replication frequency. Eg: 0 0 12 * * ? *, 0 0 2 ? * MON-SAT *. Note: use 6 or 7 parts format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year (optional). Specifying both a day-of-week AND a day-of-month parameter is not supported. One of them should be replaced by ?. Incorrect: * 5,7,9 14/2 * * WED,SAT *, correct: * 5,7,9 14/2 ? * WED,SAT *. See details in Cron Trigger Tutorial.
enable_event_replication bool
When set, each event will trigger replication of the artifacts changed in this event. This can be any type of event on artifact, e.g. add, deleted or property change. Default value is false.
enabled bool
When set, enables replication of this repository to the target specified in url attribute. Default value is true.
exclude_path_prefix_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.
include_path_prefix_pattern str
List of 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 (**/*).
password str
Use either the HTTP authentication password or identity token.
proxy str
Proxy key from Artifactory Proxies settings. The proxy configuration will be used when communicating with the remote instance.
replication_key str
Replication ID, the value is unknown until the resource is created. Can't be set or updated.
repo_key str
Repository name.
socket_timeout_millis int
The network timeout in milliseconds to use for remote operations. Default value is 15000.
sync_deletes bool
When set, items that were deleted locally should also be deleted remotely (also applies to properties metadata). Note that enabling this option, will delete artifacts on the target that do not exist in the source repository. Default value is false.
sync_properties bool
When set, the task also synchronizes the properties of replicated artifacts. Default value is true.
sync_statistics bool
When set, the task also synchronizes artifact download statistics. Set to avoid inadvertent cleanup at the target instance when setting up replication for disaster recovery. Default value is false
url str
The URL of the target local repository on a remote Artifactory server. Use the format https://<artifactory_url>/artifactory/<repository_name>.
username str
Username on the remote Artifactory instance.
checkBinaryExistenceInFilestore Boolean
Enabling the check_binary_existence_in_filestore flag requires an Enterprise Plus license. When true, enables distributed checksum storage. For more information, see Optimizing Repository Replication with Checksum-Based Storage.
cronExp String
A valid CRON expression that you can use to control replication frequency. Eg: 0 0 12 * * ? *, 0 0 2 ? * MON-SAT *. Note: use 6 or 7 parts format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year (optional). Specifying both a day-of-week AND a day-of-month parameter is not supported. One of them should be replaced by ?. Incorrect: * 5,7,9 14/2 * * WED,SAT *, correct: * 5,7,9 14/2 ? * WED,SAT *. See details in Cron Trigger Tutorial.
enableEventReplication Boolean
When set, each event will trigger replication of the artifacts changed in this event. This can be any type of event on artifact, e.g. add, deleted or property change. Default value is false.
enabled Boolean
When set, enables replication of this repository to the target specified in url attribute. Default value is true.
excludePathPrefixPattern String
List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*. By default, no artifacts are excluded.
includePathPrefixPattern String
List of 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 (**/*).
password String
Use either the HTTP authentication password or identity token.
proxy String
Proxy key from Artifactory Proxies settings. The proxy configuration will be used when communicating with the remote instance.
replicationKey String
Replication ID, the value is unknown until the resource is created. Can't be set or updated.
repoKey String
Repository name.
socketTimeoutMillis Number
The network timeout in milliseconds to use for remote operations. Default value is 15000.
syncDeletes Boolean
When set, items that were deleted locally should also be deleted remotely (also applies to properties metadata). Note that enabling this option, will delete artifacts on the target that do not exist in the source repository. Default value is false.
syncProperties Boolean
When set, the task also synchronizes the properties of replicated artifacts. Default value is true.
syncStatistics Boolean
When set, the task also synchronizes artifact download statistics. Set to avoid inadvertent cleanup at the target instance when setting up replication for disaster recovery. Default value is false
url String
The URL of the target local repository on a remote Artifactory server. Use the format https://<artifactory_url>/artifactory/<repository_name>.
username String
Username on the remote Artifactory instance.

Import

Push replication configs can be imported using their repo key, e.g.

$ pulumi import artifactory:index/localRepositorySingleReplication:LocalRepositorySingleReplication foo-rep provider_test_source
Copy

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.