com.pulumi.gcp.netapp.kotlin.BackupPolicy.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-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.gcp.netapp.kotlin
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 kotlin.collections.Map
/**
* Builder for [BackupPolicy].
*/
@PulumiTagMarker
public class BackupPolicyResourceBuilder internal constructor() {
public var name: String? = null
public var args: BackupPolicyArgs = BackupPolicyArgs()
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 BackupPolicyArgsBuilder.() -> Unit) {
val builder = BackupPolicyArgsBuilder()
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(): BackupPolicy {
val builtJavaResource = com.pulumi.gcp.netapp.BackupPolicy(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return BackupPolicy(builtJavaResource)
}
}
/**
* A backup policy is used to schedule backups at regular daily, weekly, or monthly intervals.
* Backup policies allow you to attach a backup schedule to a volume.
* The policy defines how many backups to retain at daily, weekly, or monthly intervals.
* To get more information about backupPolicy, see:
* * [API documentation](https://cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.backupPolicies)
* * How-to Guides
* * [Documentation](https://cloud.google.com/netapp/volumes/docs/protect-data/about-volume-backups#about_backup_policies)
* ## Example Usage
* ### Netapp Backup Policy Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const testBackupPolicyFull = new gcp.netapp.BackupPolicy("test_backup_policy_full", {
* name: "test-backup-policy-full",
* location: "us-central1",
* dailyBackupLimit: 2,
* weeklyBackupLimit: 1,
* monthlyBackupLimit: 1,
* description: "TF test backup schedule",
* enabled: true,
* labels: {
* foo: "bar",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* test_backup_policy_full = gcp.netapp.BackupPolicy("test_backup_policy_full",
* name="test-backup-policy-full",
* location="us-central1",
* daily_backup_limit=2,
* weekly_backup_limit=1,
* monthly_backup_limit=1,
* description="TF test backup schedule",
* enabled=True,
* labels={
* "foo": "bar",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var testBackupPolicyFull = new Gcp.Netapp.BackupPolicy("test_backup_policy_full", new()
* {
* Name = "test-backup-policy-full",
* Location = "us-central1",
* DailyBackupLimit = 2,
* WeeklyBackupLimit = 1,
* MonthlyBackupLimit = 1,
* Description = "TF test backup schedule",
* Enabled = true,
* Labels =
* {
* { "foo", "bar" },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/netapp"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := netapp.NewBackupPolicy(ctx, "test_backup_policy_full", &netapp.BackupPolicyArgs{
* Name: pulumi.String("test-backup-policy-full"),
* Location: pulumi.String("us-central1"),
* DailyBackupLimit: pulumi.Int(2),
* WeeklyBackupLimit: pulumi.Int(1),
* MonthlyBackupLimit: pulumi.Int(1),
* Description: pulumi.String("TF test backup schedule"),
* Enabled: pulumi.Bool(true),
* Labels: pulumi.StringMap{
* "foo": pulumi.String("bar"),
* },
* })
* 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.gcp.netapp.BackupPolicy;
* import com.pulumi.gcp.netapp.BackupPolicyArgs;
* 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 testBackupPolicyFull = new BackupPolicy("testBackupPolicyFull", BackupPolicyArgs.builder()
* .name("test-backup-policy-full")
* .location("us-central1")
* .dailyBackupLimit(2)
* .weeklyBackupLimit(1)
* .monthlyBackupLimit(1)
* .description("TF test backup schedule")
* .enabled(true)
* .labels(Map.of("foo", "bar"))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* testBackupPolicyFull:
* type: gcp:netapp:BackupPolicy
* name: test_backup_policy_full
* properties:
* name: test-backup-policy-full
* location: us-central1
* dailyBackupLimit: 2
* weeklyBackupLimit: 1
* monthlyBackupLimit: 1
* description: TF test backup schedule
* enabled: true
* labels:
* foo: bar
* ```
*
* ## Import
* backupPolicy can be imported using any of these accepted formats:
* * `projects/{{project}}/locations/{{location}}/backupPolicies/{{name}}`
* * `{{project}}/{{location}}/{{name}}`
* * `{{location}}/{{name}}`
* When using the `pulumi import` command, backupPolicy can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:netapp/backupPolicy:BackupPolicy default projects/{{project}}/locations/{{location}}/backupPolicies/{{name}}
* ```
* ```sh
* $ pulumi import gcp:netapp/backupPolicy:BackupPolicy default {{project}}/{{location}}/{{name}}
* ```
* ```sh
* $ pulumi import gcp:netapp/backupPolicy:BackupPolicy default {{location}}/{{name}}
* ```
*/
public class BackupPolicy internal constructor(
override val javaResource: com.pulumi.gcp.netapp.BackupPolicy,
) : KotlinCustomResource(javaResource, BackupPolicyMapper) {
/**
* The total number of volumes assigned by this backup policy.
*/
public val assignedVolumeCount: Output
get() = javaResource.assignedVolumeCount().applyValue({ args0 -> args0 })
/**
* Create time of the backup policy. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
*/
public val createTime: Output
get() = javaResource.createTime().applyValue({ args0 -> args0 })
/**
* Number of daily backups to keep. Note that the minimum daily backup limit is 2.
*/
public val dailyBackupLimit: Output
get() = javaResource.dailyBackupLimit().applyValue({ args0 -> args0 })
/**
* An optional description of this resource.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
public val effectiveLabels: Output>
get() = javaResource.effectiveLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* If enabled, make backups automatically according to the schedules.
* This will be applied to all volumes that have this policy attached and enforced on volume level.
*/
public val enabled: Output?
get() = javaResource.enabled().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Labels as key value pairs. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }`.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effective_labels` for all of the labels present on the resource.
*/
public val labels: Output>?
get() = javaResource.labels().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* Name of the region for the policy to apply to.
*/
public val location: Output
get() = javaResource.location().applyValue({ args0 -> args0 })
/**
* Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
*/
public val monthlyBackupLimit: Output
get() = javaResource.monthlyBackupLimit().applyValue({ args0 -> args0 })
/**
* The name of the backup policy. Needs to be unique per location.
* - - -
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
public val project: Output
get() = javaResource.project().applyValue({ args0 -> args0 })
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
public val pulumiLabels: Output>
get() = javaResource.pulumiLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* The state of the backup policy.
*/
public val state: Output
get() = javaResource.state().applyValue({ args0 -> args0 })
/**
* Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
*/
public val weeklyBackupLimit: Output
get() = javaResource.weeklyBackupLimit().applyValue({ args0 -> args0 })
}
public object BackupPolicyMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.netapp.BackupPolicy::class == javaResource::class
override fun map(javaResource: Resource): BackupPolicy = BackupPolicy(
javaResource as
com.pulumi.gcp.netapp.BackupPolicy,
)
}
/**
* @see [BackupPolicy].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [BackupPolicy].
*/
public suspend fun backupPolicy(
name: String,
block: suspend BackupPolicyResourceBuilder.() -> Unit,
): BackupPolicy {
val builder = BackupPolicyResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [BackupPolicy].
* @param name The _unique_ name of the resulting resource.
*/
public fun backupPolicy(name: String): BackupPolicy {
val builder = BackupPolicyResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy