com.pulumi.alicloud.hbr.OssBackupPlan Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of alicloud Show documentation
Show all versions of alicloud Show documentation
A Pulumi package for creating and managing AliCloud resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.alicloud.hbr;
import com.pulumi.alicloud.Utilities;
import com.pulumi.alicloud.hbr.OssBackupPlanArgs;
import com.pulumi.alicloud.hbr.inputs.OssBackupPlanState;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Provides a HBR Oss Backup Plan resource.
*
* For information about HBR Oss Backup Plan and how to use it, see [What is Oss Backup Plan](https://www.alibabacloud.com/help/doc-detail/130040.htm).
*
* > **NOTE:** Available since v1.131.0+.
*
* ## Example Usage
*
* Basic Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.random.integer;
* import com.pulumi.random.IntegerArgs;
* import com.pulumi.alicloud.hbr.Vault;
* import com.pulumi.alicloud.hbr.VaultArgs;
* import com.pulumi.alicloud.oss.Bucket;
* import com.pulumi.alicloud.oss.BucketArgs;
* import com.pulumi.alicloud.hbr.OssBackupPlan;
* import com.pulumi.alicloud.hbr.OssBackupPlanArgs;
* 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 default_ = new Integer("default", IntegerArgs.builder()
* .max(99999)
* .min(10000)
* .build());
*
* var defaultVault = new Vault("defaultVault", VaultArgs.builder()
* .vaultName(String.format("terraform-example-%s", default_.result()))
* .build());
*
* var defaultBucket = new Bucket("defaultBucket", BucketArgs.builder()
* .bucket(String.format("terraform-example-%s", default_.result()))
* .build());
*
* var defaultOssBackupPlan = new OssBackupPlan("defaultOssBackupPlan", OssBackupPlanArgs.builder()
* .ossBackupPlanName("terraform-example")
* .prefix("/example")
* .bucket(defaultBucket.bucket())
* .vaultId(defaultVault.id())
* .schedule("I|1602673264|PT2H")
* .backupType("COMPLETE")
* .retention("2")
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* HBR Oss Backup Plan can be imported using the id, e.g.
*
* ```sh
* $ pulumi import alicloud:hbr/ossBackupPlan:OssBackupPlan example <id>
* ```
*
*/
@ResourceType(type="alicloud:hbr/ossBackupPlan:OssBackupPlan")
public class OssBackupPlan extends com.pulumi.resources.CustomResource {
/**
* Backup type. Valid values: `COMPLETE`.
*
*/
@Export(name="backupType", refs={String.class}, tree="[0]")
private Output backupType;
/**
* @return Backup type. Valid values: `COMPLETE`.
*
*/
public Output backupType() {
return this.backupType;
}
/**
* The name of OSS bucket.
*
*/
@Export(name="bucket", refs={String.class}, tree="[0]")
private Output bucket;
/**
* @return The name of OSS bucket.
*
*/
public Output bucket() {
return this.bucket;
}
/**
* The role name created in the original account RAM backup by the cross account managed by the current account.
*
*/
@Export(name="crossAccountRoleName", refs={String.class}, tree="[0]")
private Output crossAccountRoleName;
/**
* @return The role name created in the original account RAM backup by the cross account managed by the current account.
*
*/
public Output> crossAccountRoleName() {
return Codegen.optional(this.crossAccountRoleName);
}
/**
* The type of the cross account backup. Valid values: `SELF_ACCOUNT`, `CROSS_ACCOUNT`.
*
*/
@Export(name="crossAccountType", refs={String.class}, tree="[0]")
private Output crossAccountType;
/**
* @return The type of the cross account backup. Valid values: `SELF_ACCOUNT`, `CROSS_ACCOUNT`.
*
*/
public Output crossAccountType() {
return this.crossAccountType;
}
/**
* The original account ID of the cross account backup managed by the current account.
*
*/
@Export(name="crossAccountUserId", refs={Integer.class}, tree="[0]")
private Output crossAccountUserId;
/**
* @return The original account ID of the cross account backup managed by the current account.
*
*/
public Output> crossAccountUserId() {
return Codegen.optional(this.crossAccountUserId);
}
/**
* Whether to disable the backup task. Valid values: `true`, `false`.
*
*/
@Export(name="disabled", refs={Boolean.class}, tree="[0]")
private Output disabled;
/**
* @return Whether to disable the backup task. Valid values: `true`, `false`.
*
*/
public Output disabled() {
return this.disabled;
}
/**
* The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
*
*/
@Export(name="ossBackupPlanName", refs={String.class}, tree="[0]")
private Output ossBackupPlanName;
/**
* @return The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
*
*/
public Output ossBackupPlanName() {
return this.ossBackupPlanName;
}
/**
* Backup prefix. Once specified, only objects with matching prefixes will be backed up.
*
*/
@Export(name="prefix", refs={String.class}, tree="[0]")
private Output prefix;
/**
* @return Backup prefix. Once specified, only objects with matching prefixes will be backed up.
*
*/
public Output> prefix() {
return Codegen.optional(this.prefix);
}
/**
* Backup retention days, the minimum is 1.
*
*/
@Export(name="retention", refs={String.class}, tree="[0]")
private Output retention;
/**
* @return Backup retention days, the minimum is 1.
*
*/
public Output retention() {
return this.retention;
}
/**
* Backup strategy. Optional format: `I|{startTime}|{interval}`. It means to execute a backup task every `{interval}` starting from `{startTime}`. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.
* * `startTime` Backup start time, UNIX time seconds.
*
*/
@Export(name="schedule", refs={String.class}, tree="[0]")
private Output schedule;
/**
* @return Backup strategy. Optional format: `I|{startTime}|{interval}`. It means to execute a backup task every `{interval}` starting from `{startTime}`. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.
* * `startTime` Backup start time, UNIX time seconds.
*
*/
public Output schedule() {
return this.schedule;
}
/**
* The ID of backup vault.
*
*/
@Export(name="vaultId", refs={String.class}, tree="[0]")
private Output vaultId;
/**
* @return The ID of backup vault.
*
*/
public Output vaultId() {
return this.vaultId;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public OssBackupPlan(String name) {
this(name, OssBackupPlanArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public OssBackupPlan(String name, OssBackupPlanArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public OssBackupPlan(String name, OssBackupPlanArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("alicloud:hbr/ossBackupPlan:OssBackupPlan", name, args == null ? OssBackupPlanArgs.Empty : args, makeResourceOptions(options, Codegen.empty()));
}
private OssBackupPlan(String name, Output id, @Nullable OssBackupPlanState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("alicloud:hbr/ossBackupPlan:OssBackupPlan", name, state, makeResourceOptions(options, id));
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static OssBackupPlan get(String name, Output id, @Nullable OssBackupPlanState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new OssBackupPlan(name, id, state, options);
}
}