com.pulumi.azure.backup.kotlin.PolicyVM.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Show all versions of pulumi-azure-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.backup.kotlin
import com.pulumi.azure.backup.kotlin.outputs.PolicyVMBackup
import com.pulumi.azure.backup.kotlin.outputs.PolicyVMInstantRestoreResourceGroup
import com.pulumi.azure.backup.kotlin.outputs.PolicyVMRetentionDaily
import com.pulumi.azure.backup.kotlin.outputs.PolicyVMRetentionMonthly
import com.pulumi.azure.backup.kotlin.outputs.PolicyVMRetentionWeekly
import com.pulumi.azure.backup.kotlin.outputs.PolicyVMRetentionYearly
import com.pulumi.azure.backup.kotlin.outputs.PolicyVMTieringPolicy
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import com.pulumi.azure.backup.kotlin.outputs.PolicyVMBackup.Companion.toKotlin as policyVMBackupToKotlin
import com.pulumi.azure.backup.kotlin.outputs.PolicyVMInstantRestoreResourceGroup.Companion.toKotlin as policyVMInstantRestoreResourceGroupToKotlin
import com.pulumi.azure.backup.kotlin.outputs.PolicyVMRetentionDaily.Companion.toKotlin as policyVMRetentionDailyToKotlin
import com.pulumi.azure.backup.kotlin.outputs.PolicyVMRetentionMonthly.Companion.toKotlin as policyVMRetentionMonthlyToKotlin
import com.pulumi.azure.backup.kotlin.outputs.PolicyVMRetentionWeekly.Companion.toKotlin as policyVMRetentionWeeklyToKotlin
import com.pulumi.azure.backup.kotlin.outputs.PolicyVMRetentionYearly.Companion.toKotlin as policyVMRetentionYearlyToKotlin
import com.pulumi.azure.backup.kotlin.outputs.PolicyVMTieringPolicy.Companion.toKotlin as policyVMTieringPolicyToKotlin
/**
* Builder for [PolicyVM].
*/
@PulumiTagMarker
public class PolicyVMResourceBuilder internal constructor() {
public var name: String? = null
public var args: PolicyVMArgs = PolicyVMArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend PolicyVMArgsBuilder.() -> Unit) {
val builder = PolicyVMArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): PolicyVM {
val builtJavaResource = com.pulumi.azure.backup.PolicyVM(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return PolicyVM(builtJavaResource)
}
}
/**
* Manages an Azure Backup VM Backup Policy.
* ## 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 exampleVault = new azure.recoveryservices.Vault("example", {
* name: "tfex-recovery-vault",
* location: example.location,
* resourceGroupName: example.name,
* sku: "Standard",
* });
* const examplePolicyVM = new azure.backup.PolicyVM("example", {
* name: "tfex-recovery-vault-policy",
* resourceGroupName: example.name,
* recoveryVaultName: exampleVault.name,
* timezone: "UTC",
* backup: {
* frequency: "Daily",
* time: "23:00",
* },
* retentionDaily: {
* count: 10,
* },
* retentionWeekly: {
* count: 42,
* weekdays: [
* "Sunday",
* "Wednesday",
* "Friday",
* "Saturday",
* ],
* },
* retentionMonthly: {
* count: 7,
* weekdays: [
* "Sunday",
* "Wednesday",
* ],
* weeks: [
* "First",
* "Last",
* ],
* },
* retentionYearly: {
* count: 77,
* weekdays: ["Sunday"],
* weeks: ["Last"],
* months: ["January"],
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="tfex-recovery_vault",
* location="West Europe")
* example_vault = azure.recoveryservices.Vault("example",
* name="tfex-recovery-vault",
* location=example.location,
* resource_group_name=example.name,
* sku="Standard")
* example_policy_vm = azure.backup.PolicyVM("example",
* name="tfex-recovery-vault-policy",
* resource_group_name=example.name,
* recovery_vault_name=example_vault.name,
* timezone="UTC",
* backup={
* "frequency": "Daily",
* "time": "23:00",
* },
* retention_daily={
* "count": 10,
* },
* retention_weekly={
* "count": 42,
* "weekdays": [
* "Sunday",
* "Wednesday",
* "Friday",
* "Saturday",
* ],
* },
* retention_monthly={
* "count": 7,
* "weekdays": [
* "Sunday",
* "Wednesday",
* ],
* "weeks": [
* "First",
* "Last",
* ],
* },
* retention_yearly={
* "count": 77,
* "weekdays": ["Sunday"],
* "weeks": ["Last"],
* "months": ["January"],
* })
* ```
* ```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 exampleVault = new Azure.RecoveryServices.Vault("example", new()
* {
* Name = "tfex-recovery-vault",
* Location = example.Location,
* ResourceGroupName = example.Name,
* Sku = "Standard",
* });
* var examplePolicyVM = new Azure.Backup.PolicyVM("example", new()
* {
* Name = "tfex-recovery-vault-policy",
* ResourceGroupName = example.Name,
* RecoveryVaultName = exampleVault.Name,
* Timezone = "UTC",
* Backup = new Azure.Backup.Inputs.PolicyVMBackupArgs
* {
* Frequency = "Daily",
* Time = "23:00",
* },
* RetentionDaily = new Azure.Backup.Inputs.PolicyVMRetentionDailyArgs
* {
* Count = 10,
* },
* RetentionWeekly = new Azure.Backup.Inputs.PolicyVMRetentionWeeklyArgs
* {
* Count = 42,
* Weekdays = new[]
* {
* "Sunday",
* "Wednesday",
* "Friday",
* "Saturday",
* },
* },
* RetentionMonthly = new Azure.Backup.Inputs.PolicyVMRetentionMonthlyArgs
* {
* Count = 7,
* Weekdays = new[]
* {
* "Sunday",
* "Wednesday",
* },
* Weeks = new[]
* {
* "First",
* "Last",
* },
* },
* RetentionYearly = new Azure.Backup.Inputs.PolicyVMRetentionYearlyArgs
* {
* Count = 77,
* Weekdays = new[]
* {
* "Sunday",
* },
* Weeks = new[]
* {
* "Last",
* },
* Months = new[]
* {
* "January",
* },
* },
* });
* });
* ```
* ```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/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
* }
* exampleVault, err := recoveryservices.NewVault(ctx, "example", &recoveryservices.VaultArgs{
* Name: pulumi.String("tfex-recovery-vault"),
* Location: example.Location,
* ResourceGroupName: example.Name,
* Sku: pulumi.String("Standard"),
* })
* if err != nil {
* return err
* }
* _, err = backup.NewPolicyVM(ctx, "example", &backup.PolicyVMArgs{
* Name: pulumi.String("tfex-recovery-vault-policy"),
* ResourceGroupName: example.Name,
* RecoveryVaultName: exampleVault.Name,
* Timezone: pulumi.String("UTC"),
* Backup: &backup.PolicyVMBackupArgs{
* Frequency: pulumi.String("Daily"),
* Time: pulumi.String("23:00"),
* },
* RetentionDaily: &backup.PolicyVMRetentionDailyArgs{
* Count: pulumi.Int(10),
* },
* RetentionWeekly: &backup.PolicyVMRetentionWeeklyArgs{
* Count: pulumi.Int(42),
* Weekdays: pulumi.StringArray{
* pulumi.String("Sunday"),
* pulumi.String("Wednesday"),
* pulumi.String("Friday"),
* pulumi.String("Saturday"),
* },
* },
* RetentionMonthly: &backup.PolicyVMRetentionMonthlyArgs{
* Count: pulumi.Int(7),
* Weekdays: pulumi.StringArray{
* pulumi.String("Sunday"),
* pulumi.String("Wednesday"),
* },
* Weeks: pulumi.StringArray{
* pulumi.String("First"),
* pulumi.String("Last"),
* },
* },
* RetentionYearly: &backup.PolicyVMRetentionYearlyArgs{
* Count: pulumi.Int(77),
* Weekdays: pulumi.StringArray{
* pulumi.String("Sunday"),
* },
* Weeks: pulumi.StringArray{
* pulumi.String("Last"),
* },
* Months: pulumi.StringArray{
* pulumi.String("January"),
* },
* },
* })
* 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.backup.PolicyVM;
* import com.pulumi.azure.backup.PolicyVMArgs;
* import com.pulumi.azure.backup.inputs.PolicyVMBackupArgs;
* import com.pulumi.azure.backup.inputs.PolicyVMRetentionDailyArgs;
* import com.pulumi.azure.backup.inputs.PolicyVMRetentionWeeklyArgs;
* import com.pulumi.azure.backup.inputs.PolicyVMRetentionMonthlyArgs;
* import com.pulumi.azure.backup.inputs.PolicyVMRetentionYearlyArgs;
* 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 exampleVault = new Vault("exampleVault", VaultArgs.builder()
* .name("tfex-recovery-vault")
* .location(example.location())
* .resourceGroupName(example.name())
* .sku("Standard")
* .build());
* var examplePolicyVM = new PolicyVM("examplePolicyVM", PolicyVMArgs.builder()
* .name("tfex-recovery-vault-policy")
* .resourceGroupName(example.name())
* .recoveryVaultName(exampleVault.name())
* .timezone("UTC")
* .backup(PolicyVMBackupArgs.builder()
* .frequency("Daily")
* .time("23:00")
* .build())
* .retentionDaily(PolicyVMRetentionDailyArgs.builder()
* .count(10)
* .build())
* .retentionWeekly(PolicyVMRetentionWeeklyArgs.builder()
* .count(42)
* .weekdays(
* "Sunday",
* "Wednesday",
* "Friday",
* "Saturday")
* .build())
* .retentionMonthly(PolicyVMRetentionMonthlyArgs.builder()
* .count(7)
* .weekdays(
* "Sunday",
* "Wednesday")
* .weeks(
* "First",
* "Last")
* .build())
* .retentionYearly(PolicyVMRetentionYearlyArgs.builder()
* .count(77)
* .weekdays("Sunday")
* .weeks("Last")
* .months("January")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: tfex-recovery_vault
* location: West Europe
* exampleVault:
* type: azure:recoveryservices:Vault
* name: example
* properties:
* name: tfex-recovery-vault
* location: ${example.location}
* resourceGroupName: ${example.name}
* sku: Standard
* examplePolicyVM:
* type: azure:backup:PolicyVM
* name: example
* properties:
* name: tfex-recovery-vault-policy
* resourceGroupName: ${example.name}
* recoveryVaultName: ${exampleVault.name}
* timezone: UTC
* backup:
* frequency: Daily
* time: 23:00
* retentionDaily:
* count: 10
* retentionWeekly:
* count: 42
* weekdays:
* - Sunday
* - Wednesday
* - Friday
* - Saturday
* retentionMonthly:
* count: 7
* weekdays:
* - Sunday
* - Wednesday
* weeks:
* - First
* - Last
* retentionYearly:
* count: 77
* weekdays:
* - Sunday
* weeks:
* - Last
* months:
* - January
* ```
*
* ## Import
* VM Backup Policies can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:backup/policyVM:PolicyVM policy1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.RecoveryServices/vaults/example-recovery-vault/backupPolicies/policy1
* ```
*/
public class PolicyVM internal constructor(
override val javaResource: com.pulumi.azure.backup.PolicyVM,
) : KotlinCustomResource(javaResource, PolicyVMMapper) {
/**
* Configures the Policy backup frequency, times & days as documented in the `backup` block below.
*/
public val backup: Output
get() = javaResource.backup().applyValue({ args0 ->
args0.let({ args0 ->
policyVMBackupToKotlin(args0)
})
})
/**
* Specifies the instant restore resource group name as documented in the `instant_restore_resource_group` block below.
*/
public val instantRestoreResourceGroup: Output?
get() = javaResource.instantRestoreResourceGroup().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> policyVMInstantRestoreResourceGroupToKotlin(args0) })
}).orElse(null)
})
/**
* Specifies the instant restore retention range in days. Possible values are between `1` and `5` when `policy_type` is `V1`, and `1` to `30` when `policy_type` is `V2`.
* > **NOTE:** `instant_restore_retention_days` **must** be set to `5` if the backup frequency is set to `Weekly`.
*/
public val instantRestoreRetentionDays: Output
get() = javaResource.instantRestoreRetentionDays().applyValue({ args0 -> args0 })
/**
* Specifies the name of the Backup Policy. Changing this forces a new resource to be created.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* Type of the Backup Policy. Possible values are `V1` and `V2` where `V2` stands for the Enhanced Policy. Defaults to `V1`. Changing this forces a new resource to be created.
*/
public val policyType: Output?
get() = javaResource.policyType().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.
*/
public val recoveryVaultName: Output
get() = javaResource.recoveryVaultName().applyValue({ args0 -> args0 })
/**
* The name of the resource group in which to create the policy. Changing this forces a new resource to be created.
*/
public val resourceGroupName: Output
get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })
/**
* Configures the policy daily retention as documented in the `retention_daily` block below. Required when backup frequency is `Daily`.
*/
public val retentionDaily: Output?
get() = javaResource.retentionDaily().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> policyVMRetentionDailyToKotlin(args0) })
}).orElse(null)
})
/**
* Configures the policy monthly retention as documented in the `retention_monthly` block below.
*/
public val retentionMonthly: Output?
get() = javaResource.retentionMonthly().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> policyVMRetentionMonthlyToKotlin(args0) })
}).orElse(null)
})
/**
* Configures the policy weekly retention as documented in the `retention_weekly` block below. Required when backup frequency is `Weekly`.
*/
public val retentionWeekly: Output?
get() = javaResource.retentionWeekly().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> policyVMRetentionWeeklyToKotlin(args0) })
}).orElse(null)
})
/**
* Configures the policy yearly retention as documented in the `retention_yearly` block below.
*/
public val retentionYearly: Output?
get() = javaResource.retentionYearly().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> policyVMRetentionYearlyToKotlin(args0) })
}).orElse(null)
})
/**
* A `tiering_policy` block as defined below.
*/
public val tieringPolicy: Output?
get() = javaResource.tieringPolicy().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> policyVMTieringPolicyToKotlin(args0) })
}).orElse(null)
})
/**
* Specifies the timezone. [the possible values are defined here](https://jackstromberg.com/2017/01/list-of-time-zones-consumed-by-azure/). Defaults to `UTC`
*/
public val timezone: Output?
get() = javaResource.timezone().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
}
public object PolicyVMMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.backup.PolicyVM::class == javaResource::class
override fun map(javaResource: Resource): PolicyVM = PolicyVM(
javaResource as
com.pulumi.azure.backup.PolicyVM,
)
}
/**
* @see [PolicyVM].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [PolicyVM].
*/
public suspend fun policyVM(name: String, block: suspend PolicyVMResourceBuilder.() -> Unit): PolicyVM {
val builder = PolicyVMResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [PolicyVM].
* @param name The _unique_ name of the resulting resource.
*/
public fun policyVM(name: String): PolicyVM {
val builder = PolicyVMResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy