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

artifactory.Backup

Explore with Pulumi AI

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

    This resource can be used to manage the automatic and periodic backups of the entire Artifactory instance.

    When an artifactory.Backup resource is configured and enabled to true, backup of the entire Artifactory system will be done automatically and periodically. The backup process creates a time-stamped directory in the target backup directory.

    ~>The artifactory.Backup resource utilizes endpoints which are blocked/removed in SaaS environments (i.e. in Artifactory online), rendering this resource incompatible with Artifactory SaaS environments.

    Example Usage

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

// Configure Artifactory Backup system config
const backupConfigName = new artifactory.Backup("backup_config_name", {
    key: "backup_config_name",
    enabled: true,
    cronExp: "0 0 12 * * ? *",
    retentionPeriodHours: 1000,
    excludedRepositories: [],
    createArchive: false,
    excludeNewRepositories: true,
    sendMailOnError: true,
    verifyDiskSpace: true,
    exportMissionControl: true,
});

    import pulumi
import pulumi_artifactory as artifactory

# Configure Artifactory Backup system config
backup_config_name = artifactory.Backup("backup_config_name",
    key="backup_config_name",
    enabled=True,
    cron_exp="0 0 12 * * ? *",
    retention_period_hours=1000,
    excluded_repositories=[],
    create_archive=False,
    exclude_new_repositories=True,
    send_mail_on_error=True,
    verify_disk_space=True,
    export_mission_control=True)

    package main

