Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Avi Provider
  3. API Docs
  4. Backup
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

avi.Backup

Explore with Pulumi AI

avi logo
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

    <!–

    Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

    –>

    layout: “avi”

    page_title: “Avi: avi.Backup” sidebar_current: “docs-avi-resource-backup” description: |- Creates and manages Avi Backup.

    avi.Backup

    The Backup resource allows the creation and management of Avi Backup

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  foo:
    type: avi:Backup
    properties:
      name: terraform-example-foo
      tenantRef: /api/tenant/?name=admin

    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,
           file_name: Optional[str] = None,
           backup_config_ref: Optional[str] = None,
           backup_id: Optional[str] = None,
           local_file_url: Optional[str] = None,
           remote_file_url: Optional[str] = None,
           scheduler_ref: Optional[str] = None,
           tenant_ref: Optional[str] = None,
           timestamp: Optional[str] = None,
           uuid: Optional[str] = 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: avi: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 Avi.Backup("backupResource", new()
{
    FileName = "string",
    BackupConfigRef = "string",
    BackupId = "string",
    LocalFileUrl = "string",
    RemoteFileUrl = "string",
    SchedulerRef = "string",
    TenantRef = "string",
    Timestamp = "string",
    Uuid = "string",
});

    example, err := avi.NewBackup(ctx, "backupResource", &avi.BackupArgs{
	FileName:        pulumi.String("string"),
	BackupConfigRef: pulumi.String("string"),
	BackupId:        pulumi.String("string"),
	LocalFileUrl:    pulumi.String("string"),
	RemoteFileUrl:   pulumi.String("string"),
	SchedulerRef:    pulumi.String("string"),
	TenantRef:       pulumi.String("string"),
	Timestamp:       pulumi.String("string"),
	Uuid:            pulumi.String("string"),
})

    var backupResource = new Backup("backupResource", BackupArgs.builder()
    .fileName("string")
    .backupConfigRef("string")
    .backupId("string")
    .localFileUrl("string")
    .remoteFileUrl("string")
    .schedulerRef("string")
    .tenantRef("string")
    .timestamp("string")
    .uuid("string")
    .build());

    backup_resource = avi.Backup("backupResource",
    file_name="string",
    backup_config_ref="string",
    backup_id="string",
    local_file_url="string",
    remote_file_url="string",
    scheduler_ref="string",
    tenant_ref="string",
    timestamp="string",
    uuid="string")

    const backupResource = new avi.Backup("backupResource", {
    fileName: "string",
    backupConfigRef: "string",
    backupId: "string",
    localFileUrl: "string",
    remoteFileUrl: "string",
    schedulerRef: "string",
    tenantRef: "string",
    timestamp: "string",
    uuid: "string",
});

    type: avi:Backup
properties:
    backupConfigRef: string
    backupId: string
    fileName: string
    localFileUrl: string
    remoteFileUrl: string
    schedulerRef: string
    tenantRef: string
    timestamp: string
    uuid: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Backup resource accepts the following input properties:

    FileName string
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    BackupConfigRef string
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    BackupId string
    LocalFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RemoteFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SchedulerRef string
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Timestamp string
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FileName string
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    BackupConfigRef string
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    BackupId string
    LocalFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RemoteFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SchedulerRef string
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Timestamp string
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fileName String
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupConfigRef String
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupId String
    localFileUrl String
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    remoteFileUrl String
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerRef String
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    timestamp String
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fileName string
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupConfigRef string
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupId string
    localFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    remoteFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerRef string
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    timestamp string
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    file_name str
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backup_config_ref str
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backup_id str
    local_file_url str
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    remote_file_url str
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    scheduler_ref str
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenant_ref str
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    timestamp str
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fileName String
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupConfigRef String
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupId String
    localFileUrl String
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    remoteFileUrl String
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerRef String
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    timestamp String
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    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,
        backup_config_ref: Optional[str] = None,
        backup_id: Optional[str] = None,
        file_name: Optional[str] = None,
        local_file_url: Optional[str] = None,
        remote_file_url: Optional[str] = None,
        scheduler_ref: Optional[str] = None,
        tenant_ref: Optional[str] = None,
        timestamp: Optional[str] = None,
        uuid: Optional[str] = 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)
    resources:  _:    type: avi:Backup    get:      id: ${id}
    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:
    BackupConfigRef string
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    BackupId string
    FileName string
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    LocalFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RemoteFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SchedulerRef string
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Timestamp string
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    BackupConfigRef string
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    BackupId string
    FileName string
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    LocalFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RemoteFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SchedulerRef string
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Timestamp string
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupConfigRef String
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupId String
    fileName String
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    localFileUrl String
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    remoteFileUrl String
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerRef String
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    timestamp String
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupConfigRef string
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupId string
    fileName string
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    localFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    remoteFileUrl string
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerRef string
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    timestamp string
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backup_config_ref str
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backup_id str
    file_name str
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    local_file_url str
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    remote_file_url str
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    scheduler_ref str
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenant_ref str
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    timestamp str
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupConfigRef String
    Backupconfiguration information. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupId String
    fileName String
    The file name of backup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    localFileUrl String
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    remoteFileUrl String
    Url to download the backup file. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerRef String
    Scheduler information. It is a reference to an object of type scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    timestamp String
    Unix timestamp of when the backup file is created. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    Package Details

    Repository
    avi vmware/terraform-provider-avi
    License
    Notes
    This Pulumi package is based on the avi Terraform Provider.
    avi logo
    avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-avi