1. Packages
  2. Artifactory
  3. API Docs
  4. SingleReplicationConfig
artifactory v6.8.4 published on Thursday, Jun 6, 2024 by Pulumi

artifactory.SingleReplicationConfig

Explore with Pulumi AI

artifactory logo
artifactory v6.8.4 published on Thursday, Jun 6, 2024 by Pulumi

    This resource is deprecated in favor of artifactory.PullReplication resource.

    Provides an Artifactory single replication config resource. This can be used to create and manage a single Artifactory replication. Primarily used when pull replication is needed.

    !> This should not be used on a repository with artifactory.ReplicationConfig. Using both together will cause unexpected behaviour and will almost certainly cause your replications to break.

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    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:SingleReplicationConfig
        properties:
          repoKey: ${providerTestSource.key}
          cronExp: 0 0 * * * ?
          enableEventReplication: true
          url: ${artifactoryUrl}
          username: ${artifactoryUsername}
          password: ${artifactoryPassword}
    

    Create SingleReplicationConfig Resource

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

    Constructor syntax

    new SingleReplicationConfig(name: string, args: SingleReplicationConfigArgs, opts?: CustomResourceOptions);
    @overload
    def SingleReplicationConfig(resource_name: str,
                                args: SingleReplicationConfigArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def SingleReplicationConfig(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                cron_exp: Optional[str] = None,
                                repo_key: Optional[str] = None,
                                enable_event_replication: Optional[bool] = None,
                                enabled: Optional[bool] = None,
                                path_prefix: Optional[str] = None,
                                proxy: 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)
    func NewSingleReplicationConfig(ctx *Context, name string, args SingleReplicationConfigArgs, opts ...ResourceOption) (*SingleReplicationConfig, error)
    public SingleReplicationConfig(string name, SingleReplicationConfigArgs args, CustomResourceOptions? opts = null)
    public SingleReplicationConfig(String name, SingleReplicationConfigArgs args)
    public SingleReplicationConfig(String name, SingleReplicationConfigArgs args, CustomResourceOptions options)
    
    type: artifactory:SingleReplicationConfig
    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 SingleReplicationConfigArgs
    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 SingleReplicationConfigArgs
    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 SingleReplicationConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SingleReplicationConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SingleReplicationConfigArgs
    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 singleReplicationConfigResource = new Artifactory.SingleReplicationConfig("singleReplicationConfigResource", new()
    {
        CronExp = "string",
        RepoKey = "string",
        EnableEventReplication = false,
        Enabled = false,
        PathPrefix = "string",
        Proxy = "string",
        SocketTimeoutMillis = 0,
        SyncDeletes = false,
        SyncProperties = false,
        SyncStatistics = false,
        Url = "string",
        Username = "string",
    });
    
    example, err := artifactory.NewSingleReplicationConfig(ctx, "singleReplicationConfigResource", &artifactory.SingleReplicationConfigArgs{
    	CronExp:                pulumi.String("string"),
    	RepoKey:                pulumi.String("string"),
    	EnableEventReplication: pulumi.Bool(false),
    	Enabled:                pulumi.Bool(false),
    	PathPrefix:             pulumi.String("string"),
    	Proxy:                  pulumi.String("string"),
    	SocketTimeoutMillis:    pulumi.Int(0),
    	SyncDeletes:            pulumi.Bool(false),
    	SyncProperties:         pulumi.Bool(false),
    	SyncStatistics:         pulumi.Bool(false),
    	Url:                    pulumi.String("string"),
    	Username:               pulumi.String("string"),
    })
    
    var singleReplicationConfigResource = new SingleReplicationConfig("singleReplicationConfigResource", SingleReplicationConfigArgs.builder()
        .cronExp("string")
        .repoKey("string")
        .enableEventReplication(false)
        .enabled(false)
        .pathPrefix("string")
        .proxy("string")
        .socketTimeoutMillis(0)
        .syncDeletes(false)
        .syncProperties(false)
        .syncStatistics(false)
        .url("string")
        .username("string")
        .build());
    
    single_replication_config_resource = artifactory.SingleReplicationConfig("singleReplicationConfigResource",
        cron_exp="string",
        repo_key="string",
        enable_event_replication=False,
        enabled=False,
        path_prefix="string",
        proxy="string",
        socket_timeout_millis=0,
        sync_deletes=False,
        sync_properties=False,
        sync_statistics=False,
        url="string",
        username="string")
    
    const singleReplicationConfigResource = new artifactory.SingleReplicationConfig("singleReplicationConfigResource", {
        cronExp: "string",
        repoKey: "string",
        enableEventReplication: false,
        enabled: false,
        pathPrefix: "string",
        proxy: "string",
        socketTimeoutMillis: 0,
        syncDeletes: false,
        syncProperties: false,
        syncStatistics: false,
        url: "string",
        username: "string",
    });
    
    type: artifactory:SingleReplicationConfig
    properties:
        cronExp: string
        enableEventReplication: false
        enabled: false
        pathPrefix: string
        proxy: string
        repoKey: string
        socketTimeoutMillis: 0
        syncDeletes: false
        syncProperties: false
        syncStatistics: false
        url: string
        username: string
    

    SingleReplicationConfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SingleReplicationConfig resource accepts the following input properties:

    CronExp string
    Cron expression to control the operation frequency.
    RepoKey string
    EnableEventReplication bool
    Enabled bool
    PathPrefix string
    Proxy string
    Proxy key from Artifactory Proxies setting.
    SocketTimeoutMillis int
    SyncDeletes bool
    SyncProperties bool
    SyncStatistics bool
    Url string
    Username string
    CronExp string
    Cron expression to control the operation frequency.
    RepoKey string
    EnableEventReplication bool
    Enabled bool
    PathPrefix string
    Proxy string
    Proxy key from Artifactory Proxies setting.
    SocketTimeoutMillis int
    SyncDeletes bool
    SyncProperties bool
    SyncStatistics bool
    Url string
    Username string
    cronExp String
    Cron expression to control the operation frequency.
    repoKey String
    enableEventReplication Boolean
    enabled Boolean
    pathPrefix String
    proxy String
    Proxy key from Artifactory Proxies setting.
    socketTimeoutMillis Integer
    syncDeletes Boolean
    syncProperties Boolean
    syncStatistics Boolean
    url String
    username String
    cronExp string
    Cron expression to control the operation frequency.
    repoKey string
    enableEventReplication boolean
    enabled boolean
    pathPrefix string
    proxy string
    Proxy key from Artifactory Proxies setting.
    socketTimeoutMillis number
    syncDeletes boolean
    syncProperties boolean
    syncStatistics boolean
    url string
    username string
    cron_exp str
    Cron expression to control the operation frequency.
    repo_key str
    enable_event_replication bool
    enabled bool
    path_prefix str
    proxy str
    Proxy key from Artifactory Proxies setting.
    socket_timeout_millis int
    sync_deletes bool
    sync_properties bool
    sync_statistics bool
    url str
    username str
    cronExp String
    Cron expression to control the operation frequency.
    repoKey String
    enableEventReplication Boolean
    enabled Boolean
    pathPrefix String
    proxy String
    Proxy key from Artifactory Proxies setting.
    socketTimeoutMillis Number
    syncDeletes Boolean
    syncProperties Boolean
    syncStatistics Boolean
    url String
    username String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    Requires password encryption to be turned off POST /api/system/decrypt.
    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    Requires password encryption to be turned off POST /api/system/decrypt.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    Requires password encryption to be turned off POST /api/system/decrypt.
    id string
    The provider-assigned unique ID for this managed resource.
    password string
    Requires password encryption to be turned off POST /api/system/decrypt.
    id str
    The provider-assigned unique ID for this managed resource.
    password str
    Requires password encryption to be turned off POST /api/system/decrypt.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    Requires password encryption to be turned off POST /api/system/decrypt.

    Look up Existing SingleReplicationConfig Resource

    Get an existing SingleReplicationConfig 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?: SingleReplicationConfigState, opts?: CustomResourceOptions): SingleReplicationConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cron_exp: Optional[str] = None,
            enable_event_replication: Optional[bool] = None,
            enabled: Optional[bool] = None,
            password: Optional[str] = None,
            path_prefix: Optional[str] = None,
            proxy: 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) -> SingleReplicationConfig
    func GetSingleReplicationConfig(ctx *Context, name string, id IDInput, state *SingleReplicationConfigState, opts ...ResourceOption) (*SingleReplicationConfig, error)
    public static SingleReplicationConfig Get(string name, Input<string> id, SingleReplicationConfigState? state, CustomResourceOptions? opts = null)
    public static SingleReplicationConfig get(String name, Output<String> id, SingleReplicationConfigState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CronExp string
    Cron expression to control the operation frequency.
    EnableEventReplication bool
    Enabled bool
    Password string
    Requires password encryption to be turned off POST /api/system/decrypt.
    PathPrefix string
    Proxy string
    Proxy key from Artifactory Proxies setting.
    RepoKey string
    SocketTimeoutMillis int
    SyncDeletes bool
    SyncProperties bool
    SyncStatistics bool
    Url string
    Username string
    CronExp string
    Cron expression to control the operation frequency.
    EnableEventReplication bool
    Enabled bool
    Password string
    Requires password encryption to be turned off POST /api/system/decrypt.
    PathPrefix string
    Proxy string
    Proxy key from Artifactory Proxies setting.
    RepoKey string
    SocketTimeoutMillis int
    SyncDeletes bool
    SyncProperties bool
    SyncStatistics bool
    Url string
    Username string
    cronExp String
    Cron expression to control the operation frequency.
    enableEventReplication Boolean
    enabled Boolean
    password String
    Requires password encryption to be turned off POST /api/system/decrypt.
    pathPrefix String
    proxy String
    Proxy key from Artifactory Proxies setting.
    repoKey String
    socketTimeoutMillis Integer
    syncDeletes Boolean
    syncProperties Boolean
    syncStatistics Boolean
    url String
    username String
    cronExp string
    Cron expression to control the operation frequency.
    enableEventReplication boolean
    enabled boolean
    password string
    Requires password encryption to be turned off POST /api/system/decrypt.
    pathPrefix string
    proxy string
    Proxy key from Artifactory Proxies setting.
    repoKey string
    socketTimeoutMillis number
    syncDeletes boolean
    syncProperties boolean
    syncStatistics boolean
    url string
    username string
    cron_exp str
    Cron expression to control the operation frequency.
    enable_event_replication bool
    enabled bool
    password str
    Requires password encryption to be turned off POST /api/system/decrypt.
    path_prefix str
    proxy str
    Proxy key from Artifactory Proxies setting.
    repo_key str
    socket_timeout_millis int
    sync_deletes bool
    sync_properties bool
    sync_statistics bool
    url str
    username str
    cronExp String
    Cron expression to control the operation frequency.
    enableEventReplication Boolean
    enabled Boolean
    password String
    Requires password encryption to be turned off POST /api/system/decrypt.
    pathPrefix String
    proxy String
    Proxy key from Artifactory Proxies setting.
    repoKey String
    socketTimeoutMillis Number
    syncDeletes Boolean
    syncProperties Boolean
    syncStatistics Boolean
    url String
    username String

    Import

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

    $ pulumi import artifactory:index/singleReplicationConfig:SingleReplicationConfig foo-rep repository-key
    

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

    Package Details

    Repository
    artifactory pulumi/pulumi-artifactory
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the artifactory Terraform Provider.
    artifactory logo
    artifactory v6.8.4 published on Thursday, Jun 6, 2024 by Pulumi