import (
	"github.com/pulumi/pulumi-artifactory/sdk/v6/go/artifactory"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Configure Artifactory Backup system config
		_, err := artifactory.NewBackup(ctx, "backup_config_name", &artifactory.BackupArgs{
			Key:                    pulumi.String("backup_config_name"),
			Enabled:                pulumi.Bool(true),
			CronExp:                pulumi.String("0 0 12 * * ? *"),
			RetentionPeriodHours:   pulumi.Int(1000),
			ExcludedRepositories:   pulumi.StringArray{},
			CreateArchive:          pulumi.Bool(false),
			ExcludeNewRepositories: pulumi.Bool(true),
			SendMailOnError:        pulumi.Bool(true),
			VerifyDiskSpace:        pulumi.Bool(true),
			ExportMissionControl:   pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Artifactory = Pulumi.Artifactory;

return await Deployment.RunAsync(() => 
{
    // Configure Artifactory Backup system config
    var backupConfigName = new Artifactory.Backup("backup_config_name", new()
    {
        Key = "backup_config_name",
        Enabled = true,
        CronExp = "0 0 12 * * ? *",
        RetentionPeriodHours = 1000,
        ExcludedRepositories = new[] {},
        CreateArchive = false,
        ExcludeNewRepositories = true,
        SendMailOnError = true,
        VerifyDiskSpace = true,
        ExportMissionControl = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.artifactory.Backup;
import com.pulumi.artifactory.BackupArgs;
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) {
        // Configure Artifactory Backup system config
        var backupConfigName = new Backup("backupConfigName", BackupArgs.builder()
            .key("backup_config_name")
            .enabled(true)
            .cronExp("0 0 12 * * ? *")
            .retentionPeriodHours(1000)
            .excludedRepositories()
            .createArchive(false)
            .excludeNewRepositories(true)
            .sendMailOnError(true)
            .verifyDiskSpace(true)
            .exportMissionControl(true)
            .build());

    }
}

    resources:
  # Configure Artifactory Backup system config
  backupConfigName:
    type: artifactory:Backup
    name: backup_config_name
    properties:
      key: backup_config_name
      enabled: true
      cronExp: 0 0 12 * * ? *
      retentionPeriodHours: 1000
      excludedRepositories: []
      createArchive: false
      excludeNewRepositories: true
      sendMailOnError: true
      verifyDiskSpace: true
      exportMissionControl: true

    Note: Key argument has to match to the resource name. Reference Link: JFrog Artifactory Backup

    Create Backup Resource

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

    Constructor syntax

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

@overload
def Backup(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           cron_exp: Optional[str] = None,
           key: Optional[str] = None,
           create_archive: Optional[bool] = None,
           enabled: Optional[bool] = None,
           exclude_new_repositories: Optional[bool] = None,
           excluded_repositories: Optional[Sequence[str]] = None,
           export_mission_control: Optional[bool] = None,
           retention_period_hours: Optional[int] = None,
           send_mail_on_error: Optional[bool] = None,
           verify_disk_space: Optional[bool] = None)
    func NewBackup(ctx *Context, name string, args BackupArgs, opts ...ResourceOption) (*Backup, error)
    public Backup(string name, BackupArgs args, CustomResourceOptions? opts = null)
    public Backup(String name, BackupArgs args)
public Backup(String name, BackupArgs args, CustomResourceOptions options)

    type: artifactory:Backup
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 BackupArgs
    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 BackupArgs
    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 BackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupArgs
    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 backupResource = new Artifactory.Backup("backupResource", new()
{
    CronExp = "string",
    Key = "string",
    CreateArchive = false,
    Enabled = false,
    ExcludeNewRepositories = false,
    ExcludedRepositories = new[]
    {
        "string",
    },
    ExportMissionControl = false,
    RetentionPeriodHours = 0,
    SendMailOnError = false,
    VerifyDiskSpace = false,
});

    example, err := artifactory.NewBackup(ctx, "backupResource", &artifactory.BackupArgs{
	CronExp:                pulumi.String("string"),
	Key:                    pulumi.String("string"),
	CreateArchive:          pulumi.Bool(false),
	Enabled:                pulumi.Bool(false),
	ExcludeNewRepositories: pulumi.Bool(false),
	ExcludedRepositories: pulumi.StringArray{
		pulumi.String("string"),
	},
	ExportMissionControl: pulumi.Bool(false),
	RetentionPeriodHours: pulumi.Int(0),
	SendMailOnError:      pulumi.Bool(false),
	VerifyDiskSpace:      pulumi.Bool(false),
})

    var backupResource = new Backup("backupResource", BackupArgs.builder()
    .cronExp("string")
    .key("string")
    .createArchive(false)
    .enabled(false)
    .excludeNewRepositories(false)
    .excludedRepositories("string")
    .exportMissionControl(false)
    .retentionPeriodHours(0)
    .sendMailOnError(false)
    .verifyDiskSpace(false)
    .build());

    backup_resource = artifactory.Backup("backupResource",
    cron_exp="string",
    key="string",
    create_archive=False,
    enabled=False,
    exclude_new_repositories=False,
    excluded_repositories=["string"],
    export_mission_control=False,
    retention_period_hours=0,
    send_mail_on_error=False,
    verify_disk_space=False)

    const backupResource = new artifactory.Backup("backupResource", {
    cronExp: "string",
    key: "string",
    createArchive: false,
    enabled: false,
    excludeNewRepositories: false,
    excludedRepositories: ["string"],
    exportMissionControl: false,
    retentionPeriodHours: 0,
    sendMailOnError: false,
    verifyDiskSpace: false,
});

    type: artifactory:Backup
properties:
    createArchive: false
    cronExp: string
    enabled: false
    excludeNewRepositories: false
    excludedRepositories:
        - string
    exportMissionControl: false
    key: string
    retentionPeriodHours: 0
    sendMailOnError: false
    verifyDiskSpace: false

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

    CronExp string
    A valid CRON expression that you can use to control backup frequency. Eg: "0 0 12 * * ? *", "0 0 2 ? * MON-SAT *". Note: please use 7 character format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year. Also, 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 and in Cronexp package readme.
    Key string
    The unique ID of the artifactory backup config.
    CreateArchive bool
    If set, backups will be created within a Zip archive (Slow and CPU intensive). Default value is false.
    Enabled bool
    Flag to enable or disable the backup config. Default value is true.
    ExcludeNewRepositories bool
    When set, new repositories will not be automatically added to the backup. Default value is false.
    ExcludedRepositories List<string>
    A list of excluded repositories from the backup. Default is empty list.
    ExportMissionControl bool
    When set to true, mission control will not be automatically added to the backup. Default value is false.
    RetentionPeriodHours int
    The number of hours to keep a backup before Artifactory will clean it up to free up disk space. Applicable only to non-incremental backups. Default value is 168 hours ie: 7 days.
    SendMailOnError bool
    If set, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is true.
    VerifyDiskSpace bool
    If set, Artifactory will verify that the backup target location has enough disk space available to hold the backed up data. If there is not enough space available, Artifactory will abort the backup and write a message in the log file. Applicable only to non-incremental backups.
    CronExp string
    A valid CRON expression that you can use to control backup frequency. Eg: "0 0 12 * * ? *", "0 0 2 ? * MON-SAT *". Note: please use 7 character format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year. Also, 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 and in Cronexp package readme.
    Key string
    The unique ID of the artifactory backup config.
    CreateArchive bool
    If set, backups will be created within a Zip archive (Slow and CPU intensive). Default value is false.
    Enabled bool
    Flag to enable or disable the backup config. Default value is true.
    ExcludeNewRepositories bool
    When set, new repositories will not be automatically added to the backup. Default value is false.
    ExcludedRepositories []string
    A list of excluded repositories from the backup. Default is empty list.
    ExportMissionControl bool
    When set to true, mission control will not be automatically added to the backup. Default value is false.
    RetentionPeriodHours int
    The number of hours to keep a backup before Artifactory will clean it up to free up disk space. Applicable only to non-incremental backups. Default value is 168 hours ie: 7 days.
    SendMailOnError bool
    If set, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is true.
    VerifyDiskSpace bool
    If set, Artifactory will verify that the backup target location has enough disk space available to hold the backed up data. If there is not enough space available, Artifactory will abort the backup and write a message in the log file. Applicable only to non-incremental backups.
    cronExp String
    A valid CRON expression that you can use to control backup frequency. Eg: "0 0 12 * * ? *", "0 0 2 ? * MON-SAT *". Note: please use 7 character format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year. Also, 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 and in Cronexp package readme.
    key String
    The unique ID of the artifactory backup config.
    createArchive Boolean
    If set, backups will be created within a Zip archive (Slow and CPU intensive). Default value is false.
    enabled Boolean
    Flag to enable or disable the backup config. Default value is true.
    excludeNewRepositories Boolean
    When set, new repositories will not be automatically added to the backup. Default value is false.
    excludedRepositories List<String>
    A list of excluded repositories from the backup. Default is empty list.
    exportMissionControl Boolean
    When set to true, mission control will not be automatically added to the backup. Default value is false.
    retentionPeriodHours Integer
    The number of hours to keep a backup before Artifactory will clean it up to free up disk space. Applicable only to non-incremental backups. Default value is 168 hours ie: 7 days.
    sendMailOnError Boolean
    If set, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is true.
    verifyDiskSpace Boolean
    If set, Artifactory will verify that the backup target location has enough disk space available to hold the backed up data. If there is not enough space available, Artifactory will abort the backup and write a message in the log file. Applicable only to non-incremental backups.
    cronExp string
    A valid CRON expression that you can use to control backup frequency. Eg: "0 0 12 * * ? *", "0 0 2 ? * MON-SAT *". Note: please use 7 character format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year. Also, 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 and in Cronexp package readme.
    key string
    The unique ID of the artifactory backup config.
    createArchive boolean
    If set, backups will be created within a Zip archive (Slow and CPU intensive). Default value is false.
    enabled boolean
    Flag to enable or disable the backup config. Default value is true.
    excludeNewRepositories boolean
    When set, new repositories will not be automatically added to the backup. Default value is false.
    excludedRepositories string[]
    A list of excluded repositories from the backup. Default is empty list.
    exportMissionControl boolean
    When set to true, mission control will not be automatically added to the backup. Default value is false.
    retentionPeriodHours number
    The number of hours to keep a backup before Artifactory will clean it up to free up disk space. Applicable only to non-incremental backups. Default value is 168 hours ie: 7 days.
    sendMailOnError boolean
    If set, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is true.
    verifyDiskSpace boolean
    If set, Artifactory will verify that the backup target location has enough disk space available to hold the backed up data. If there is not enough space available, Artifactory will abort the backup and write a message in the log file. Applicable only to non-incremental backups.
    cron_exp str
    A valid CRON expression that you can use to control backup frequency. Eg: "0 0 12 * * ? *", "0 0 2 ? * MON-SAT *". Note: please use 7 character format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year. Also, 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 and in Cronexp package readme.
    key str
    The unique ID of the artifactory backup config.
    create_archive bool
    If set, backups will be created within a Zip archive (Slow and CPU intensive). Default value is false.
    enabled bool
    Flag to enable or disable the backup config. Default value is true.
    exclude_new_repositories bool
    When set, new repositories will not be automatically added to the backup. Default value is false.
    excluded_repositories Sequence[str]
    A list of excluded repositories from the backup. Default is empty list.
    export_mission_control bool
    When set to true, mission control will not be automatically added to the backup. Default value is false.
    retention_period_hours int
    The number of hours to keep a backup before Artifactory will clean it up to free up disk space. Applicable only to non-incremental backups. Default value is 168 hours ie: 7 days.
    send_mail_on_error bool
    If set, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is true.
    verify_disk_space bool
    If set, Artifactory will verify that the backup target location has enough disk space available to hold the backed up data. If there is not enough space available, Artifactory will abort the backup and write a message in the log file. Applicable only to non-incremental backups.
    cronExp String
    A valid CRON expression that you can use to control backup frequency. Eg: "0 0 12 * * ? *", "0 0 2 ? * MON-SAT *". Note: please use 7 character format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year. Also, 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 and in Cronexp package readme.
    key String
    The unique ID of the artifactory backup config.
    createArchive Boolean
    If set, backups will be created within a Zip archive (Slow and CPU intensive). Default value is false.
    enabled Boolean
    Flag to enable or disable the backup config. Default value is true.
    excludeNewRepositories Boolean
    When set, new repositories will not be automatically added to the backup. Default value is false.
    excludedRepositories List<String>
    A list of excluded repositories from the backup. Default is empty list.
    exportMissionControl Boolean
    When set to true, mission control will not be automatically added to the backup. Default value is false.
    retentionPeriodHours Number
    The number of hours to keep a backup before Artifactory will clean it up to free up disk space. Applicable only to non-incremental backups. Default value is 168 hours ie: 7 days.
    sendMailOnError Boolean
    If set, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is true.
    verifyDiskSpace Boolean
    If set, Artifactory will verify that the backup target location has enough disk space available to hold the backed up data. If there is not enough space available, Artifactory will abort the backup and write a message in the log file. Applicable only to non-incremental backups.

    Outputs

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

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

    Look up Existing Backup Resource

    Get an existing Backup 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?: BackupState, opts?: CustomResourceOptions): Backup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_archive: Optional[bool] = None,
        cron_exp: Optional[str] = None,
        enabled: Optional[bool] = None,
        exclude_new_repositories: Optional[bool] = None,
        excluded_repositories: Optional[Sequence[str]] = None,
        export_mission_control: Optional[bool] = None,
        key: Optional[str] = None,
        retention_period_hours: Optional[int] = None,
        send_mail_on_error: Optional[bool] = None,
        verify_disk_space: Optional[bool] = None) -> Backup
    func GetBackup(ctx *Context, name string, id IDInput, state *BackupState, opts ...ResourceOption) (*Backup, error)
    public static Backup Get(string name, Input<string> id, BackupState? state, CustomResourceOptions? opts = null)
    public static Backup get(String name, Output<String> id, BackupState 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:
    CreateArchive bool
    If set, backups will be created within a Zip archive (Slow and CPU intensive). Default value is false.
    CronExp string
    A valid CRON expression that you can use to control backup frequency. Eg: "0 0 12 * * ? *", "0 0 2 ? * MON-SAT *". Note: please use 7 character format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year. Also, 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 and in Cronexp package readme.
    Enabled bool
    Flag to enable or disable the backup config. Default value is true.
    ExcludeNewRepositories bool
    When set, new repositories will not be automatically added to the backup. Default value is false.
    ExcludedRepositories List<string>
    A list of excluded repositories from the backup. Default is empty list.
    ExportMissionControl bool
    When set to true, mission control will not be automatically added to the backup. Default value is false.
    Key string
    The unique ID of the artifactory backup config.
    RetentionPeriodHours int
    The number of hours to keep a backup before Artifactory will clean it up to free up disk space. Applicable only to non-incremental backups. Default value is 168 hours ie: 7 days.
    SendMailOnError bool
    If set, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is true.
    VerifyDiskSpace bool
    If set, Artifactory will verify that the backup target location has enough disk space available to hold the backed up data. If there is not enough space available, Artifactory will abort the backup and write a message in the log file. Applicable only to non-incremental backups.
    CreateArchive bool
    If set, backups will be created within a Zip archive (Slow and CPU intensive). Default value is false.
    CronExp string
    A valid CRON expression that you can use to control backup frequency. Eg: "0 0 12 * * ? *", "0 0 2 ? * MON-SAT *". Note: please use 7 character format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year. Also, 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 and in Cronexp package readme.
    Enabled bool
    Flag to enable or disable the backup config. Default value is true.
    ExcludeNewRepositories bool
    When set, new repositories will not be automatically added to the backup. Default value is false.
    ExcludedRepositories []string
    A list of excluded repositories from the backup. Default is empty list.
    ExportMissionControl bool
    When set to true, mission control will not be automatically added to the backup. Default value is false.
    Key string
    The unique ID of the artifactory backup config.
    RetentionPeriodHours int
    The number of hours to keep a backup before Artifactory will clean it up to free up disk space. Applicable only to non-incremental backups. Default value is 168 hours ie: 7 days.
    SendMailOnError bool
    If set, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is true.
    VerifyDiskSpace bool
    If set, Artifactory will verify that the backup target location has enough disk space available to hold the backed up data. If there is not enough space available, Artifactory will abort the backup and write a message in the log file. Applicable only to non-incremental backups.
    createArchive Boolean
    If set, backups will be created within a Zip archive (Slow and CPU intensive). Default value is false.
    cronExp String
    A valid CRON expression that you can use to control backup frequency. Eg: "0 0 12 * * ? *", "0 0 2 ? * MON-SAT *". Note: please use 7 character format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year. Also, 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 and in Cronexp package readme.
    enabled Boolean
    Flag to enable or disable the backup config. Default value is true.
    excludeNewRepositories Boolean
    When set, new repositories will not be automatically added to the backup. Default value is false.
    excludedRepositories List<String>
    A list of excluded repositories from the backup. Default is empty list.
    exportMissionControl Boolean
    When set to true, mission control will not be automatically added to the backup. Default value is false.
    key String
    The unique ID of the artifactory backup config.
    retentionPeriodHours Integer
    The number of hours to keep a backup before Artifactory will clean it up to free up disk space. Applicable only to non-incremental backups. Default value is 168 hours ie: 7 days.
    sendMailOnError Boolean
    If set, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is true.
    verifyDiskSpace Boolean
    If set, Artifactory will verify that the backup target location has enough disk space available to hold the backed up data. If there is not enough space available, Artifactory will abort the backup and write a message in the log file. Applicable only to non-incremental backups.
    createArchive boolean
    If set, backups will be created within a Zip archive (Slow and CPU intensive). Default value is false.
    cronExp string
    A valid CRON expression that you can use to control backup frequency. Eg: "0 0 12 * * ? *", "0 0 2 ? * MON-SAT *". Note: please use 7 character format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year. Also, 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 and in Cronexp package readme.
    enabled boolean
    Flag to enable or disable the backup config. Default value is true.
    excludeNewRepositories boolean
    When set, new repositories will not be automatically added to the backup. Default value is false.
    excludedRepositories string[]
    A list of excluded repositories from the backup. Default is empty list.
    exportMissionControl boolean
    When set to true, mission control will not be automatically added to the backup. Default value is false.
    key string
    The unique ID of the artifactory backup config.
    retentionPeriodHours number
    The number of hours to keep a backup before Artifactory will clean it up to free up disk space. Applicable only to non-incremental backups. Default value is 168 hours ie: 7 days.
    sendMailOnError boolean
    If set, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is true.
    verifyDiskSpace boolean
    If set, Artifactory will verify that the backup target location has enough disk space available to hold the backed up data. If there is not enough space available, Artifactory will abort the backup and write a message in the log file. Applicable only to non-incremental backups.
    create_archive bool
    If set, backups will be created within a Zip archive (Slow and CPU intensive). Default value is false.
    cron_exp str
    A valid CRON expression that you can use to control backup frequency. Eg: "0 0 12 * * ? *", "0 0 2 ? * MON-SAT *". Note: please use 7 character format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year. Also, 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 and in Cronexp package readme.
    enabled bool
    Flag to enable or disable the backup config. Default value is true.
    exclude_new_repositories bool
    When set, new repositories will not be automatically added to the backup. Default value is false.
    excluded_repositories Sequence[str]
    A list of excluded repositories from the backup. Default is empty list.
    export_mission_control bool
    When set to true, mission control will not be automatically added to the backup. Default value is false.
    key str
    The unique ID of the artifactory backup config.
    retention_period_hours int
    The number of hours to keep a backup before Artifactory will clean it up to free up disk space. Applicable only to non-incremental backups. Default value is 168 hours ie: 7 days.
    send_mail_on_error bool
    If set, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is true.
    verify_disk_space bool
    If set, Artifactory will verify that the backup target location has enough disk space available to hold the backed up data. If there is not enough space available, Artifactory will abort the backup and write a message in the log file. Applicable only to non-incremental backups.
    createArchive Boolean
    If set, backups will be created within a Zip archive (Slow and CPU intensive). Default value is false.
    cronExp String
    A valid CRON expression that you can use to control backup frequency. Eg: "0 0 12 * * ? *", "0 0 2 ? * MON-SAT *". Note: please use 7 character format - Seconds, Minutes Hours, Day Of Month, Month, Day Of Week, Year. Also, 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 and in Cronexp package readme.
    enabled Boolean
    Flag to enable or disable the backup config. Default value is true.
    excludeNewRepositories Boolean
    When set, new repositories will not be automatically added to the backup. Default value is false.
    excludedRepositories List<String>
    A list of excluded repositories from the backup. Default is empty list.
    exportMissionControl Boolean
    When set to true, mission control will not be automatically added to the backup. Default value is false.
    key String
    The unique ID of the artifactory backup config.
    retentionPeriodHours Number
    The number of hours to keep a backup before Artifactory will clean it up to free up disk space. Applicable only to non-incremental backups. Default value is 168 hours ie: 7 days.
    sendMailOnError Boolean
    If set, all Artifactory administrators will be notified by email if any problem is encountered during backup. Default value is true.
    verifyDiskSpace Boolean
    If set, Artifactory will verify that the backup target location has enough disk space available to hold the backed up data. If there is not enough space available, Artifactory will abort the backup and write a message in the log file. Applicable only to non-incremental backups.

    Import

    Backup config can be imported using the key, e.g.

    $ pulumi import artifactory:index/backup:Backup backup_name backup_name

    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
    pulumi/pulumi-artifactory