All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.backup.kotlin.ProtectedFileShareArgs.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.backup.kotlin

import com.pulumi.azure.backup.ProtectedFileShareArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 * Manages an Azure Backup Protected File Share to enable backups for file shares within an Azure Storage Account
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azure from "@pulumi/azure";
 * const example = new azure.core.ResourceGroup("example", {
 *     name: "tfex-recovery_vault",
 *     location: "West Europe",
 * });
 * const vault = new azure.recoveryservices.Vault("vault", {
 *     name: "tfex-recovery-vault",
 *     location: example.location,
 *     resourceGroupName: example.name,
 *     sku: "Standard",
 * });
 * const sa = new azure.storage.Account("sa", {
 *     name: "examplesa",
 *     location: example.location,
 *     resourceGroupName: example.name,
 *     accountTier: "Standard",
 *     accountReplicationType: "LRS",
 * });
 * const exampleShare = new azure.storage.Share("example", {
 *     name: "example-share",
 *     storageAccountName: sa.name,
 *     quota: 1,
 * });
 * const protection_container = new azure.backup.ContainerStorageAccount("protection-container", {
 *     resourceGroupName: example.name,
 *     recoveryVaultName: vault.name,
 *     storageAccountId: sa.id,
 * });
 * const examplePolicyFileShare = new azure.backup.PolicyFileShare("example", {
 *     name: "tfex-recovery-vault-policy",
 *     resourceGroupName: example.name,
 *     recoveryVaultName: vault.name,
 *     backup: {
 *         frequency: "Daily",
 *         time: "23:00",
 *     },
 *     retentionDaily: {
 *         count: 10,
 *     },
 * });
 * const share1 = new azure.backup.ProtectedFileShare("share1", {
 *     resourceGroupName: example.name,
 *     recoveryVaultName: vault.name,
 *     sourceStorageAccountId: protection_container.storageAccountId,
 *     sourceFileShareName: exampleShare.name,
 *     backupPolicyId: examplePolicyFileShare.id,
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example = azure.core.ResourceGroup("example",
 *     name="tfex-recovery_vault",
 *     location="West Europe")
 * vault = azure.recoveryservices.Vault("vault",
 *     name="tfex-recovery-vault",
 *     location=example.location,
 *     resource_group_name=example.name,
 *     sku="Standard")
 * sa = azure.storage.Account("sa",
 *     name="examplesa",
 *     location=example.location,
 *     resource_group_name=example.name,
 *     account_tier="Standard",
 *     account_replication_type="LRS")
 * example_share = azure.storage.Share("example",
 *     name="example-share",
 *     storage_account_name=sa.name,
 *     quota=1)
 * protection_container = azure.backup.ContainerStorageAccount("protection-container",
 *     resource_group_name=example.name,
 *     recovery_vault_name=vault.name,
 *     storage_account_id=sa.id)
 * example_policy_file_share = azure.backup.PolicyFileShare("example",
 *     name="tfex-recovery-vault-policy",
 *     resource_group_name=example.name,
 *     recovery_vault_name=vault.name,
 *     backup={
 *         "frequency": "Daily",
 *         "time": "23:00",
 *     },
 *     retention_daily={
 *         "count": 10,
 *     })
 * share1 = azure.backup.ProtectedFileShare("share1",
 *     resource_group_name=example.name,
 *     recovery_vault_name=vault.name,
 *     source_storage_account_id=protection_container.storage_account_id,
 *     source_file_share_name=example_share.name,
 *     backup_policy_id=example_policy_file_share.id)
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Azure = Pulumi.Azure;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Azure.Core.ResourceGroup("example", new()
 *     {
 *         Name = "tfex-recovery_vault",
 *         Location = "West Europe",
 *     });
 *     var vault = new Azure.RecoveryServices.Vault("vault", new()
 *     {
 *         Name = "tfex-recovery-vault",
 *         Location = example.Location,
 *         ResourceGroupName = example.Name,
 *         Sku = "Standard",
 *     });
 *     var sa = new Azure.Storage.Account("sa", new()
 *     {
 *         Name = "examplesa",
 *         Location = example.Location,
 *         ResourceGroupName = example.Name,
 *         AccountTier = "Standard",
 *         AccountReplicationType = "LRS",
 *     });
 *     var exampleShare = new Azure.Storage.Share("example", new()
 *     {
 *         Name = "example-share",
 *         StorageAccountName = sa.Name,
 *         Quota = 1,
 *     });
 *     var protection_container = new Azure.Backup.ContainerStorageAccount("protection-container", new()
 *     {
 *         ResourceGroupName = example.Name,
 *         RecoveryVaultName = vault.Name,
 *         StorageAccountId = sa.Id,
 *     });
 *     var examplePolicyFileShare = new Azure.Backup.PolicyFileShare("example", new()
 *     {
 *         Name = "tfex-recovery-vault-policy",
 *         ResourceGroupName = example.Name,
 *         RecoveryVaultName = vault.Name,
 *         Backup = new Azure.Backup.Inputs.PolicyFileShareBackupArgs
 *         {
 *             Frequency = "Daily",
 *             Time = "23:00",
 *         },
 *         RetentionDaily = new Azure.Backup.Inputs.PolicyFileShareRetentionDailyArgs
 *         {
 *             Count = 10,
 *         },
 *     });
 *     var share1 = new Azure.Backup.ProtectedFileShare("share1", new()
 *     {
 *         ResourceGroupName = example.Name,
 *         RecoveryVaultName = vault.Name,
 *         SourceStorageAccountId = protection_container.StorageAccountId,
 *         SourceFileShareName = exampleShare.Name,
 *         BackupPolicyId = examplePolicyFileShare.Id,
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/backup"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/recoveryservices"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
 * 			Name:     pulumi.String("tfex-recovery_vault"),
 * 			Location: pulumi.String("West Europe"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		vault, err := recoveryservices.NewVault(ctx, "vault", &recoveryservices.VaultArgs{
 * 			Name:              pulumi.String("tfex-recovery-vault"),
 * 			Location:          example.Location,
 * 			ResourceGroupName: example.Name,
 * 			Sku:               pulumi.String("Standard"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		sa, err := storage.NewAccount(ctx, "sa", &storage.AccountArgs{
 * 			Name:                   pulumi.String("examplesa"),
 * 			Location:               example.Location,
 * 			ResourceGroupName:      example.Name,
 * 			AccountTier:            pulumi.String("Standard"),
 * 			AccountReplicationType: pulumi.String("LRS"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		exampleShare, err := storage.NewShare(ctx, "example", &storage.ShareArgs{
 * 			Name:               pulumi.String("example-share"),
 * 			StorageAccountName: sa.Name,
 * 			Quota:              pulumi.Int(1),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = backup.NewContainerStorageAccount(ctx, "protection-container", &backup.ContainerStorageAccountArgs{
 * 			ResourceGroupName: example.Name,
 * 			RecoveryVaultName: vault.Name,
 * 			StorageAccountId:  sa.ID(),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		examplePolicyFileShare, err := backup.NewPolicyFileShare(ctx, "example", &backup.PolicyFileShareArgs{
 * 			Name:              pulumi.String("tfex-recovery-vault-policy"),
 * 			ResourceGroupName: example.Name,
 * 			RecoveryVaultName: vault.Name,
 * 			Backup: &backup.PolicyFileShareBackupArgs{
 * 				Frequency: pulumi.String("Daily"),
 * 				Time:      pulumi.String("23:00"),
 * 			},
 * 			RetentionDaily: &backup.PolicyFileShareRetentionDailyArgs{
 * 				Count: pulumi.Int(10),
 * 			},
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = backup.NewProtectedFileShare(ctx, "share1", &backup.ProtectedFileShareArgs{
 * 			ResourceGroupName:      example.Name,
 * 			RecoveryVaultName:      vault.Name,
 * 			SourceStorageAccountId: protection_container.StorageAccountId,
 * 			SourceFileShareName:    exampleShare.Name,
 * 			BackupPolicyId:         examplePolicyFileShare.ID(),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		return nil
 * 	})
 * }
 * ```
 * ```java
 * package generated_program;
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.azure.core.ResourceGroup;
 * import com.pulumi.azure.core.ResourceGroupArgs;
 * import com.pulumi.azure.recoveryservices.Vault;
 * import com.pulumi.azure.recoveryservices.VaultArgs;
 * import com.pulumi.azure.storage.Account;
 * import com.pulumi.azure.storage.AccountArgs;
 * import com.pulumi.azure.storage.Share;
 * import com.pulumi.azure.storage.ShareArgs;
 * import com.pulumi.azure.backup.ContainerStorageAccount;
 * import com.pulumi.azure.backup.ContainerStorageAccountArgs;
 * import com.pulumi.azure.backup.PolicyFileShare;
 * import com.pulumi.azure.backup.PolicyFileShareArgs;
 * import com.pulumi.azure.backup.inputs.PolicyFileShareBackupArgs;
 * import com.pulumi.azure.backup.inputs.PolicyFileShareRetentionDailyArgs;
 * import com.pulumi.azure.backup.ProtectedFileShare;
 * import com.pulumi.azure.backup.ProtectedFileShareArgs;
 * import java.util.List;
 * import java.util.ArrayList;
 * import java.util.Map;
 * import java.io.File;
 * import java.nio.file.Files;
 * import java.nio.file.Paths;
 * public class App {
 *     public static void main(String[] args) {
 *         Pulumi.run(App::stack);
 *     }
 *     public static void stack(Context ctx) {
 *         var example = new ResourceGroup("example", ResourceGroupArgs.builder()
 *             .name("tfex-recovery_vault")
 *             .location("West Europe")
 *             .build());
 *         var vault = new Vault("vault", VaultArgs.builder()
 *             .name("tfex-recovery-vault")
 *             .location(example.location())
 *             .resourceGroupName(example.name())
 *             .sku("Standard")
 *             .build());
 *         var sa = new Account("sa", AccountArgs.builder()
 *             .name("examplesa")
 *             .location(example.location())
 *             .resourceGroupName(example.name())
 *             .accountTier("Standard")
 *             .accountReplicationType("LRS")
 *             .build());
 *         var exampleShare = new Share("exampleShare", ShareArgs.builder()
 *             .name("example-share")
 *             .storageAccountName(sa.name())
 *             .quota(1)
 *             .build());
 *         var protection_container = new ContainerStorageAccount("protection-container", ContainerStorageAccountArgs.builder()
 *             .resourceGroupName(example.name())
 *             .recoveryVaultName(vault.name())
 *             .storageAccountId(sa.id())
 *             .build());
 *         var examplePolicyFileShare = new PolicyFileShare("examplePolicyFileShare", PolicyFileShareArgs.builder()
 *             .name("tfex-recovery-vault-policy")
 *             .resourceGroupName(example.name())
 *             .recoveryVaultName(vault.name())
 *             .backup(PolicyFileShareBackupArgs.builder()
 *                 .frequency("Daily")
 *                 .time("23:00")
 *                 .build())
 *             .retentionDaily(PolicyFileShareRetentionDailyArgs.builder()
 *                 .count(10)
 *                 .build())
 *             .build());
 *         var share1 = new ProtectedFileShare("share1", ProtectedFileShareArgs.builder()
 *             .resourceGroupName(example.name())
 *             .recoveryVaultName(vault.name())
 *             .sourceStorageAccountId(protection_container.storageAccountId())
 *             .sourceFileShareName(exampleShare.name())
 *             .backupPolicyId(examplePolicyFileShare.id())
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:core:ResourceGroup
 *     properties:
 *       name: tfex-recovery_vault
 *       location: West Europe
 *   vault:
 *     type: azure:recoveryservices:Vault
 *     properties:
 *       name: tfex-recovery-vault
 *       location: ${example.location}
 *       resourceGroupName: ${example.name}
 *       sku: Standard
 *   sa:
 *     type: azure:storage:Account
 *     properties:
 *       name: examplesa
 *       location: ${example.location}
 *       resourceGroupName: ${example.name}
 *       accountTier: Standard
 *       accountReplicationType: LRS
 *   exampleShare:
 *     type: azure:storage:Share
 *     name: example
 *     properties:
 *       name: example-share
 *       storageAccountName: ${sa.name}
 *       quota: 1
 *   protection-container:
 *     type: azure:backup:ContainerStorageAccount
 *     properties:
 *       resourceGroupName: ${example.name}
 *       recoveryVaultName: ${vault.name}
 *       storageAccountId: ${sa.id}
 *   examplePolicyFileShare:
 *     type: azure:backup:PolicyFileShare
 *     name: example
 *     properties:
 *       name: tfex-recovery-vault-policy
 *       resourceGroupName: ${example.name}
 *       recoveryVaultName: ${vault.name}
 *       backup:
 *         frequency: Daily
 *         time: 23:00
 *       retentionDaily:
 *         count: 10
 *   share1:
 *     type: azure:backup:ProtectedFileShare
 *     properties:
 *       resourceGroupName: ${example.name}
 *       recoveryVaultName: ${vault.name}
 *       sourceStorageAccountId: ${["protection-container"].storageAccountId}
 *       sourceFileShareName: ${exampleShare.name}
 *       backupPolicyId: ${examplePolicyFileShare.id}
 * ```
 * 
 * ## Import
 * Azure Backup Protected File Shares can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:backup/protectedFileShare:ProtectedFileShare item1 "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.RecoveryServices/vaults/example-recovery-vault/backupFabrics/Azure/protectionContainers/StorageContainer;storage;group2;example-storage-account/protectedItems/AzureFileShare;3f6e3108a45793581bcbd1c61c87a3b2ceeb4ff4bc02a95ce9d1022b23722935"
 * ```
 * -> **NOTE** The ID requires quoting as there are semicolons. This user unfriendly ID can be found in the Deployments of the used resourcegroup, look for an Deployment which starts with `ConfigureAFSProtection-`, click then `Go to resource`.
 * @property backupPolicyId Specifies the ID of the backup policy to use. The policy must be an Azure File Share backup policy. Other types are not supported.
 * @property recoveryVaultName Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
 * @property resourceGroupName The name of the resource group in which to create the Azure Backup Protected File Share. Changing this forces a new resource to be created.
 * @property sourceFileShareName Specifies the name of the file share to backup. Changing this forces a new resource to be created.
 * @property sourceStorageAccountId Specifies the ID of the storage account of the file share to backup. Changing this forces a new resource to be created.
 * > **NOTE** The storage account must already be registered with the recovery vault in order to backup shares within the account. You can use the `azure.backup.ContainerStorageAccount` resource or the [Register-AzRecoveryServicesBackupContainer PowerShell cmdlet](https://docs.microsoft.com/powershell/module/az.recoveryservices/register-azrecoveryservicesbackupcontainer?view=azps-3.2.0) to register a storage account with a vault. When using the `azure.backup.ContainerStorageAccount` resource to register, you can use `depends_on` to explicitly declare the dependency. It will make sure that the registration is completed before creating the `azure.backup.ProtectedFileShare` resource.
 */
public data class ProtectedFileShareArgs(
    public val backupPolicyId: Output? = null,
    public val recoveryVaultName: Output? = null,
    public val resourceGroupName: Output? = null,
    public val sourceFileShareName: Output? = null,
    public val sourceStorageAccountId: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.azure.backup.ProtectedFileShareArgs =
        com.pulumi.azure.backup.ProtectedFileShareArgs.builder()
            .backupPolicyId(backupPolicyId?.applyValue({ args0 -> args0 }))
            .recoveryVaultName(recoveryVaultName?.applyValue({ args0 -> args0 }))
            .resourceGroupName(resourceGroupName?.applyValue({ args0 -> args0 }))
            .sourceFileShareName(sourceFileShareName?.applyValue({ args0 -> args0 }))
            .sourceStorageAccountId(sourceStorageAccountId?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [ProtectedFileShareArgs].
 */
@PulumiTagMarker
public class ProtectedFileShareArgsBuilder internal constructor() {
    private var backupPolicyId: Output? = null

    private var recoveryVaultName: Output? = null

    private var resourceGroupName: Output? = null

    private var sourceFileShareName: Output? = null

    private var sourceStorageAccountId: Output? = null

    /**
     * @param value Specifies the ID of the backup policy to use. The policy must be an Azure File Share backup policy. Other types are not supported.
     */
    @JvmName("gjbeswjghdjtbncb")
    public suspend fun backupPolicyId(`value`: Output) {
        this.backupPolicyId = value
    }

    /**
     * @param value Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
     */
    @JvmName("ekejnnsyamnxkyjn")
    public suspend fun recoveryVaultName(`value`: Output) {
        this.recoveryVaultName = value
    }

    /**
     * @param value The name of the resource group in which to create the Azure Backup Protected File Share. Changing this forces a new resource to be created.
     */
    @JvmName("djrtuudvletcuvaj")
    public suspend fun resourceGroupName(`value`: Output) {
        this.resourceGroupName = value
    }

    /**
     * @param value Specifies the name of the file share to backup. Changing this forces a new resource to be created.
     */
    @JvmName("foalsgjbjtwrowru")
    public suspend fun sourceFileShareName(`value`: Output) {
        this.sourceFileShareName = value
    }

    /**
     * @param value Specifies the ID of the storage account of the file share to backup. Changing this forces a new resource to be created.
     * > **NOTE** The storage account must already be registered with the recovery vault in order to backup shares within the account. You can use the `azure.backup.ContainerStorageAccount` resource or the [Register-AzRecoveryServicesBackupContainer PowerShell cmdlet](https://docs.microsoft.com/powershell/module/az.recoveryservices/register-azrecoveryservicesbackupcontainer?view=azps-3.2.0) to register a storage account with a vault. When using the `azure.backup.ContainerStorageAccount` resource to register, you can use `depends_on` to explicitly declare the dependency. It will make sure that the registration is completed before creating the `azure.backup.ProtectedFileShare` resource.
     */
    @JvmName("npqicfuamqnnahnl")
    public suspend fun sourceStorageAccountId(`value`: Output) {
        this.sourceStorageAccountId = value
    }

    /**
     * @param value Specifies the ID of the backup policy to use. The policy must be an Azure File Share backup policy. Other types are not supported.
     */
    @JvmName("widblbwwjfktvuaa")
    public suspend fun backupPolicyId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.backupPolicyId = mapped
    }

    /**
     * @param value Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
     */
    @JvmName("obulqtjpmfipevya")
    public suspend fun recoveryVaultName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.recoveryVaultName = mapped
    }

    /**
     * @param value The name of the resource group in which to create the Azure Backup Protected File Share. Changing this forces a new resource to be created.
     */
    @JvmName("snyxjosmdkerbvjl")
    public suspend fun resourceGroupName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.resourceGroupName = mapped
    }

    /**
     * @param value Specifies the name of the file share to backup. Changing this forces a new resource to be created.
     */
    @JvmName("eaxiarywrfacmbjl")
    public suspend fun sourceFileShareName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.sourceFileShareName = mapped
    }

    /**
     * @param value Specifies the ID of the storage account of the file share to backup. Changing this forces a new resource to be created.
     * > **NOTE** The storage account must already be registered with the recovery vault in order to backup shares within the account. You can use the `azure.backup.ContainerStorageAccount` resource or the [Register-AzRecoveryServicesBackupContainer PowerShell cmdlet](https://docs.microsoft.com/powershell/module/az.recoveryservices/register-azrecoveryservicesbackupcontainer?view=azps-3.2.0) to register a storage account with a vault. When using the `azure.backup.ContainerStorageAccount` resource to register, you can use `depends_on` to explicitly declare the dependency. It will make sure that the registration is completed before creating the `azure.backup.ProtectedFileShare` resource.
     */
    @JvmName("wsvksshbpvljtqrp")
    public suspend fun sourceStorageAccountId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.sourceStorageAccountId = mapped
    }

    internal fun build(): ProtectedFileShareArgs = ProtectedFileShareArgs(
        backupPolicyId = backupPolicyId,
        recoveryVaultName = recoveryVaultName,
        resourceGroupName = resourceGroupName,
        sourceFileShareName = sourceFileShareName,
        sourceStorageAccountId = sourceStorageAccountId,
    )
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy