pulumi-gcp-kotlin/com.pulumi.gcp.gkebackup.kotlin/BackupPlanArgs

BackupPlanArgs

data class BackupPlanArgs(val backupConfig: Output<BackupPlanBackupConfigArgs>? = null, val backupSchedule: Output<BackupPlanBackupScheduleArgs>? = null, val cluster: Output<String>? = null, val deactivated: Output<Boolean>? = null, val description: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val retentionPolicy: Output<BackupPlanRetentionPolicyArgs>? = null) : ConvertibleToJava<BackupPlanArgs>

Represents a Backup Plan instance. To get more information about BackupPlan, see:

Example Usage

Gkebackup Backupplan Basic

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.container.Cluster;
import com.pulumi.gcp.container.ClusterArgs;
import com.pulumi.gcp.container.inputs.ClusterWorkloadIdentityConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigGkeBackupAgentConfigArgs;
import com.pulumi.gcp.gkebackup.BackupPlan;
import com.pulumi.gcp.gkebackup.BackupPlanArgs;
import com.pulumi.gcp.gkebackup.inputs.BackupPlanBackupConfigArgs;
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 primary = new Cluster("primary", ClusterArgs.builder()
            .location("us-central1")
            .initialNodeCount(1)
            .workloadIdentityConfig(ClusterWorkloadIdentityConfigArgs.builder()
                .workloadPool("my-project-name.svc.id.goog")
                .build())
            .addonsConfig(ClusterAddonsConfigArgs.builder()
                .gkeBackupAgentConfig(ClusterAddonsConfigGkeBackupAgentConfigArgs.builder()
                    .enabled(true)
                    .build())
                .build())
            .build());
        var basic = new BackupPlan("basic", BackupPlanArgs.builder()
            .cluster(primary.id())
            .location("us-central1")
            .backupConfig(BackupPlanBackupConfigArgs.builder()
                .includeVolumeData(true)
                .includeSecrets(true)
                .allNamespaces(true)
                .build())
            .build());
    }
}
Content copied to clipboard

Gkebackup Backupplan Autopilot

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.container.Cluster;
import com.pulumi.gcp.container.ClusterArgs;
import com.pulumi.gcp.container.inputs.ClusterIpAllocationPolicyArgs;
import com.pulumi.gcp.container.inputs.ClusterReleaseChannelArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigGkeBackupAgentConfigArgs;
import com.pulumi.gcp.gkebackup.BackupPlan;
import com.pulumi.gcp.gkebackup.BackupPlanArgs;
import com.pulumi.gcp.gkebackup.inputs.BackupPlanBackupConfigArgs;
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 primary = new Cluster("primary", ClusterArgs.builder()
            .location("us-central1")
            .enableAutopilot(true)
            .ipAllocationPolicy()
            .releaseChannel(ClusterReleaseChannelArgs.builder()
                .channel("RAPID")
                .build())
            .addonsConfig(ClusterAddonsConfigArgs.builder()
                .gkeBackupAgentConfig(ClusterAddonsConfigGkeBackupAgentConfigArgs.builder()
                    .enabled(true)
                    .build())
                .build())
            .build());
        var autopilot = new BackupPlan("autopilot", BackupPlanArgs.builder()
            .cluster(primary.id())
            .location("us-central1")
            .backupConfig(BackupPlanBackupConfigArgs.builder()
                .includeVolumeData(true)
                .includeSecrets(true)
                .allNamespaces(true)
                .build())
            .build());
    }
}
Content copied to clipboard

Gkebackup Backupplan Cmek

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.container.Cluster;
import com.pulumi.gcp.container.ClusterArgs;
import com.pulumi.gcp.container.inputs.ClusterWorkloadIdentityConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigGkeBackupAgentConfigArgs;
import com.pulumi.gcp.kms.KeyRing;
import com.pulumi.gcp.kms.KeyRingArgs;
import com.pulumi.gcp.kms.CryptoKey;
import com.pulumi.gcp.kms.CryptoKeyArgs;
import com.pulumi.gcp.gkebackup.BackupPlan;
import com.pulumi.gcp.gkebackup.BackupPlanArgs;
import com.pulumi.gcp.gkebackup.inputs.BackupPlanBackupConfigArgs;
import com.pulumi.gcp.gkebackup.inputs.BackupPlanBackupConfigSelectedNamespacesArgs;
import com.pulumi.gcp.gkebackup.inputs.BackupPlanBackupConfigEncryptionKeyArgs;
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 primary = new Cluster("primary", ClusterArgs.builder()
            .location("us-central1")
            .initialNodeCount(1)
            .workloadIdentityConfig(ClusterWorkloadIdentityConfigArgs.builder()
                .workloadPool("my-project-name.svc.id.goog")
                .build())
            .addonsConfig(ClusterAddonsConfigArgs.builder()
                .gkeBackupAgentConfig(ClusterAddonsConfigGkeBackupAgentConfigArgs.builder()
                    .enabled(true)
                    .build())
                .build())
            .build());
        var keyRing = new KeyRing("keyRing", KeyRingArgs.builder()
            .location("us-central1")
            .build());
        var cryptoKey = new CryptoKey("cryptoKey", CryptoKeyArgs.builder()
            .keyRing(keyRing.id())
            .build());
        var cmek = new BackupPlan("cmek", BackupPlanArgs.builder()
            .cluster(primary.id())
            .location("us-central1")
            .backupConfig(BackupPlanBackupConfigArgs.builder()
                .includeVolumeData(true)
                .includeSecrets(true)
                .selectedNamespaces(BackupPlanBackupConfigSelectedNamespacesArgs.builder()
                    .namespaces(
                        "default",
                        "test")
                    .build())
                .encryptionKey(BackupPlanBackupConfigEncryptionKeyArgs.builder()
                    .gcpKmsEncryptionKey(cryptoKey.id())
                    .build())
                .build())
            .build());
    }
}
Content copied to clipboard

Gkebackup Backupplan Full

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.container.Cluster;
import com.pulumi.gcp.container.ClusterArgs;
import com.pulumi.gcp.container.inputs.ClusterWorkloadIdentityConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigGkeBackupAgentConfigArgs;
import com.pulumi.gcp.gkebackup.BackupPlan;
import com.pulumi.gcp.gkebackup.BackupPlanArgs;
import com.pulumi.gcp.gkebackup.inputs.BackupPlanRetentionPolicyArgs;
import com.pulumi.gcp.gkebackup.inputs.BackupPlanBackupScheduleArgs;
import com.pulumi.gcp.gkebackup.inputs.BackupPlanBackupConfigArgs;
import com.pulumi.gcp.gkebackup.inputs.BackupPlanBackupConfigSelectedApplicationsArgs;
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 primary = new Cluster("primary", ClusterArgs.builder()
            .location("us-central1")
            .initialNodeCount(1)
            .workloadIdentityConfig(ClusterWorkloadIdentityConfigArgs.builder()
                .workloadPool("my-project-name.svc.id.goog")
                .build())
            .addonsConfig(ClusterAddonsConfigArgs.builder()
                .gkeBackupAgentConfig(ClusterAddonsConfigGkeBackupAgentConfigArgs.builder()
                    .enabled(true)
                    .build())
                .build())
            .build());
        var full = new BackupPlan("full", BackupPlanArgs.builder()
            .cluster(primary.id())
            .location("us-central1")
            .retentionPolicy(BackupPlanRetentionPolicyArgs.builder()
                .backupDeleteLockDays(30)
                .backupRetainDays(180)
                .build())
            .backupSchedule(BackupPlanBackupScheduleArgs.builder()
                .cronSchedule("0 9 * * 1")
                .build())
            .backupConfig(BackupPlanBackupConfigArgs.builder()
                .includeVolumeData(true)
                .includeSecrets(true)
                .selectedApplications(BackupPlanBackupConfigSelectedApplicationsArgs.builder()
                    .namespacedNames(
                        BackupPlanBackupConfigSelectedApplicationsNamespacedNameArgs.builder()
                            .name("app1")
                            .namespace("ns1")
                            .build(),
                        BackupPlanBackupConfigSelectedApplicationsNamespacedNameArgs.builder()
                            .name("app2")
                            .namespace("ns2")
                            .build())
                    .build())
                .build())
            .build());
    }
}
Content copied to clipboard

Import

BackupPlan can be imported using any of these accepted formats

$ pulumi import gcp:gkebackup/backupPlan:BackupPlan default projects/{{project}}/locations/{{location}}/backupPlans/{{name}}
Content copied to clipboard
$ pulumi import gcp:gkebackup/backupPlan:BackupPlan default {{project}}/{{location}}/{{name}}
Content copied to clipboard
$ pulumi import gcp:gkebackup/backupPlan:BackupPlan default {{location}}/{{name}}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(backupConfig: Output<BackupPlanBackupConfigArgs>? = null, backupSchedule: Output<BackupPlanBackupScheduleArgs>? = null, cluster: Output<String>? = null, deactivated: Output<Boolean>? = null, description: Output<String>? = null, labels: Output<Map<String, String>>? = null, location: Output<String>? = null, name: Output<String>? = null, project: Output<String>? = null, retentionPolicy: Output<BackupPlanRetentionPolicyArgs>? = null)

Properties

Link copied to clipboard
val backupConfig: Output<BackupPlanBackupConfigArgs>? = null

Defines the configuration of Backups created via this BackupPlan. Structure is documented below.

Link copied to clipboard
val backupSchedule: Output<BackupPlanBackupScheduleArgs>? = null

Defines a schedule for automatic Backup creation via this BackupPlan. Structure is documented below.

Link copied to clipboard
val cluster: Output<String>? = null

The source cluster from which Backups will be created via this BackupPlan.

Link copied to clipboard
val deactivated: Output<Boolean>? = null

This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups).

Link copied to clipboard
val description: Output<String>? = null

User specified descriptive string for this BackupPlan.

Link copied to clipboard
val labels: Output<Map<String, String>>? = null

Description: A set of custom labels supplied by the user. A list of key->value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Link copied to clipboard
val location: Output<String>? = null

The region of the Backup Plan.

Link copied to clipboard
val name: Output<String>? = null

The full name of the BackupPlan Resource.

Link copied to clipboard
val project: Output<String>? = null

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Link copied to clipboard
val retentionPolicy: Output<BackupPlanRetentionPolicyArgs>? = null

RetentionPolicy governs lifecycle of Backups created under this plan. Structure is documented below.

Functions

Link copied to clipboard
open override fun toJava(): BackupPlanArgs